trello-client 0.0.3 → 0.0.4

data/History.rdoc

@@ -1,5 +1,10 @@
 = Trello::Client History
 
+== 2012-04-02 v0.0.4
+
+* Added Trello::Client#list()
+* Added Trello::Client::Card
+
 == 2012-03-30 v0.0.3
 
 * Added Trello::Client#board()

data/README.rdoc

@@ -46,7 +46,6 @@ Get user token:
 
     # Get board with lists
     client.board( '<identifier>', :lists => 'all' ) do |b|
-      # Returns Trello::Client::Board object
       b.lists.each do |l|
         # Returns Trello::Client::List object
         l['id']       # => list identifier
@@ -54,6 +53,26 @@ Get user token:
         l['name']     # => list name
       end
     end
+
+    # Get list
+    client.list( '<identifier>' ) do |l|
+      # Returns Trello::Client::List object
+      l['id']       # => list identifier
+      l['idBoard']  # => list board identifier
+      l['name']     # => list name
+    end
+
+    # Get list with cards
+    client.list( '<identifier>' ) do |l|
+      l.cards.each do |c|
+        # Returns Trello::Client::Card object
+        c['id']       # => card identifier
+        c['idBoard']  # => card board identifier
+        c['idList']   # => card list identifier
+        c['name']     # => card name
+      end
+    end
+
   end
 
 == Author
@@ -70,10 +89,8 @@ https://github.com/blairc/trello-client/
 
 == To Do
 
-* Trello::Client#list()
-* Get cards
 * Memoize API calls
 * Add script
-* DRY +Board+, +List+ and +Member+
+* DRY +Card+, +Board+, +List+ and +Member+
 * Lazy fetching of data that wasn't requested?
 

data/Rakefile

@@ -34,8 +34,10 @@ task :update_test_data do
     client.api_token  = ENV['TRELLO_API_TOKEN']
 
     {
-      'board'               => [ :board, '4f4f9d55cf2e679318098c5b' ],
-      'board_with_lists'    => [ :board, '4f4f9d55cf2e679318098c5b',  :lists => 'all' ],
+      'board'               => [ :board,  '4f4f9d55cf2e679318098c5b' ],
+      'board_with_lists'    => [ :board,  '4f4f9d55cf2e679318098c5b', :lists => 'all' ],
+      'list'                => [ :list,   '4f4f9d55cf2e679318098c53' ],
+      'list_with_cards'     => [ :list,   '4f4f9d55cf2e679318098c53', :cards => 'all' ],
       'member'              => [ :member, 'me' ],
       'member_with_boards'  => [ :member, 'me', :boards => 'all' ]
     }.each_pair do |file, request|

data/lib/trello-client.rb

@@ -5,6 +5,7 @@ require 'open-uri'
 require 'uri'
 
 require 'trello-client/board'
+require 'trello-client/card'
 require 'trello-client/list'
 require 'trello-client/member'
 require 'trello-client/version'
@@ -58,7 +59,6 @@ require 'trello-client/version'
 #
 #     # Get board with lists
 #     client.board( '<identifier>', :lists => 'all' ) do |b|
-#       # Returns Trello::Client::Board object
 #       b.lists.each do |l|
 #         # Returns Trello::Client::List object
 #         l['id']       # => list identifier
@@ -66,6 +66,26 @@ require 'trello-client/version'
 #         l['name']     # => list name
 #       end
 #     end
+#
+#     # Get list
+#     client.list( '<identifier>' ) do |l|
+#       # Returns Trello::Client::List object
+#       l['id']       # => list identifier
+#       l['idBoard']  # => list board identifier
+#       l['name']     # => list name
+#     end
+#
+#     # Get list with cards
+#     client.list( '<identifier>' ) do |l|
+#       l.cards.each do |c|
+#         # Returns Trello::Client::Card object
+#         c['id']       # => card identifier
+#         c['idBoard']  # => card board identifier
+#         c['idList']   # => card list identifier
+#         c['name']     # => card name
+#       end
+#     end
+#
 #   end
 #
 # == Author
@@ -82,11 +102,9 @@ require 'trello-client/version'
 #
 # == To Do
 #
-# * Trello::Client#list()
-# * Get cards
 # * Memoize API calls
 # * Add script
