ruby-trello-wgibbs 0.4.3

data/spec/integration/how_to_use_boards_spec.rb

@@ -0,0 +1,48 @@
+require 'spec_helper'
+require 'integration/integration_test'
+
+describe "how to use boards", :broken => true do
+  include IntegrationTest
+
+  context "given a valid access token" do
+    before :all do
+      OAuthPolicy.consumer_credential = OAuthCredential.new @developer_public_key, @developer_secret
+      OAuthPolicy.token = OAuthCredential.new @access_token_key, @access_token_secret
+      Container.set Trello::Authorization, "AuthPolicy", OAuthPolicy
+    end
+
+    after do
+      if @new_board and false == @new_board.closed? 
+        @new_board.update_fields 'closed' => true
+        @new_board.save
+      end
+    end
+
+    it "can add a board" do
+      @new_board = Board.create(:name => "An example")
+      @new_board.should_not be_nil
+      @new_board.id.should_not be_nil
+      @new_board.name.should == "An example"
+      @new_board.should_not be_closed
+    end
+
+    it "can read the welcome board" do
+      welcome_board = Board.find @welcome_board
+      welcome_board.name.should === "Welcome Board"
+      welcome_board.id.should === @welcome_board
+    end
+
+    it "can close a board" do
+      @new_board = Board.create(:name => "[#{Time.now}, CLOSED] An example")
+
+      @new_board.update_fields 'closed' => true
+      @new_board.save
+      
+      Board.find(@new_board.id).should be_closed
+    end
+
+    it "can list all boards" do
+      Client.get("/members/me/boards/").json_into(Board).should be_an Array
+    end
+  end
+end

data/spec/integration/integration_test.rb

@@ -0,0 +1,40 @@
+module IntegrationTest
+  include Trello
+  include Trello::Authorization
+
+  class Container
+    class << self
+      def set(parent, name, value)
+        parent.send :remove_const, name
+        parent.const_set name, value
+      end
+    end
+  end
+
+  def self.included(klass)
+    klass.class_eval do
+      before :all do
+        # Getting developer/member key
+        # 1. https://trello.com/1/appKey/generate
+        # 2. https://trello.com/1/connect?key=<public_key_here>&name=RubyTrelloIntegrationTests&response_type=token
+        # See: https://trello.com/board/trello-public-api/4ed7e27fe6abb2517a21383d
+
+        @developer_public_key = ENV["DEVELOPER_PUBLIC_KEY"]
+        @developer_secret     = ENV["DEVELOPER_SECRET"]
+        @member_token         = ENV["MEMBER_TOKEN"]
+        @welcome_board        = ENV["WELCOME_BOARD"]
+        @access_token_key     = ENV["ACCESS_TOKEN_KEY"]
+        @access_token_secret  = ENV["ACCESS_TOKEN_SECRET"]
+        
+        WebMock.disable!
+      end    
+    end
+  end
+
+  protected
+
+  def get(uri)
+    require "rest_client"
+    RestClient.get uri.to_s
+  end
+end

data/spec/item_spec.rb

@@ -0,0 +1,27 @@
+require 'spec_helper'
+
+module Trello
+  describe Item do
+    before(:all) do
+      @detail = {
+        'id'   => "abcdef123456789123456789",
+        'name' => "test item",
+        'type' => "check"
+      }
+
+      @item = Item.new(@detail)
+    end
+
+    it "gets its id" do
+      @item.id.should == @detail['id']
+    end
+
+    it "gets its name" do
+      @item.name.should == @detail['name']
+    end
+
+    it "knows its type" do
+      @item.type.should == @detail['type']
+    end
+  end
+end

data/spec/list_spec.rb

