uservoice-ruby 0.0.5 → 0.0.6

data/lib/uservoice/client.rb

@@ -0,0 +1,132 @@
+module UserVoice
+  class Client
+
+    def initialize(*args)
+      case args.size
+      when 3,4
+        init_subdomain_and_api_keys(*args)
+      when 1,2
+        init_consumer_and_access_token(*args)
+      end
+    end
+
+    def init_subdomain_and_api_keys(subdomain_name, api_key, api_secret, attrs={})
+      consumer = OAuth::Consumer.new(api_key, api_secret, { 
+        :site => "#{attrs[:protocol] || 'https'}://#{subdomain_name}.#{attrs[:uservoice_domain] || 'uservoice.com'}"
+      })
+      init_consumer_and_access_token(consumer, attrs)
+    end
+
+    def init_consumer_and_access_token(consumer, attrs={})
+      @consumer = consumer
+      @token = OAuth::AccessToken.new(@consumer, attrs[:oauth_token] || '', attrs[:oauth_token_secret] || '')
+      @response_format = attrs[:response_format] || :hash
+      @callback = attrs[:callback]
+    end
+
+    def authorize_url
+      request_token.authorize_url
+    end
+
+    def login_with_verifier(oauth_verifier)
+      raise Unauthorized.new('Call request token first') if @request_token.nil?
+      token = @request_token.get_access_token(:oauth_verifier => oauth_verifier)
+      Client.new(@consumer, :oauth_token => token.token, :oauth_token_secret => token.secret)
+    end
+
+    def login_with_access_token(oauth_token, oauth_token_secret, &block)
+      token = Client.new(@consumer, :oauth_token => oauth_token, :oauth_token_secret => oauth_token_secret)
+      if block_given?
+        yield token
+      else
+        return token
+      end
+    end
+
+    def token
+      @token.token
+    end
+
+    def secret
+      @token.secret
+    end
+
+    def request_token
+      @request_token = @consumer.get_request_token(:oauth_callback => @callback)
+    end
+
+    def login_as_owner(&block)
+      token = post('/api/v1/users/login_as_owner.json', {
+        'request_token' => request_token.token
+      })['token']
+      if token
+        login_with_access_token(token['oauth_token'], token['oauth_token_secret'], &block)
+      else
+        raise Unauthorized.new("Could not get Access Token")
+      end
+    end
+
+    def login_as(email, &block)
+      unless email.to_s.match(EMAIL_FORMAT)
+        raise Unauthorized.new("'#{email}' is not a valid email address")
+      end
+      token = post('/api/v1/users/login_as.json', {
+        :user => { :email => email },
+        :request_token => request_token.token
+      })['token']
+
+      if token
+        login_with_access_token(token['oauth_token'], token['oauth_token_secret'], &block)
+      else
+        raise Unauthorized.new("Could not get Access Token")
+      end
+    end
+
+    def request(method, uri, request_body={}, headers={})
+      headers = DEFAULT_HEADERS.merge(headers)
+
+      if headers['Content-Type'] == 'application/json' && request_body.is_a?(Hash)
+        request_body = request_body.to_json
+      end
+
+      response = case method.to_sym
+                 when :post, :put
+                   @token.request(method, uri, request_body, headers)
+                 when :head, :delete, :get
+                   @token.request(method, uri, headers)
+                 else
+                   raise RuntimeError.new("Invalid HTTP method #{method}")
+                 end
+
+      return case @response_format.to_s
+             when 'raw'
+               response
+             else
+               attrs = JSON.parse(response.body)
+               if attrs && attrs['errors']
+                 case attrs['errors']['type']
+                 when 'unauthorized'
+                   raise Unauthorized.new(attrs)
+                 when 'record_not_found'
+                   raise NotFound.new(attrs)
+                 when 'application_error'
+                   raise ApplicationError.new(attrs)
+                 else
+                   raise APIError.new(attrs)
+                 end
+               end
+               attrs
+             end
+    end
+
+    %w(get post delete put).each do |method|
+      define_method(method) do |*args|
+        request(method, *args)
+      end
+    end
+
+    def get_collection(uri, opts={})
+      UserVoice::Collection.new(self, uri, opts)
+    end
+  end
+end