-# * DRY +Board+, +List+ and +Member+
+# * DRY +Card+, +Board+, +List+ and +Member+
 # * Lazy fetching of data that wasn't requested?
 #
 module Trello   # :nodoc:
@@ -136,6 +154,21 @@ module Trello   # :nodoc:
       Trello::Client::Board.new( _get( "#{api}/board/#{id}", options ) )
     end
 
+    #
+    # Get Trello::Client::List object
+    # 
+    # See https://trello.com/docs/api/list/index.html
+    #
+    # Params:
+    # +id+:: List identifier
+    # +options+:: (optional) Additional API parameters
+    #
+    def list(id, options = {} )
+      raise('invalid id') if id.nil? || id.empty?
+      Trello::Client::Member.new( _get( "#{api}/list/#{id}", options ) )
+    end
+
+
     #
     # Get Trello::Client::Member object
     # 

data/lib/trello-client/card.rb

@@ -0,0 +1,36 @@
+# encoding: utf-8
+
+module Trello   # :nodoc:
+  class Client  # :nodoc:
+
+    #
+    # Trello::Client::Card object
+    #
+    # See https://trello.com/docs/api/card/index.html
+    #
+    class Card
+
+      #
+      # Initialize Trello::Client::Card
+      #
+      # Params:
+      # +card+:: Hash'ified JSON card or JSON string
+      #
+      def initialize(card)
+        @card = card.kind_of?(Hash) ? card : MultiJson.decode(card)
+        yield self if block_given?
+        self
+      end
+
+      #
+      # Get Trello::Client::Card property
+      #
+      def[](key)
+        @card[key]
+      end
+
+    end # class Card
+
+  end # class Client
+end   # module Trello
+

data/lib/trello-client/list.rb

@@ -30,14 +30,13 @@ module Trello   # :nodoc:
       end
 
       #
-      # TODO Get +Array+ of cards
+      # Get +Array+ of Trello::Client::Card objects
       #
       def cards
-        #unless @lists
-        #  @lists = ( @list['lists'] || []  ).collect { |l| Trello::Client::List.new(l) }
-        #end
-        #@lists
-        @list['cards'] || []
+        unless @lists
+          @cards = ( @list['cards'] || []  ).collect { |c| Trello::Client::Card.new(c) }
+        end
+        @cards
       end
 
     end # class List

data/lib/trello-client/version.rb

@@ -5,6 +5,6 @@ module Trello
     #
     # Trello::Client version
     #
-    VERSION = '0.0.3'
+    VERSION = '0.0.4'
   end
 end

data/test/data/list.json

@@ -0,0 +1 @@
+{"id":"4f4f9d55cf2e679318098c53","name":"Basics","closed":false,"idBoard":"4f4f9d55cf2e679318098c5b","pos":16384}

data/test/data/list_with_cards.json