@@ -0,0 +1,50 @@
+require 'spec_helper'
+
+module Trello
+  describe List do
+    include Helpers
+
+    before(:each) do
+      Client.stub(:get).with("/lists/abcdef123456789123456789").and_return JSON.generate(lists_details.first)
+      Client.stub(:get).with("/boards/abcdef123456789123456789").and_return JSON.generate(boards_details.first)
+
+      @list = List.find("abcdef123456789123456789")
+    end
+
+    context "fields" do
+      it "gets its id" do
+        @list.id.should == lists_details.first['id']
+      end
+
+      it "gets its name" do
+        @list.name.should == lists_details.first['name']
+      end
+
+      it "knows if it is open or closed" do
+        @list.closed.should == lists_details.first['closed']
+      end
+
+      it "has a board" do
+        @list.board.should == Board.new(boards_details.first)
+      end
+    end
+
+    context "actions" do
+      it "has a list of actions" do
+        Client.stub(:get).with("/lists/abcdef123456789123456789/actions", { :filter => :all }).and_return actions_payload
+        @list.actions.count.should be > 0
+      end
+    end
+
+    context "cards" do
+      it "has a list of cards" do
+        Client.stub(:get).with("/lists/abcdef123456789123456789/cards", { :filter => :open }).and_return cards_payload
+        @list.cards.count.should be > 0
+      end
+    end
+
+    it "is not closed" do
+      @list.closed?.should_not be_true
+    end
+  end
+end

data/spec/member_spec.rb

@@ -0,0 +1,92 @@
+# Specs covering the members namespace in the Trello API
+
+require 'spec_helper'
+
+module Trello
+  describe Member do
+    include Helpers
+
+    before(:each) do
+      Client.stub(:get).with("/members/abcdef123456789012345678").and_return user_payload
+
+      @member = Member.find('abcdef123456789012345678')
+    end
+
+    context "actions" do
+      it "retrieves a list of actions", :refactor => true do
+        Client.stub(:get).with("/members/abcdef123456789012345678/actions", { :filter => :all }).and_return actions_payload
+        @member.actions.count.should be > 0
+      end
+    end
+
+    context "boards" do
+      it "has a list of boards" do
+        Client.stub(:get).with("/members/abcdef123456789012345678/boards", { :filter => :all }).and_return boards_payload
+        boards = @member.boards
+        boards.count.should be > 0
+      end
+    end
+
+    context "cards" do
+      it "has a list of cards" do
+        Client.stub(:get).with("/members/abcdef123456789012345678/cards", { :filter => :open }).and_return cards_payload
+        cards = @member.cards
+        cards.count.should be > 0
+      end
+    end
+
+    context "organizations" do
+      it "has a list of organizations" do
+        Client.stub(:get).with("/members/abcdef123456789012345678/organizations", { :filter => :all }).and_return orgs_payload
+        orgs = @member.organizations
+        orgs.count.should be > 0
+      end
+    end
+
+    context "notifications" do
+      it "has a list of notifications" do
+        Client.stub(:get).with("/members/abcdef123456789012345678/notifications", {}).and_return "[" << notification_payload << "]"
+        @member.notifications.count.should be 1
+      end
+    end
+
+    context "personal" do
+      it "gets the members bio" do
+        @member.bio.should == user_details['bio']
+      end
+
+      it "gets the full name" do
+        @member.full_name.should == user_details['fullName']
+      end
+
+      it "gets the avatar id" do
+        @member.avatar_id.should == user_details['avatarHash']
+      end
+
+      it "returns a valid url for the avatar" do
+        @member.avatar_url(:size => :large).should == "https://trello-avatars.s3.amazonaws.com/abcdef1234567890abcdef1234567890/170.png"
+        @member.avatar_url(:size => :small).should == "https://trello-avatars.s3.amazonaws.com/abcdef1234567890abcdef1234567890/30.png"
+      end
+
+      it "gets the url" do
+        @member.url.should == user_details['url']
+      end
+
+      it "gets the username" do
+        @member.username.should == user_details['username']
+      end
+    end
+
+    context "modification" do
+      it "lets us know a field has changed without committing it" do
+        @member.changed?.should be_false
+        @member.bio = "New and amazing"
+        @member.changed?.should be_true
+      end
+
+      it "doesn't understand the #id= method" do
+        lambda { @member.id = "42" }.should raise_error NoMethodError
+      end
+    end
+  end
+end

