ruby-trello-czuger 2.0.0

data/spec/list_spec.rb

@@ -0,0 +1,253 @@
+require 'spec_helper'
+
+module Trello
+  describe List do
+    include Helpers
+
+    let(:list) { client.find(:list, 'abcdef123456789123456789') }
+    let(:client) { Client.new }
+
+    before(:each) do
+      allow(client)
+        .to receive(:get)
+        .with('/lists/abcdef123456789123456789', {})
+        .and_return JSON.generate(lists_details.first)
+
+      allow(client)
+        .to receive(:get)
+        .with('/boards/abcdef123456789123456789', {})
+        .and_return JSON.generate(boards_details.first)
+    end
+
+    context 'finding' do
+      let(:client) { Trello.client }
+
+      it 'delegates to client#find' do
+        expect(client)
+          .to receive(:find)
+          .with(:list, 'abcdef123456789123456789', {})
+
+        List.find('abcdef123456789123456789')
+      end
+
+      it 'is equivalent to client#find' do
+        expect(List.find('abcdef123456789123456789')).to eq(list)
+      end
+    end
+
+    context 'creating' do
+      let(:client) { Trello.client }
+
+      it 'creates a new record' do
+        list = List.new(lists_details.first)
+        expect(list).to be_valid
+      end
+
+      it 'must not be valid if not given a name' do
+        list = List.new(lists_details.first.except('name'))
+        expect(list).to_not be_valid
+      end
+
+      it 'must not be valid if not given a list id' do
+        list = List.new(lists_details.first.except('id'))
+        expect(list).to_not be_valid
+      end
+
+      it 'initializes all fields from response-like formatted hash' do
+        list_details = lists_details.first
+        list = List.new(list_details)
+        expect(list.id).to             eq(list_details['id'])
+        expect(list.name).to           eq(list_details['name'])
+        expect(list.closed).to         eq(list_details['closed'])
+        expect(list.board_id).to       eq(list_details['idBoard'])
+        expect(list.pos).to            eq(list_details['pos'])
+        expect(list.source_list_id).to eq(list_details['idListSource'])
+      end
+
+      it 'initializes required fields from options-like formatted hash' do
+        list_details = lists_details[1]
+        list = List.new(list_details)
+        expect(list.name).to           eq list_details[:name]
+        expect(list.board_id).to       eq list_details[:board_id]
+        expect(list.pos).to            eq list_details[:pos]
+        expect(list.source_list_id).to eq list_details[:source_list_id]
+      end
+
+      it 'creates a new record and saves it on Trello', refactor: true do
+        payload = {
+          name: 'Test List',
+          board_id: 'abcdef123456789123456789',
+          pos: 42,
+          source_list_id: 'abcdef123456789'
+        }
+
+        result = JSON.generate(payload)
+
+        expected_payload = {
+          name: 'Test List',
+          closed: false,
+          idBoard: 'abcdef123456789123456789',
+          pos: 42,
+          idListSource: 'abcdef123456789'
+        }
+
+        expect(client)
+          .to receive(:post)
+          .with('/lists', expected_payload).and_return result
+
+        list = List.create(payload)
+        expect(list).to be_a List
+      end
+    end
+
+    context 'updating' do
+      it 'updating name does a put on the correct resource with the correct value' do
+        expected_new_name = 'xxx'
+
+        payload = {
+          name: expected_new_name,
+          closed: false,
+          pos: list.pos
+        }
+
+        expect(client)
+          .to receive(:put)
+          .once
+          .with('/lists/abcdef123456789123456789', payload)
+
+        list.name = expected_new_name
+        list.save
+      end
+
+      it 'updates position' do
+        new_position = 42
+        payload = {
+          name: list.name,
+          closed: list.closed,
+          pos: new_position
+        }
+
+        expect(client)
+          .to receive(:put)
+          .once
+          .with('/lists/abcdef123456789123456789', payload)
+
+        list.pos = new_position
+        list.save
+      end
+    end
+
+    context 'fields' do
+      it 'gets its id' do
+        expect(list.id).to eq lists_details.first['id']
+      end
+
+      it 'gets its name' do
+        expect(list.name).to eq lists_details.first['name']
+      end
+
+      it 'knows if it is open or closed' do
+        expect(list.closed).to eq lists_details.first['closed']
+      end
+
+      it 'has a board' do
+        expect(list.board).to eq Board.new(boards_details.first)
+      end
+
+      it 'gets its position' do
+        expect(list.pos).to eq lists_details.first['pos']
+      end
+    end
+
+    context 'actions' do
+      it 'has a list of actions' do
+        allow(client)
+          .to receive(:get)
+          .with('/lists/abcdef123456789123456789/actions', { filter: :all })
+          .and_return actions_payload
+
+        expect(list.actions.count).to be > 0
+      end
+    end
+
+    context 'cards' do
+      it 'has a list of cards' do
+        allow(client)
+          .to receive(:get)
+          .with('/lists/abcdef123456789123456789/cards', { filter: :open })
+          .and_return cards_payload
+
+        expect(list.cards.count).to be > 0
+      end
+
+      it 'moves cards to another list' do
+        other_list = List.new(lists_details.first.merge(id: 'otherListID', cards: []))
+
+        allow(client)
+          .to receive(:post)
+          .with('/lists/abcdef123456789123456789/moveAllCards', { idBoard: other_list.board_id, idList: other_list.id })
+          .and_return cards_payload
+
+        expect(list.move_all_cards(other_list)).to eq cards_payload
+      end
+
+      it 'archives all cards' do
+        allow(client)
+          .to receive(:post)
+          .with('/lists/abcdef123456789123456789/archiveAllCards')
+          .and_return cards_payload
+
+        expect(list.archive_all_cards).to eq cards_payload
+      end
+    end
+
+    describe '#closed?' do
+      it 'returns the closed attribute' do
+        expect(list).to_not be_closed
+      end
+    end
+
+    describe '#close' do
+      it 'updates the close attribute to true' do
+        list.close
+        expect(list).to be_closed
+      end
+    end
+
+    describe '#close!' do
+      it 'updates the close attribute to true and saves the list' do
+        expect(client)
+          .to receive(:put)
+          .once
+          .with('/lists/abcdef123456789123456789', {
+            name: list.name,
+            closed: true,
+            pos: list.pos
+          })
+
+        list.close!
+      end
+    end
+
+    describe "#update_fields" do
+      it "does not set any fields when the fields argument is empty" do
+        expected = {
+          'id' => 'id',
+          'name' => 'name',
+          'closed' => 'closed',
+          'idBoard' => 'board_id',
+          'pos' => 'pos',
+          'idListSource' => 'source_list_id'
+        }
+
+        label = List.new(expected)
+
+        label.update_fields({})
+
+        expected.each do |key, value|
+          expect(label.send(value)).to eq expected[key]
+        end
+      end
+    end
+  end
+end