data/lib/uservoice/collection.rb

@@ -0,0 +1,63 @@
+module UserVoice
+  class Collection
+    def initialize(client, query, opts={})
+      @client = client
+      @query = query
+      @limit = opts[:limit] || 2**60
+      @per_page = [@limit, 500].min
+      @pages = {}
+    end
+
+    def first
+      load_record(0)
+    end
+
+    def last
+      load_record(size() - 1)
+    end
+
+    def size
+      if @response_data.nil?
+        load_record(0)
+      end
+      @response_data['total_records']
+    end
+
+    def map
+      index = 0
+      records = []
+      while record = load_record(index)
+        records.push(yield record)
+        index += 1
+      end
+      return records
+    end
+    alias collect map
+
+    def each
+      map do |value|
+        yield value
+        value
+      end
+    end
+        
+    private
+
+    def load_record(i)
+      load_page((i/500.0).floor + 1)[i%500]
+    end
+
+    def load_page(i)
+      if @pages[i].nil?
+        result = @client.get("#{@query}#{@query.include?('?') ? '&' : '?'}per_page=#{@per_page}&page=#{i}")
+
+        if @response_data = result.delete('response_data')
+          @pages[i] = result.shift.last if result.first
+        else
+          raise UserVoice::NotFound.new('The resource you requested is not a collection')
+        end
+      end
+      return @pages[i]
+    end
+  end
+end

data/lib/uservoice/user_voice.rb

@@ -1,4 +1,6 @@
 require "uservoice/version"
+require 'uservoice/collection'
+require 'uservoice/client'
 require 'rubygems'
 require 'ezcrypto'
 require 'json'
@@ -31,131 +33,4 @@ module UserVoice
 
     return CGI.escape(encoded)
   end