data/spec/notification_spec.rb

@@ -0,0 +1,83 @@
+require 'spec_helper'
+
+module Trello
+  describe Notification do
+    include Helpers
+
+    before(:each) do
+      Client.stub(:get).with("/members/abcdef123456789012345678").and_return user_payload
+      member = Member.find("abcdef123456789012345678")
+      Client.stub(:get).with("/members/abcdef123456789012345678/notifications", {}).and_return "[" << notification_payload << "]"
+      @notification = member.notifications.first
+    end
+
+    context "finding" do
+      it "can find a specific notification" do
+        Client.stub(:get).with("/notifications/#{notification_details['id']}").and_return notification_payload
+        Notification.find(notification_details['id']).should == @notification
+      end
+    end
+
+    context "boards" do
+      it "can retrieve the board" do
+        Client.stub(:get).with("/notifications/#{notification_details['id']}/board").and_return JSON.generate(boards_details.first)
+        @notification.board.id.should == boards_details.first['id']
+      end
+    end
+
+    context "lists" do
+      it "can retrieve the list" do
+        Client.stub(:get).with("/notifications/#{notification_details['id']}/list").and_return JSON.generate(lists_details.first)
+        @notification.list.id.should == lists_details.first['id']
+      end
+    end
+
+    context "cards" do
+      it "can retrieve the card" do
+        Client.stub(:get).with("/notifications/#{notification_details['id']}/card").and_return JSON.generate(cards_details.first)
+        @notification.card.id.should == cards_details.first['id']
+      end
+    end
+
+    context "members" do
+      it "can retrieve the member" do
+        Client.stub(:get).with("/notifications/#{notification_details['id']}/member").and_return user_payload
+        @notification.member.id.should == user_details['id']
+      end
+
+      it "can retrieve the member creator" do
+        Client.stub(:get).with("/members/#{user_details['id']}").and_return user_payload
+        @notification.member_creator.id.should == user_details['id']
+      end
+    end
+
+    context "organization" do
+      it "can retrieve the organization" do
+        Client.stub(:get).with("/notifications/#{notification_details['id']}/organization").and_return JSON.generate(orgs_details.first)
+        @notification.organization.id.should == orgs_details.first['id']
+      end
+    end
+
+    context "local" do
+      it "gets the read status" do
+        @notification.unread?.should == notification_details['unread']
+      end
+
+      it "gets the type" do
+        @notification.type.should == notification_details['type']
+      end
+
+      it "gets the date" do
+        @notification.date.should == notification_details['date']
+      end
+
+      it "gets the data" do
+        @notification.data.should == notification_details['data']
+      end
+
+      it "gets the member creator id" do
+        @notification.member_creator_id.should == notification_details['idMemberCreator']
+      end
+    end
+  end
+end

data/spec/oauth_policy_spec.rb