data/spec/member_spec.rb

@@ -0,0 +1,159 @@
+# Specs covering the members namespace in the Trello API
+
+require 'spec_helper'
+
+module Trello
+  describe Member do
+    include Helpers
+
+    let(:member) { client.find(:member, 'abcdef123456789012345678') }
+    let(:client) { Client.new }
+
+    before do
+      allow(client)
+        .to receive(:get)
+        .with('/members/abcdef123456789012345678', {})
+        .and_return user_payload
+    end
+
+    context 'finding' do
+      let(:client) { Trello.client }
+
+      it 'delegates to Trello.client#find' do
+        expect(client)
+          .to receive(:find)
+          .with(:member, 'abcdef123456789012345678', {})
+
+        Member.find('abcdef123456789012345678')
+      end
+
+      it 'is equivalent to client#find' do
+        expect(Member.find('abcdef123456789012345678')).to eq(member)
+      end
+    end
+
+    describe 'attributes' do
+      before do
+        allow(client)
+          .to receive(:get)
+          .with("/members/abcdef123456789012345678/#{resource}", { filter: filter })
+          .and_return payload
+      end
+
+      describe 'actions' do
+        let(:resource) { 'actions' }
+        let(:filter)   { :all }
+        let(:payload)  { actions_payload }
+
+        it 'retrieves a list of actions' do
+          expect(member.actions.count).to be > 0
+        end
+      end
+
+      describe 'boards' do
+        let(:resource) { 'boards' }
+        let(:filter)   { :all }
+        let(:payload)  { boards_payload }
+
+        it { expect(member.boards.count).to be > 0 }
+      end
+
+      describe 'cards' do
+        let(:resource) { 'cards' }
+        let(:filter)   { :open }
+        let(:payload)  { cards_payload }
+
+        it { expect(member.cards.count).to be > 0 }
+      end
+
+      describe 'organizations' do
+        let(:resource) { 'organizations' }
+        let(:filter)   { :all }
+        let(:payload)  { orgs_payload }
+
+        it { expect(member.organizations.count).to be > 0 }
+      end
+    end
+
+    context 'notifications' do
+      it 'has a list of notifications' do
+        allow(client)
+          .to receive(:get)
+          .with('/members/abcdef123456789012345678/notifications', {})
+          .and_return '[' << notification_payload << ']'
+
+        expect(member.notifications.count).to eq 1
+      end
+    end
+
+    context 'personal' do
+      it 'gets the members bio' do
+        expect(member.bio).to eq user_details['bio']
+      end
+
+      it 'gets the full name' do
+        expect(member.full_name).to eq user_details['fullName']
+      end
+
+      it 'gets the avatar id' do
+        expect(member.avatar_id).to eq user_details['avatarHash']
+      end
+
+      it 'returns a valid url for the avatar' do
+        expect(member.avatar_url(size: :large)).to eq 'https://trello-avatars.s3.amazonaws.com/abcdef1234567890abcdef1234567890/170.png'
+        expect(member.avatar_url(size: :small)).to eq 'https://trello-avatars.s3.amazonaws.com/abcdef1234567890abcdef1234567890/30.png'
+      end
+
+      it 'gets the url' do
+        expect(member.url).to eq user_details['url']
+      end
+
+      it 'gets the username' do
+        expect(member.username).to eq user_details['username']
+      end
+
+      it 'gets the email' do
+        expect(member.email).to eq user_details['email']
+      end
+
+      it 'gets the initials' do
+        expect(member.initials).to eq user_details['initials']
+      end
+    end
+
+    context 'modification' do
+      it 'lets us know a field has changed without committing it' do
+        expect(member).to_not be_changed
+        member.bio = 'New and amazing'
+        expect(member).to be_changed
+      end
+
+      it 'does not understand the #id= method' do
+        expect { member.id = '42' }.to raise_error NoMethodError
+      end
+    end
+
+    describe "#update_fields" do
+      it "does not set any fields when the fields argument is empty" do
+        expected = {
+          'id' => 'id',
+          'fullName' => 'full_name',
+          'email' => 'email',
+          'username' => 'username',
+          'initials' => 'initials',
+          'avatarHash' => 'avatar_id',
+          'bio' => 'bio',
+          'url' => 'url'
+        }
+
+        member = Member.new(expected)
+
+        member.update_fields({})
+
+        expected.each do |key, value|
+          expect(member.send(value)).to eq expected[key]
+        end
+      end
+    end
+  end
+end

