trello-client 0.0.1 → 0.0.2

data/History.rdoc

@@ -1,5 +1,9 @@
 = Trello::Client History
 
+== 2012-03-29 v0.0.2
+
+* Added Trello::Client::Board
+
 == 2012-03-28 v0.0.1
 
 * First public release.

data/README.rdoc

@@ -22,12 +22,19 @@ Get user token:
     # Get member
     client.member('me') do |m|
       # Returns Trello::Client::Member object
-      m['id']       # => member identity
+      m['id']       # => member identifier
       m['fullName'] # => member name
       m['userName'] # => member user
-
-      m.boards.each do |board|
-        # TODO Returns Board JSON
+      m['url']      # => member url
+    end
+
+    # Get member with boards
+    client.member( 'me', :boards => 'all' ) do |m|
+      m.boards.each do |b|
+        # Returns Trello::Client::Board objects
+        b['id']     # => board identifier
+        b['name']   # => board name
+        b['url']    # => board url
     end 
   end
 
@@ -45,9 +52,11 @@ https://github.com/blairc/trello-client/
 
 == To Do
 
-* Get boards
 * Get lists
 * Get cards
 * Memoize API calls
 * Add script
+* DRY +Board+ and +Member+
+* +Board+ initialization should take JSON or +Hash+
+* Member#boards() should fetch boards if not present?
 

data/lib/trello-client.rb

@@ -4,6 +4,7 @@ require 'multi_json'
 require 'open-uri'
 require 'uri'
 
+require 'trello-client/board'
 require 'trello-client/member'
 require 'trello-client/version'
 
@@ -32,12 +33,19 @@ require 'trello-client/version'
 #     # Get member
 #     client.member('me') do |m|
 #       # Returns Trello::Client::Member object
-#       m['id']       # => member identity
+#       m['id']       # => member identifier
 #       m['fullName'] # => member name
 #       m['userName'] # => member user
-#
-#       m.boards.each do |board|
-#         # TODO Returns Board JSON
+#       m['url']      # => member url
+#     end
+#
+#     # Get member with boards
+#     client.member( 'me', :boards => 'all' ) do |m|
+#       m.boards.each do |b|
+#         # Returns Trello::Client::Board objects
+#         b['id']     # => board identifier
+#         b['name']   # => board name
+#         b['url']    # => board url
 #     end 
 #   end
 #
@@ -55,11 +63,13 @@ require 'trello-client/version'
 #
 # == To Do
 #
-# * Get boards
 # * Get lists
 # * Get cards
 # * Memoize API calls
 # * Add script
+# * DRY +Board+ and +Member+
+# * +Board+ initialization should take JSON or +Hash+
+# * Member#boards() should fetch boards if not present?
 #
 module Trello   # :nodoc:
 

data/lib/trello-client/board.rb

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

data/lib/trello-client/member.rb

@@ -1,34 +1,42 @@
 # encoding: utf-8
 
 module Trello   # :nodoc:
-  class Client  # :nodoc
+  class Client  # :nodoc:
 
     #
     # Trello::Client::Member object
     #
+    # See https://trello.com/docs/api/member/index.html
+    #
     class Member
 
       #
-      # Initialize Trello::Member
+      # Initialize Trello::Client::Member
+      #
+      # Params:
+      # +member+:: JSON member
       #
-      def initialize(json)
-        @json = MultiJson.decode(json)
+      def initialize(member)
+        @member = MultiJson.decode(member)
         yield self if block_given?
         self
       end
 
       #
-      # Get Trello::Member property
+      # Get Trello::Client::Member property
       #
       def[](key)
-        @json[key]
+        @member[key]
       end
 
       #
       # Get +Array+ of boards
       #
       def boards
-        @json['boards'] || []
+        unless @boards
+          @boards = ( @member['boards'] || []  ).collect { |b| Trello::Client::Board.new(b) }
+        end
+        @boards
       end
 
     end # class Member

data/lib/trello-client/version.rb

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

data/test/test_member.rb

@@ -11,8 +11,50 @@ require 'test/unit'
 
 class TestMember < Test::Unit::TestCase
 