@@ -0,0 +1 @@
+{"id":"4f4f9d55cf2e679318098c53","name":"Basics","closed":false,"idBoard":"4f4f9d55cf2e679318098c5b","pos":16384,"cards":[{"id":"4f4f9d56cf2e679318098ca3","name":"Welcome to Trello!","desc":"","closed":false,"idShort":1,"idList":"4f4f9d55cf2e679318098c53","idBoard":"4f4f9d55cf2e679318098c5b","idMembers":[],"url":"https://trello.com/card/welcome-to-trello/4f4f9d55cf2e679318098c5b/1","attachments":[],"labels":[],"badges":{"votes":0,"viewingMemberVoted":false,"due":null,"description":false,"attachments":0,"comments":0,"checkItemsChecked":0,"checkItems":0,"fogbugz":""},"pos":65536,"idChecklists":[],"checkItemStates":[]},{"id":"4f4f9d55cf2e679318098c7f","name":"This is a card.","desc":"People can vote on cards.","closed":false,"idShort":2,"idList":"4f4f9d55cf2e679318098c53","idBoard":"4f4f9d55cf2e679318098c5b","idMembers":[],"url":"https://trello.com/card/this-is-a-card/4f4f9d55cf2e679318098c5b/2","attachments":[],"labels":[],"badges":{"votes":1,"viewingMemberVoted":false,"due":null,"description":true,"attachments":0,"comments":0,"checkItemsChecked":0,"checkItems":0,"fogbugz":""},"pos":131072,"idChecklists":[],"checkItemStates":[]},{"id":"4f4f9d56cf2e679318098ca6","name":"Click on a card to see what's behind it.","desc":"You can put a detailed description here...","closed":false,"idShort":3,"idList":"4f4f9d55cf2e679318098c53","idBoard":"4f4f9d55cf2e679318098c5b","idMembers":[],"url":"https://trello.com/card/click-on-a-card-to-see-what-s-behind-it/4f4f9d55cf2e679318098c5b/3","attachments":[],"labels":[],"badges":{"votes":0,"viewingMemberVoted":false,"due":null,"description":true,"attachments":0,"comments":1,"checkItemsChecked":0,"checkItems":0,"fogbugz":""},"pos":196608,"idChecklists":[],"checkItemStates":[]},{"id":"4f4f9d56cf2e679318098cab","name":"You can attach pictures and files...","desc":"This is Taco, the most famous Siberian Husky in New York City.","closed":false,"idShort":4,"idList":"4f4f9d55cf2e679318098c53","idBoard":"4f4f9d55cf2e679318098c5b","idMembers":[],"url":"https://trello.com/card/you-can-attach-pictures-and-files/4f4f9d55cf2e679318098c5b/4","attachments":[{"_id":"4f4f9d56cf2e679318098caa","bytes":52566,"date":"2011-09-09T21:11:21.104Z","url":"https://trello-attachments.s3.amazonaws.com/4e6a8095efa69909ba007382/4e6a80e8efa69909ba007596/stnx5HjpZNWPO3ex/6-9-2010_10-33-30_AM.png","name":"6-9-2010_10-33-30_AM.png","idMember":"4e6a7fad05d98b02ba00845c"}],"labels":[],"badges":{"votes":0,"viewingMemberVoted":false,"due":null,"description":true,"attachments":1,"comments":0,"checkItemsChecked":0,"checkItems":0,"fogbugz":""},"pos":262144,"idChecklists":[],"checkItemStates":[]},{"id":"4f4f9d56cf2e679318098c9d","name":"... any kind of hyperlink ...","desc":"","closed":false,"idShort":5,"idList":"4f4f9d55cf2e679318098c53","idBoard":"4f4f9d55cf2e679318098c5b","idMembers":[],"url":"https://trello.com/card/any-kind-of-hyperlink/4f4f9d55cf2e679318098c5b/5","attachments":[],"labels":[],"badges":{"votes":0,"viewingMemberVoted":false,"due":null,"description":false,"attachments":0,"comments":1,"checkItemsChecked":0,"checkItems":0,"fogbugz":""},"pos":327680,"idChecklists":[],"checkItemStates":[]},{"id":"4f4f9d56cf2e679318098cb1","name":"... or checklists.","desc":"","closed":false,"idShort":6,"idList":"4f4f9d55cf2e679318098c53","idBoard":"4f4f9d55cf2e679318098c5b","idMembers":[],"url":"https://trello.com/card/or-checklists/4f4f9d55cf2e679318098c5b/6","attachments":[],"labels":[],"badges":{"votes":0,"viewingMemberVoted":false,"due":null,"description":false,"attachments":0,"comments":0,"checkItemsChecked":1,"checkItems":3,"fogbugz":""},"pos":393216,"idChecklists":["4f4f9d55cf2e679318098c59"],"checkItemStates":[{"_id":"4f4f9d56cf2e679318098cb0","idCheckItem":"4f4f9d55cf2e679318098c56","state":"complete"}]}]}

data/test/test_client.rb

@@ -110,6 +110,69 @@ class TestClient < Test::Unit::TestCase
     end
   end
 