data/spec/notification_spec.rb

@@ -0,0 +1,143 @@
+require 'spec_helper'
+
+module Trello
+  describe Notification do
+    include Helpers
+
+    let(:notification) { member.notifications.first }
+    let(:member) { client.find(:member, "abcdef123456789012345678") }
+    let(:client) { Client.new }
+
+    before do
+      allow(client)
+        .to receive(:get)
+        .with("/members/abcdef123456789012345678", {})
+        .and_return user_payload
+
+      allow(client)
+        .to receive(:get)
+        .with("/members/abcdef123456789012345678/notifications", {})
+        .and_return("[" << notification_payload << "]")
+    end
+
+    context "finding" do
+      let(:client) { Trello.client }
+
+      it "can find a specific notification" do
+        allow(client)
+          .to receive(:get)
+          .with("/notifications/#{notification_details['id']}", {})
+          .and_return notification_payload
+
+        expect(Notification.find(notification_details['id'])).to eq notification
+      end
+    end
+
+    context "boards" do
+      it "can retrieve the board" do
+        allow(client)
+          .to receive(:get)
+          .with("/notifications/#{notification_details['id']}/board")
+          .and_return JSON.generate(boards_details.first)
+
+        expect(notification.board.id).to eq boards_details.first['id']
+      end
+    end
+
+    context "lists" do
+      it "can retrieve the list" do
+        allow(client)
+          .to receive(:get)
+          .with("/notifications/#{notification_details['id']}/list")
+          .and_return JSON.generate(lists_details.first)
+
+        expect(notification.list.id).to eq lists_details.first['id']
+      end
+    end
+
+    context "cards" do
+      it "can retrieve the card" do
+        allow(client)
+          .to receive(:get)
+          .with("/notifications/#{notification_details['id']}/card")
+          .and_return JSON.generate(cards_details.first)
+
+        expect(notification.card.id).to eq cards_details.first['id']
+      end
+    end
+
+    context "members" do
+      it "can retrieve the member" do
+        allow(client)
+          .to receive(:get)
+          .with("/notifications/#{notification_details['id']}/member")
+          .and_return user_payload
+
+        expect(notification.member.id).to eq user_details['id']
+      end
+
+      it "can retrieve the member creator" do
+        allow(client)
+          .to receive(:get)
+          .with("/members/#{user_details['id']}", {})
+          .and_return user_payload
+
+        expect(notification.member_creator.id).to eq user_details['id']
+      end
+    end
+
+    context "organization" do
+      it "can retrieve the organization" do
+        allow(client)
+          .to receive(:get)
+          .with("/notifications/#{notification_details['id']}/organization")
+          .and_return JSON.generate(orgs_details.first)
+
+        expect(notification.organization.id).to eq orgs_details.first['id']
+      end
+    end
+
+    context "local" do
+      it "gets the read status" do
+        expect(notification.unread?).to eq notification_details['unread']
+      end
+
+      it "gets the type" do
+        expect(notification.type).to eq notification_details['type']
+      end
+
+      it "gets the date" do
+        expect(notification.date).to eq notification_details['date']
+      end
+
+      it "gets the data" do
+        expect(notification.data).to eq notification_details['data']
+      end
+
+      it "gets the member creator id" do
+        expect(notification.member_creator_id).to eq notification_details['idMemberCreator']
+      end
+    end
+
+    describe "#update_fields" do
+      it "does not set any fields when the fields argument is empty" do
+        expected = {
+          'id' => 'id',
+          'unread' => 'unread',
+          'type' => 'type',
+          'date' => 'date',
+          'data' => 'data',
+          'idMemberCreator' => 'member_creator_id'
+        }
+
+        notification = Notification.new(expected)
+
+        notification.update_fields({})
+
+        expected.each do |key, value|
+          expect(notification.send(value)).to eq expected[key]
+        end
+      end
+    end
+  end
+end