-  def test
-    skip 'TODO - Add explicit Test::Client::Member tests'
+  def setup
+    @test_dir   = File.dirname(__FILE__)
+    @test_data  = File.join( @test_dir, 'data' )
+  end
+
+  def test_boards
+    Trello::Client.new do |client|
+      json  = open( File.join( @test_data, 'member_with_boards.json' ) )
+      m     = Trello::Client::Member.new(json)
+      client.stubs(:member).with('me').returns(m)
+
+      assert_not_nil  m
+      assert_kind_of  Trello::Client::Member, m
+
+      assert_not_nil  m.boards
+      assert_kind_of  Array,    m.boards
+      assert_equal    3,        m.boards.size
+
+      first = m.boards.first
+      assert_not_nil  first
+      assert_kind_of  Trello::Client::Board,                                                                first
+      assert_equal    '4f4d0477e4ba0e4f09af1c6c',                                                           first['id']
+      assert_equal    '5E - Survey Database Site Features',                                                 first['name']
+      assert_equal    '',                                                                                   first['desc']
+      assert_equal    false,                                                                                first['closed']
+      assert_equal    '',                                                                                   first['idOrganization']
+      assert_equal    true,                                                                                 first['pinned']
+      assert_equal    'https://trello.com/board/5e-survey-database-site-features/4f4d0477e4ba0e4f09af1c6c', first['url']
+      assert_not_nil  first['prefs']
+      assert_kind_of  Hash,                                                                                 first['prefs']
+
+      last = m.boards.last
+      assert_not_nil  last
+      assert_kind_of  Trello::Client::Board,                                                                last
+      assert_equal    '4f6c9a79c3974b4d730a5533',                                                           last['id']
+      assert_equal    'uchicago',                                                                           last['name']
+      assert_equal    '',                                                                                   last['desc']
+      assert_equal    false,                                                                                last['closed']
+      assert_equal    '',                                                                                   last['idOrganization']
+      assert_equal    true,                                                                                 last['pinned']
+      assert_equal    'https://trello.com/board/uchicago/4f6c9a79c3974b4d730a5533',                         last['url']
+      assert_not_nil  last['prefs']
+      assert_kind_of  Hash,                                                                                 last['prefs']
+    end
   end
 
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: trello-client
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-03-28 00:00:00.000000000 Z
+date: 2012-03-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: multi_json
-  requirement: &70273668948620 !ruby/object:Gem::Requirement
+  requirement: &70241066627280 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70273668948620
+  version_requirements: *70241066627280
 - !ruby/object:Gem::Dependency
   name: fakeweb
-  requirement: &70273668947980 !ruby/object:Gem::Requirement
+  requirement: &70241066626700 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,10 +32,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70273668947980
+  version_requirements: *70241066626700
 - !ruby/object:Gem::Dependency
   name: mocha
-  requirement: &70273668947200 !ruby/object:Gem::Requirement
+  requirement: &70241066626160 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -43,10 +43,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70273668947200
+  version_requirements: *70241066626160
 - !ruby/object:Gem::Dependency
   name: rake
-  requirement: &70273668946460 !ruby/object:Gem::Requirement
+  requirement: &70241066625160 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -54,10 +54,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70273668946460
+  version_requirements: *70241066625160
 - !ruby/object:Gem::Dependency
   name: rdoc
-  requirement: &70273668945700 !ruby/object:Gem::Requirement
+  requirement: &70241066624560 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -65,10 +65,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70273668945700
+  version_requirements: *70241066624560
 - !ruby/object:Gem::Dependency
   name: rdoc-readme
-  requirement: &70273668944700 !ruby/object:Gem::Requirement
+  requirement: &70241066623460 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -76,10 +76,10 @@ dependencies:
         version: 0.1.2
   type: :development
   prerelease: false
-  version_requirements: *70273668944700
+  version_requirements: *70241066623460
 - !ruby/object:Gem::Dependency
   name: simplecov
-  requirement: &70273668965120 !ruby/object:Gem::Requirement
+  requirement: &70241066643560 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -87,7 +87,7 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70273668965120
+  version_requirements: *70241066643560
 description: Trello API client
 email:
 - blair.christensen@gmail.com
@@ -102,6 +102,7 @@ files:
 - README.rdoc
 - Rakefile
 - lib/trello-client.rb
+- lib/trello-client/board.rb
 - lib/trello-client/member.rb
 - lib/trello-client/version.rb
 - test/data/member.json
@@ -123,7 +124,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -3090611917339135223
+      hash: 2861758946972274756
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -132,7 +133,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -3090611917339135223
+      hash: 2861758946972274756
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.11