-
-  class Client
-
-    def initialize(*args)
-      case args.size
-      when 3,4
-        init_subdomain_and_api_keys(*args)
-      when 1,2
-        init_consumer_and_access_token(*args)
-      end
-    end
-
-    def init_subdomain_and_api_keys(subdomain_name, api_key, api_secret, attrs={})
-      consumer = OAuth::Consumer.new(api_key, api_secret, { 
-        :site => "#{attrs[:protocol] || 'https'}://#{subdomain_name}.#{attrs[:uservoice_domain] || 'uservoice.com'}"
-      })
-      init_consumer_and_access_token(consumer, attrs)
-    end
-
-    def init_consumer_and_access_token(consumer, attrs={})
-      @consumer = consumer
-      @token = OAuth::AccessToken.new(@consumer, attrs[:oauth_token] || '', attrs[:oauth_token_secret] || '')
-      @response_format = attrs[:response_format] || :hash
-      @callback = attrs[:callback]
-    end
-
-    def authorize_url
-      request_token.authorize_url
-    end
-
-    def login_with_verifier(oauth_verifier)
-      raise Unauthorized.new('Call request token first') if @request_token.nil?
-      token = @request_token.get_access_token(:oauth_verifier => oauth_verifier)
-      Client.new(@consumer, :oauth_token => token.token, :oauth_token_secret => token.secret)
-    end
-
-    def login_with_access_token(oauth_token, oauth_token_secret, &block)
-      token = Client.new(@consumer, :oauth_token => oauth_token, :oauth_token_secret => oauth_token_secret)
-      if block_given?
-        yield token
-      else
-        return token
-      end
-    end
-
-    def token
-      @token.token
-    end
-
-    def secret
-      @token.secret
-    end
-
-    def request_token
-      @request_token = @consumer.get_request_token(:oauth_callback => @callback)
-    end
-
-    def login_as_owner(&block)
-      token = post('/api/v1/users/login_as_owner.json', {
-        'request_token' => request_token.token
-      })['token']
-      if token
-        login_with_access_token(token['oauth_token'], token['oauth_token_secret'], &block)
-      else
-        raise Unauthorized.new("Could not get Access Token")
-      end
-    end
-
-    def login_as(email, &block)
-      unless email.to_s.match(EMAIL_FORMAT)
-        raise Unauthorized.new("'#{email}' is not a valid email address")
-      end
-      token = post('/api/v1/users/login_as.json', {
-        :user => { :email => email },
-        :request_token => request_token.token
-      })['token']
-
-      if token
-        login_with_access_token(token['oauth_token'], token['oauth_token_secret'], &block)
-      else
-        raise Unauthorized.new("Could not get Access Token")
-      end
-    end
-
-    def request(method, uri, request_body={}, headers={})
-      headers = DEFAULT_HEADERS.merge(headers)
-
-      if headers['Content-Type'] == 'application/json' && request_body.is_a?(Hash)
-        request_body = request_body.to_json
-      end
-
-      response = case method.to_sym
-                 when :post, :put
-                   @token.request(method, uri, request_body, headers)
-                 when :head, :delete, :get
-                   @token.request(method, uri, headers)
-                 else
-                   raise RuntimeError.new("Invalid HTTP method #{method}")
-                 end
-
-      return case @response_format.to_s
-             when 'raw'
-               response
-             else
-               attrs = JSON.parse(response.body)
-               if attrs && attrs['errors']
-                 case attrs['errors']['type']
-                 when 'unauthorized'
-                   raise Unauthorized.new(attrs)
-                 when 'record_not_found'
-                   raise NotFound.new(attrs)
-                 when 'application_error'
-                   raise ApplicationError.new(attrs)
-                 else
-                   raise APIError.new(attrs)
-                 end
-               end
-               attrs
-             end
-    end
-
-    %w(get post delete put).each do |method|
-      define_method(method) do |*args|
-        request(method, *args)
-      end
-    end
-  end
 end

data/lib/uservoice/version.rb

@@ -1,3 +1,3 @@
 module Uservoice
-  VERSION = "0.0.5"
+  VERSION = "0.0.6"
 end

data/spec/lib/user_voice_spec.rb

@@ -12,175 +12,4 @@ describe UserVoice do
     key = EzCrypto::Key.with_password(config['subdomain_name'], config['sso_key'])
     key.decrypt(encrypted_raw_data).should match('mailaddress@example.com')
   end