@@ -0,0 +1,93 @@
+require "spec_helper"
+
+include Trello::Authorization
+include Trello
+
+describe OAuthPolicy do
+  before do
+    OAuthPolicy.consumer_credential = OAuthCredential.new "xxx", "xxx"
+    OAuthPolicy.token = nil
+  end
+
+  context "2-legged" do
+    it "adds an authorization header" do 
+      uri = Addressable::URI.parse("https://xxx/")
+
+      request = Request.new :get, uri
+
+      OAuthPolicy.token               = OAuthCredential.new "token", nil
+
+      authorized_request = OAuthPolicy.authorize request
+      
+      authorized_request.headers.keys.should include "Authorization"
+    end
+    
+    it "preserves query parameters" do
+      uri = Addressable::URI.parse("https://xxx/?name=Riccardo")
+      request = Request.new :get, uri
+
+      Clock.stub(:timestamp).and_return "1327048592"
+      Nonce.stub(:next).and_return "b94ff2bf7f0a5e87a326064ae1dbb18f"
+      OAuthPolicy.consumer_credential = OAuthCredential.new "consumer_key", "consumer_secret"
+      OAuthPolicy.token               = OAuthCredential.new "token", nil
+
+      authorized_request = OAuthPolicy.authorize request
+      
+      the_query_parameters = Addressable::URI.parse(authorized_request.uri).query_values
+      the_query_parameters.should == {"name" => "Riccardo"}
+    end
+
+    it "adds the correct signature as part of authorization header" do 
+      Clock.stub(:timestamp).and_return "1327048592"
+      Nonce.stub(:next).and_return "b94ff2bf7f0a5e87a326064ae1dbb18f"
+
+      OAuthPolicy.consumer_credential = OAuthCredential.new "consumer_key", "consumer_secret"
+      OAuthPolicy.token               = OAuthCredential.new "token", nil
+
+      request = Request.new :get, Addressable::URI.parse("http://xxx/")
+
+      authorized_request = OAuthPolicy.authorize request
+      
+      authorized_request.headers["Authorization"].should =~ /oauth_signature="kLcSxrCTd4ATHcLmTp8q%2Foa%2BFMA%3D"/
+    end
+
+    it "adds correct signature for uri with parameters" do
+      Clock.stub(:timestamp).and_return "1327351010"
+      Nonce.stub(:next).and_return "f5474aaf44ca84df0b09870044f91c69"
+
+      OAuthPolicy.consumer_credential = OAuthCredential.new "consumer_key", "consumer_secret"
+      OAuthPolicy.token               = OAuthCredential.new "token", nil
+
+      request = Request.new :get, Addressable::URI.parse("http://xxx/?a=b")
+
+      authorized_request = OAuthPolicy.authorize request
+      
+      authorized_request.headers["Authorization"].should =~ /oauth_signature="xm%2FJ1swxxPb6mnuR1Q1ucJMdGRk%3D"/
+    end
+
+    it "fails if consumer_credential is unset" do
+      OAuthPolicy.consumer_credential = nil
+
+      request = Request.new :get, Addressable::URI.parse("http://xxx/")
+
+      lambda{OAuthPolicy.authorize request}.should raise_error "The consumer_credential has not been supplied."
+    end
+
+    it "can sign with token" do
+      Clock.stub(:timestamp).and_return "1327360530"
+      Nonce.stub(:next).and_return "4f610cb28e7aa8711558de5234af1f0e"
+
+      OAuthPolicy.consumer_credential = OAuthCredential.new "consumer_key", "consumer_secret"
+      OAuthPolicy.token  = OAuthCredential.new "token_key", "token_secret"
+
+      request = Request.new :get, Addressable::URI.parse("http://xxx/")
+
+      authorized_request = OAuthPolicy.authorize request
+
+      authorized_request.headers["Authorization"].should =~ /oauth_signature="3JeZSzsLCYnGNdVALZMgbzQKN44%3D"/
+    end
+
+    it "adds correct signature for https uri"
+    it "adds correct signature for verbs other than get"
+  end
+end

data/spec/organization_spec.rb

@@ -0,0 +1,26 @@
+
+require 'spec_helper'
+
+module Trello
+  describe Organization do
+    include Helpers
+
+    before(:each) do
+      Client.stub(:get).with("/organizations/4ee7e59ae582acdec8000291").
+        and_return organization_payload
+
+      @organization = Organization.find('4ee7e59ae582acdec8000291')
+    end
+
+    context "actions" do
+      it "retrieves actions" do
+        Client.stub(:get).with("/organizations/4ee7e59ae582acdec8000291/actions", { :filter => :all }).and_return actions_payload
+        @organization.actions.count.should be > 0
+      end
+
+    end
+
+  end
+
+end
+