+  def test_list_parameter_validation
+    Trello::Client.new do |client|
+      assert_raise(RuntimeError, 'invalid id') { client.list(nil) }
+      assert_raise(RuntimeError, 'invalid id') { client.list('')  }
+
+      assert_nil    client.api_key
+      assert_raise(RuntimeError, 'invalid API key') { client.list('me') }
+      client.api_key = ''
+      assert_equal  '', client.api_key
+      assert_raise(RuntimeError, 'invalid API key') { client.list('me') }
+      client.api_key = @api_key
+      assert_equal  @api_key, client.api_key  
+
+      assert_nil    client.api_token
+      assert_raise(RuntimeError, 'invalid API token') { client.list('me') }
+      client.api_token = ''
+      assert_equal  '', client.api_token
+      assert_raise(RuntimeError, 'invalid API token') { client.list('me') }
+    end
+  end
+
+  def test_list
+    Trello::Client.new do |client|
+      json  = open( File.join( @test_data, 'list.json' ) ).read
+      l     = Trello::Client::List.new(json)
+      client.stubs(:list).with('id').returns(l)
+
+      assert_not_nil  l
+      assert_kind_of  Trello::Client::List, l
+
+      assert_equal  '4f4f9d55cf2e679318098c53', l['id']
+      assert_equal   'Basics',                  l['name']
+      assert_equal  false,                      l['closed']
+      assert_equal  '4f4f9d55cf2e679318098c5b', l['idBoard']
+      assert_equal  16384,                      l['pos']
+
+      assert_not_nil  l.cards
+      assert_kind_of  Array,    l.cards
+      assert_equal    0,        l.cards.size
+    end
+  end
+
+  def test_list_with_boards
+    Trello::Client.new do |client|
+      json  = open( File.join( @test_data, 'list_with_cards.json' ) ).read
+      l     = Trello::Client::List.new(json)
+      client.stubs(:list).with('id').returns(l)
+
+      assert_not_nil  l
+      assert_kind_of  Trello::Client::List, l
+
+      assert_equal  '4f4f9d55cf2e679318098c53', l['id']
+      assert_equal   'Basics',                  l['name']
+      assert_equal  false,                      l['closed']
+      assert_equal  '4f4f9d55cf2e679318098c5b', l['idBoard']
+      assert_equal  16384,                      l['pos']
+
+      assert_not_nil  l.cards
+      assert_kind_of  Array,    l.cards
+      assert_equal    6,        l.cards.size
+    end
+  end
+
   def test_member_parameter_validation
     Trello::Client.new do |client|
       assert_raise(RuntimeError, 'invalid id') { client.member(nil) }

data/test/test_list.rb

@@ -0,0 +1,71 @@
+# encoding: utf-8
+
+require 'simplecov'
+SimpleCov.start
+
+require 'fakeweb'
+require 'trello-client'
+require 'test/unit'
+
+
+class TestList < Test::Unit::TestCase
+
+  def setup
+    @test_dir   = File.dirname(__FILE__)
+    @test_data  = File.join( @test_dir, 'data' )
+  end
+
+  def test_cards
+    Trello::Client.new do |client|
+      json  = open( File.join( @test_data, 'list_with_cards.json' ) ).read
+      l     = Trello::Client::List.new(json)
+
+      assert_not_nil  l
+      assert_kind_of  Trello::Client::List, l
+
+      assert_not_nil  l.cards
+      assert_kind_of  Array,    l.cards
+      assert_equal    6,        l.cards.size
+
+      first = l.cards.first
+      assert_not_nil  first
+      assert_kind_of  Trello::Client::Card,                                                   first
+      assert_equal    [],                                                                     first['attachments'] 
+      assert_kind_of  Hash,                                                                   first['badges']
+      assert_equal    [],                                                                     first['checkItemStates'] 
+      assert_equal    false,                                                                  first['closed']
+      assert_equal    '',                                                                     first['desc']
+      assert_equal    '4f4f9d56cf2e679318098ca3',                                             first['id']
+      assert_equal    '4f4f9d55cf2e679318098c5b',                                             first['idBoard']
+      assert_equal    [],                                                                     first['idChecklists'] 
+      assert_equal    '4f4f9d55cf2e679318098c53',                                             first['idList']
+      assert_equal    [],                                                                     first['idMembers']
+      assert_equal    1,                                                                      first['idShort']
+      assert_equal    [],                                                                     first['labels'] 
+      assert_equal    'Welcome to Trello!',                                                   first['name']
+      assert_equal    65536,                                                                  first['pos']
+      assert_equal    'https://trello.com/card/welcome-to-trello/4f4f9d55cf2e679318098c5b/1', first['url']
+
+      last = l.cards.last
+      assert_not_nil  last
+      assert_kind_of  Trello::Client::Card,                                               last
+      assert_equal    [],                                                                 last['attachments'] 
+      assert_kind_of  Hash,                                                               last['badges']
+      assert_kind_of  Array,                                                              last['checkItemStates']
+      assert_equal    false,                                                              last['closed']
+      assert_equal    '',                                                                 last['desc']
+      assert_equal    '4f4f9d56cf2e679318098cb1',                                         last['id']
+      assert_equal    '4f4f9d55cf2e679318098c5b',                                         last['idBoard']
+      assert_equal    [ '4f4f9d55cf2e679318098c59' ],                                     last['idChecklists'] 
+      assert_equal    '4f4f9d55cf2e679318098c53',                                         last['idList']
+      assert_equal    [],                                                                 last['idMembers']
+      assert_equal    6,                                                                  last['idShort']
+      assert_equal    [],                                                                 last['labels'] 
+      assert_equal    '... or checklists.',                                               last['name']
+      assert_equal    393216,                                                             last['pos']
+      assert_equal    'https://trello.com/card/or-checklists/4f4f9d55cf2e679318098c5b/6', last['url']
+    end
+  end
+
+end
+

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: trello-client
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.0.4
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-03-30 00:00:00.000000000 Z
+date: 2012-04-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: multi_json
-  requirement: &70229863256380 !ruby/object:Gem::Requirement
+  requirement: &70339636455920 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70229863256380
+  version_requirements: *70339636455920
 - !ruby/object:Gem::Dependency
   name: fakeweb