-
-  describe UserVoice::Client do
-    subject { UserVoice::Client.new(config['subdomain_name'],
-                                    config['api_key'],
-                                    config['api_secret'],
-                                   :uservoice_domain => config['uservoice_domain'],
-                                   :protocol => config['protocol']) }
-
-    it "should get user names from the API" do
-      users = subject.get("/api/v1/users.json?per_page=3")
-      user_names = users['users'].map { |user| user['name'] }
-      user_names.all?.should == true
-      user_names.size.should == 3
-    end
-
-    it "should not get current user without logged in user" do
-      lambda do
-        user = subject.get("/api/v1/users/current.json")
-      end.should raise_error(UserVoice::Unauthorized)
-    end
-
-    it "should be able to get access token as owner" do
-      subject.login_as_owner do |owner|
-        owner.get("/api/v1/users/current.json")['user']['roles']['owner'].should == true
-
-        owner.login_as('regular@example.com') do |regular|
-          owner.get("/api/v1/users/current.json")['user']['roles']['owner'].should == true
-          @user = regular.get("/api/v1/users/current.json")['user']
-          @user['roles']['owner'].should == false
-        end
-
-        owner.get("/api/v1/users/current.json")['user']['roles']['owner'].should == true
-      end
-      # ensure blocks got run
-      @user['email'].should == 'regular@example.com'
-    end
-
-    it "should not be able to create KB article as nobody" do
-      lambda do
-        result = subject.post("/api/v1/articles.json", :article => {
-          :title => 'good morning'
-        })
-      end.should raise_error(UserVoice::Unauthorized)
-    end
-
-    it "should be able to create and delete a forum as the owner" do
-      owner = subject.login_as_owner
-      forum = owner.post("/api/v1/forums.json", :forum => {
-        :name => 'Test forum from RSpec',
-        'private' => true,
-        'allow_by_email_domain' => true,
-        'allowed_email_domains' => [{'domain' => 'raimo.rspec.example.com'}]
-      })['forum']
-
-      forum['id'].should be_a(Integer)
-
-      deleted_forum = owner.delete("/api/v1/forums/#{forum['id']}.json")['forum']
-      deleted_forum['id'].should == forum['id']
-    end
-
-    it "should get current user with 2-legged call" do
-      user = subject.login_as('mailaddress@example.com') do |token|
-        token.get("/api/v1/users/current.json")['user']
-      end
-
-      user['email'].should == 'mailaddress@example.com'
-    end
-
-    it "should get current user with copied access token" do
-      original_token = subject.login_as('mailaddress@example.com')
-
-      client = UserVoice::Client.new(config['subdomain_name'],
-                                   config['api_key'],
-                                   config['api_secret'],
-                                  :uservoice_domain => config['uservoice_domain'],
-                                  :protocol => config['protocol'],
-                                  :oauth_token => original_token.token,
-                                  :oauth_token_secret => original_token.secret)
-      # Also this works but creates an extra object:
-      # client = client.login_with_access_token(original_token.token, original_token.secret)
-
-      user = client.get("/api/v1/users/current.json")['user']
-
-      user['email'].should == 'mailaddress@example.com'
-    end
-
-    it "should login as an owner" do
-      me = subject.login_as_owner
-
-      owner = me.get("/api/v1/users/current.json")['user']
-      owner['roles']['owner'].should == true
-    end
-
-    it "should not be able to delete when not deleting on behalf of anyone" do
-      lambda {
-        result = subject.delete("/api/v1/users/#{234}.json")
-      }.should raise_error(UserVoice::Unauthorized, /user required/i)
-    end
-
-    it "should not be able to delete owner" do
-      owner_access_token = subject.login_as_owner
-
-      owner = owner_access_token.get("/api/v1/users/current.json")['user']
-
-      lambda {
-        result = owner_access_token.delete("/api/v1/users/#{owner['id']}.json")
-      }.should raise_error(UserVoice::Unauthorized, /last owner/i)
-    end
-
-    it "should not be able to delete user without login" do
-      regular_user = subject.login_as('somebodythere@example.com').get("/api/v1/users/current.json")['user']
-
-      lambda {
-        subject.delete("/api/v1/users/#{regular_user['id']}.json")
-      }.should raise_error(UserVoice::Unauthorized)
-    end
-
-    it "should be able to identify suggestions" do
-      owner_token = subject.login_as_owner
-      external_scope='sync_to_moon'
-      suggestions = owner_token.get("/api/v1/suggestions.json?filter=with_external_id&external_scope=#{external_scope}&manual_action=#{external_scope}")['suggestions']
-
-      identifications = suggestions.map {|s| { :id => s['id'], :external_id => s['id'].to_i*10 } }
-
-      ids = owner_token.put("/api/v1/suggestions/identify.json",
-                          :external_scope => external_scope,
-                          :identifications => identifications)['identifications']['ids']
-      ids.should == identifications.map { |s| s[:id] }.sort
-    end
-
-    it "should be able to delete itself" do
-      my_token = subject.login_as('somebodythere@example.com')
-
-      # whoami
-      my_id = my_token.get("/api/v1/users/current.json")['user']['id']
-
-      # Delete myself!
-      my_token.delete("/api/v1/users/#{my_id}.json")['user']['id'].should == my_id
-
-      # I don't exist anymore
-      lambda {
-        my_token.get("/api/v1/users/current.json")
-      }.should raise_error(UserVoice::NotFound)
-    end
-
-    it "should/be able to delete random user and login as him after that" do
-      somebody = subject.login_as('somebodythere@example.com')
-      owner = subject.login_as_owner
-
-      # somebody is still there...
-      regular_user = somebody.get("/api/v1/users/current.json")['user']
-      regular_user['email'].should == 'somebodythere@example.com'
-
-      # delete somebody!
-      owner.delete("/api/v1/users/#{regular_user['id']}.json")['user']['id'].should == regular_user['id']
-
-      # not found anymore!
-      lambda {
-        somebody.get("/api/v1/users/current.json")['errors']['type']
-      }.should raise_error(UserVoice::NotFound)
-
-      # this recreates somebody
-      somebody = subject.login_as('somebodythere@example.com')
-      somebody.get("/api/v1/users/current.json")['user']['id'].should_not == regular_user['id']
-    end
-
-    it "should raise error with invalid email parameter" do
-      expect { subject.login_as('ma') }.to raise_error(UserVoice::Unauthorized)
-      expect { subject.login_as(nil) }.to raise_error(UserVoice::Unauthorized)
-    end
-  end
 end