-  requirement: &70229863255500 !ruby/object:Gem::Requirement
+  requirement: &70339636455100 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,10 +32,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70229863255500
+  version_requirements: *70339636455100
 - !ruby/object:Gem::Dependency
   name: mocha
-  requirement: &70229863254720 !ruby/object:Gem::Requirement
+  requirement: &70339636474840 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -43,10 +43,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70229863254720
+  version_requirements: *70339636474840
 - !ruby/object:Gem::Dependency
   name: rake
-  requirement: &70229863254000 !ruby/object:Gem::Requirement
+  requirement: &70339636473960 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -54,10 +54,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70229863254000
+  version_requirements: *70339636473960
 - !ruby/object:Gem::Dependency
   name: rdoc
-  requirement: &70229863274220 !ruby/object:Gem::Requirement
+  requirement: &70339636473020 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -65,10 +65,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70229863274220
+  version_requirements: *70339636473020
 - !ruby/object:Gem::Dependency
   name: rdoc-readme
-  requirement: &70229863273480 !ruby/object:Gem::Requirement
+  requirement: &70339636472320 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -76,10 +76,10 @@ dependencies:
         version: 0.1.2
   type: :development
   prerelease: false
-  version_requirements: *70229863273480
+  version_requirements: *70339636472320
 - !ruby/object:Gem::Dependency
   name: simplecov
-  requirement: &70229863272780 !ruby/object:Gem::Requirement
+  requirement: &70339636471580 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -87,7 +87,7 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70229863272780
+  version_requirements: *70339636471580
 description: Trello API client
 email:
 - blair.christensen@gmail.com
@@ -103,15 +103,19 @@ files:
 - Rakefile
 - lib/trello-client.rb
 - lib/trello-client/board.rb
+- lib/trello-client/card.rb
 - lib/trello-client/list.rb
 - lib/trello-client/member.rb
 - lib/trello-client/version.rb
 - test/data/board.json
 - test/data/board_with_lists.json
+- test/data/list.json
+- test/data/list_with_cards.json
 - test/data/member.json
 - test/data/member_with_boards.json
 - test/test_board.rb
 - test/test_client.rb
+- test/test_list.rb
 - test/test_member.rb
 - trello-client.gemspec
 homepage: https://github.com/blairc/trello-client/
@@ -128,7 +132,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -1725830249849533101
+      hash: -2574410681571816951
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -137,7 +141,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -1725830249849533101
+      hash: -2574410681571816951
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.11
@@ -147,8 +151,11 @@ summary: Trello API client
 test_files:
 - test/data/board.json
 - test/data/board_with_lists.json
+- test/data/list.json
+- test/data/list_with_cards.json
 - test/data/member.json
 - test/data/member_with_boards.json
 - test/test_board.rb
 - test/test_client.rb
+- test/test_list.rb
 - test/test_member.rb