data/spec/lib/uservoice/client_spec.rb

@@ -0,0 +1,202 @@
+require 'spec_helper'
+describe UserVoice::Client do
+  subject { UserVoice::Client.new(config['subdomain_name'],
+                                  config['api_key'],
+                                  config['api_secret'],
+                                 :uservoice_domain => config['uservoice_domain'],
+                                 :protocol => config['protocol']) }
+  let(:external_scope) { 'external_system_name' }
+
+  it "should get user names from the API" do
+    users = subject.get("/api/v1/users.json?per_page=3")
+    user_names = users['users'].map { |user| user['name'] }
+    user_names.all?.should == true
+    user_names.size.should == 3
+  end
+
+  it "should not get current user without logged in user" do
+    lambda do
+      user = subject.get("/api/v1/users/current.json")
+    end.should raise_error(UserVoice::Unauthorized)
+  end
+
+  it "should be able to get access token as owner" do
+    subject.login_as_owner do |owner|
+      owner.get("/api/v1/users/current.json")['user']['roles']['owner'].should == true
+
+      owner.login_as('regular@example.com') do |regular|
+        owner.get("/api/v1/users/current.json")['user']['roles']['owner'].should == true
+        @user = regular.get("/api/v1/users/current.json")['user']
+        @user['roles']['owner'].should == false
+      end
+
+      owner.get("/api/v1/users/current.json")['user']['roles']['owner'].should == true
+    end
+    # ensure blocks got run
+    @user['email'].should == 'regular@example.com'
+  end
+
+  it "should not be able to create KB article as nobody" do
+    lambda do
+      result = subject.post("/api/v1/articles.json", :article => {
+        :title => 'good morning'
+      })
+    end.should raise_error(UserVoice::Unauthorized)
+  end
+
+  it "should be able to create and delete a forum as the owner" do
+    owner = subject.login_as_owner
+    forum = owner.post("/api/v1/forums.json", :forum => {
+      :name => 'Test forum from RSpec',
+      'private' => true,
+      'allow_by_email_domain' => true,
+      'allowed_email_domains' => [{'domain' => 'raimo.rspec.example.com'}]
+    })['forum']
+
+    forum['id'].should be_a(Integer)
+
+    deleted_forum = owner.delete("/api/v1/forums/#{forum['id']}.json")['forum']
+    deleted_forum['id'].should == forum['id']
+  end
+
+  it "should get current user with 2-legged call" do
+    user = subject.login_as('mailaddress@example.com') do |token|
+      token.get("/api/v1/users/current.json")['user']
+    end
+
+    user['email'].should == 'mailaddress@example.com'
+  end
+
+  it "should get current user with copied access token" do
+    original_token = subject.login_as('mailaddress@example.com')
+
+    client = UserVoice::Client.new(config['subdomain_name'],
+                                 config['api_key'],
+                                 config['api_secret'],
+                                :uservoice_domain => config['uservoice_domain'],
+                                :protocol => config['protocol'],
+                                :oauth_token => original_token.token,
+                                :oauth_token_secret => original_token.secret)
+    # Also this works but creates an extra object:
+    # client = client.login_with_access_token(original_token.token, original_token.secret)
+
+    user = client.get("/api/v1/users/current.json")['user']
+
+    user['email'].should == 'mailaddress@example.com'
+  end
+
+  it "should login as an owner" do
+    me = subject.login_as_owner
+
+    owner = me.get("/api/v1/users/current.json")['user']
+    owner['roles']['owner'].should == true
+  end
+
+  it "should not be able to delete when not deleting on behalf of anyone" do
+    lambda {
+      result = subject.delete("/api/v1/users/#{234}.json")
+    }.should raise_error(UserVoice::Unauthorized, /user required/i)
+  end
+
+  it "should not be able to delete owner" do
+    owner_access_token = subject.login_as_owner
+
+    owner = owner_access_token.get("/api/v1/users/current.json")['user']
+
+    lambda {
+      result = owner_access_token.delete("/api/v1/users/#{owner['id']}.json")
+    }.should raise_error(UserVoice::Unauthorized, /last owner/i)
+  end
+
+  it "should not be able to delete user without login" do
+    regular_user = subject.login_as('somebodythere@example.com').get("/api/v1/users/current.json")['user']
+
+    lambda {
+      subject.delete("/api/v1/users/#{regular_user['id']}.json")
+    }.should raise_error(UserVoice::Unauthorized)
+  end
+
+  it 'should get all suggestions using a collection enumerator' do
+    subject.should_receive(:get).once.and_return({
+      "response_data"=>{"page"=>1, "per_page"=>10, "total_records"=>1, "filter"=>"all", "sort"=>"votes"},
+      "suggestions"=>[ {
+            "url"=>"http://uservoice-subdomain.uservoice.com/forums/1-a/suggestions/1-i",
+            "id"=>1,
+            "state"=>"published",
+            "title"=>"a",
+            "text"=>"b",
+            "formatted_text"=>"b",
+            "forum"=>{"id"=>"1", "name"=>"General"}
+          }
+      ]})
+    suggestions = subject.get_collection("/api/v1/suggestions.json")
+    count = 0
+    suggestions.each do |suggestion|
+      count += 1
+    end
+    count.should == suggestions.size
+    count.should == 1
+  end
+
+  it "should get an error when trying to query suggestions with an unexistant manual action" do
+    lambda {
+      subject.login_as_owner do |owner_token|
+        owner_token.get("/api/v1/suggestions.json?filter=with_external_id&external_scope=#{external_scope}&manual_action=#{external_scope}")['suggestions']
+      end
+    }.should raise_error(UserVoice::NotFound)
+  end
+
+  it "should identify a suggestion" do
+    owner_token = subject.login_as_owner
+
+    suggestions = owner_token.get("/api/v1/suggestions.json?filter=without_external_id&external_scope=#{external_scope}&per_page=1")['suggestions']
+    identifications = suggestions.map {|s| { :id => s['id'], :external_id => s['id'].to_i*10, :url => 'http://url.example.com' } }
+
+    ids = owner_token.put("/api/v1/suggestions/identify.json",
+                          :upsert => true,
+                          :external_scope => external_scope,
+                          :identifications => identifications)['identifications']['ids']
+    ids.should == identifications.map { |s| s[:id] }.sort
+  end
+
+  it "should be able to delete itself" do
+    my_token = subject.login_as('somebodythere@example.com')
+
+    # whoami
+    my_id = my_token.get("/api/v1/users/current.json")['user']['id']
+
+    # Delete myself!
+    my_token.delete("/api/v1/users/#{my_id}.json")['user']['id'].should == my_id
+
+    # I don't exist anymore
+    lambda {
+      my_token.get("/api/v1/users/current.json")
+    }.should raise_error(UserVoice::NotFound)
+  end
+
+  it "should/be able to delete random user and login as him after that" do
+    somebody = subject.login_as('somebodythere@example.com')
+    owner = subject.login_as_owner
+
+    # somebody is still there...
+    regular_user = somebody.get("/api/v1/users/current.json")['user']
+    regular_user['email'].should == 'somebodythere@example.com'
+
+    # delete somebody!
+    owner.delete("/api/v1/users/#{regular_user['id']}.json")['user']['id'].should == regular_user['id']
+
+    # not found anymore!
+    lambda {
+      somebody.get("/api/v1/users/current.json")['errors']['type']
+    }.should raise_error(UserVoice::NotFound)
+
+    # this recreates somebody
+    somebody = subject.login_as('somebodythere@example.com')
+    somebody.get("/api/v1/users/current.json")['user']['id'].should_not == regular_user['id']
+  end
+
+  it "should raise error with invalid email parameter" do
+    expect { subject.login_as('ma') }.to raise_error(UserVoice::Unauthorized)
+    expect { subject.login_as(nil) }.to raise_error(UserVoice::Unauthorized)
+  end
+end

data/spec/lib/uservoice/collection_spec.rb

@@ -0,0 +1,126 @@
+require 'spec_helper'
+
+describe UserVoice::Collection do
+  PER_PAGE = 500
+  ELEMENTS = 1501 # 4 pages, one record in the last page
+
+  context 'having an empty result set' do
+    let(:client) do
+      client = mock(
+        :get => {"response_data"=>{"page"=>1, "per_page"=>10, "total_records"=>0, "filter"=>"all", "sort"=>"votes"}, "suggestions"=>[]}
+      )
+    end
+    before do
+      @collection = UserVoice::Collection.new(client, '/api/v1/suggestions')
+    end
+
+    it "should return size of zero" do
+      @collection.size.should == 0
+    end
+
+    it 'should have zero entries with #each' do
+      @collection.each do |suggestion|
+        raise RuntimeError.new('should be empty')
+      end
+    end
+  end
+
+  context 'having a list with one element' do
+    before do
+      @client = mock(
+        :get => {"response_data"=>{"page"=>1, "per_page"=>10, "total_records"=>1, "filter"=>"all", "sort"=>"votes"}, "suggestions"=>[ {
+            "url"=>"http://uservoice-subdomain.uservoice.com/forums/1-general/suggestions/1-idea",
+            "id"=>1,
+            "state"=>"published",
+            "title"=>"a",
+            "text"=>"b",
+            "formatted_text"=>"b",
+            "forum"=>{"id"=>"1", "name"=>"General"}
+          }
+      ]})
+      @collection = UserVoice::Collection.new(@client, '/api/v1/suggestions')
+    end
+
+    it 'should have correct size' do
+      @collection.size.should == 1
+    end
+
+    it 'should yield correct records ids' do
+      ids = []
+      @collection.each do |val|
+        ids.push(val['id'])
+      end
+      ids.should == [1]
+    end
+
+    it 'should map ids' do
+      @collection.map do |val|
+        val['id']
+      end.should == [1]
+    end
+
+    it 'should collect ids' do
+      @client.should_receive(:get).with("/api/v1/suggestions?per_page=#{PER_PAGE}&page=1").once
+
+      @collection.collect do |val|
+        val['id']
+      end.should == [1]
+
+      @collection.map do |val|
+        val['id']
+      end.should == [1]
+    end
+  end
+
+  context 'having a list with 1501 elements' do
+
+    before do
+      @client = mock()
+      
+      4.times.map do |page_index|
+        @client.stub(:get).with("/api/v1/suggestions?per_page=#{PER_PAGE}&page=#{page_index+1}") do
+          {
+            "response_data" => {"page"=> page_index+1, "per_page" => PER_PAGE, "total_records" => ELEMENTS, "filter"=>"all", "sort"=>"votes"},
+            "suggestions"=> (PER_PAGE * page_index + 1).upto([PER_PAGE * (page_index + 1), ELEMENTS].min).map do |idea_index| 
+              {
+                "url"=>"http://uservoice-subdomain.uservoice.com/forums/1-general/suggestions/#{idea_index}-idea",
+                "id"=> idea_index,
+                "state"=>"published",
+                "title"=>"Idea ##{idea_index}",
+                "text"=>"Idea ##{idea_index}",
+                "formatted_text"=>"Idea ##{idea_index}",
+                "forum"=>{"id"=>"1", "name"=>"General"}
+              }
+            end
+          }
+        end
+      end
+      @collection = UserVoice::Collection.new(@client, '/api/v1/suggestions')
+    end
+
+    it 'should have correct size' do
+      @client.should_receive(:get).with("/api/v1/suggestions?per_page=#{PER_PAGE}&page=1").once
+      @collection.size.should == ELEMENTS
+    end
+
+    it 'should get last element and array size with two api calls' do
+      @collection.last['id'].should == ELEMENTS
+      @collection.first['id'].should == 1
+    end
+
+    it 'should yield correct records ids' do
+      ids = []
+      @collection.each do |val|
+        ids.push(val['id'])
+      end
+      ids.size.should == ELEMENTS
+      ids.should == 1.upto(ELEMENTS).to_a
+    end
+
+    it 'should map ids' do
+      @collection.map do |val|
+        val['id']
+      end.should == 1.upto(ELEMENTS).to_a
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: uservoice-ruby
 version: !ruby/object:Gem::Version
-  version: 0.0.5
+  version: 0.0.6
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-09-25 00:00:00.000000000 Z
+date: 2012-10-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &70266109840080 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,15 @@ dependencies:
         version: 1.0.5
   type: :development
   prerelease: false
-  version_requirements: *70266109840080
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 1.0.5
 - !ruby/object:Gem::Dependency
   name: ezcrypto
-  requirement: &70266109839480 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,10 +37,15 @@ dependencies:
         version: 0.7.2
   type: :runtime
   prerelease: false
-  version_requirements: *70266109839480
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 0.7.2
 - !ruby/object:Gem::Dependency
   name: json
-  requirement: &70266109838900 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -43,10 +53,15 @@ dependencies:
         version: 1.7.5
   type: :runtime
   prerelease: false
-  version_requirements: *70266109838900
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 1.7.5
 - !ruby/object:Gem::Dependency
   name: oauth
-  requirement: &70266109838340 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -54,7 +69,12 @@ dependencies:
         version: 0.4.7
   type: :runtime
   prerelease: false
-  version_requirements: *70266109838340
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 0.4.7
 description: The gem provides Ruby-bindings to UserVoice API and helps generating
   Single-Sign-On tokens.
 email:
@@ -68,10 +88,14 @@ files:
 - README.md
 - Rakefile
 - lib/uservoice-ruby.rb
+- lib/uservoice/client.rb
+- lib/uservoice/collection.rb
 - lib/uservoice/user_voice.rb
 - lib/uservoice/version.rb
 - spec/config.yml.templ
 - spec/lib/user_voice_spec.rb
+- spec/lib/uservoice/client_spec.rb
+- spec/lib/uservoice/collection_spec.rb
 - spec/spec_helper.rb
 - uservoice-ruby.gemspec
 homepage: http://developer.uservoice.com
@@ -94,11 +118,13 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: uservoice-ruby
-rubygems_version: 1.8.15
+rubygems_version: 1.8.23
 signing_key: 
 specification_version: 3
 summary: Client library for UserVoice API
 test_files:
 - spec/config.yml.templ
 - spec/lib/user_voice_spec.rb
+- spec/lib/uservoice/client_spec.rb
+- spec/lib/uservoice/collection_spec.rb
 - spec/spec_helper.rb