trello-client 0.0.1

data/.gitignore

@@ -0,0 +1,20 @@
+.*.swp
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+html/
+lib/bundler/man
+out.txt
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in trello-client.gemspec
+gemspec

data/History.rdoc

@@ -0,0 +1,7 @@
+= Trello::Client History
+
+== 2012-03-28 v0.0.1
+
+* First public release.
+* Added Trello::Client#member()
+

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2012 blair christensen
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.rdoc

@@ -0,0 +1,53 @@
+= Trello::Client - Trello API client
+
+== Configuration
+
+Get developer API key:
+  https://trello.com/1/appKey/generate
+
+Get user token:
+  https://trello.com/1/connect?key=$YOUR_API_KEY&name=trello-client.rb&response_type=token
+
+== Usage
+
+  require 'trello-client'
+
+  Trello::Client.new do |client|
+    # Set API key
+    client.api_key = ...
+
+    # Set token
+    client.token = ...
+
+    # Get member
+    client.member('me') do |m|
+      # Returns Trello::Client::Member object
+      m['id']       # => member identity
+      m['fullName'] # => member name
+      m['userName'] # => member user
+
+      m.boards.each do |board|
+        # TODO Returns Board JSON
+    end 
+  end
+
+== Author
+
+blair christensen. <mailto:blair.christensen@gmail.com>
+
+== Homepage
+
+https://github.com/blairc/trello-client/
+
+== See Also
+
+* https://trello.com/docs/api/
+
+== To Do
+
+* Get boards
+* Get lists
+* Get cards
+* Memoize API calls
+* Add script
+

data/Rakefile

@@ -0,0 +1,49 @@
+#!/usr/bin/env rake
+require 'bundler/gem_tasks'
+
+require 'rake/clean'
+require 'rake/testtask'
+require 'rdoc-readme/rake_task'
+require 'rdoc/task'
+
+%w{ coverage html out.txt pkg }.each { |p| CLEAN.include(p) }
+%w{ build install rdoc test }.each   { |t| task t.to_sym => [ 'rdoc:readme' ] }
+
+task :default => :test
+
+Rake::TestTask.new do |t|
+  t.libs       << 'test'
+  t.test_files =   FileList['test/test*.rb']
+  t.verbose    =   true
+end
+
+RDoc::Readme::RakeTask.new 'lib/trello-client.rb', 'README.rdoc'
+
+RDoc::Task.new do |rdoc|
+  rdoc.main = 'README.rdoc'
+  rdoc.rdoc_files.include('README.rdoc', 'lib/**/*.rb', 'doc/*.txt')
+end
+
+desc 'Update test data files'
+task :update_test_data do
+  $LOAD_PATH << 'lib'
+  require 'open-uri'
+  require 'trello-client'
+
+  Trello::Client.new do |client|
+    client.api_key    = ENV['TRELLO_API_KEY']
+    client.api_token  = ENV['TRELLO_API_TOKEN']
+    
+    {
+      'member'              => [ :member, 'me' ],
+      'member_with_boards'  => [ :member, 'me', :boards => 'all' ]
+    }.each_pair do |file, request|
+      fn    = File.join( File.dirname(__FILE__), 'test', 'data', "#{file}.json" )
+      meth  = request.shift
+      args  = request
+      File.open(fn, 'w') { |fh| fh.puts( client.send meth, *args ) }
+    end
+  end
+
+end
+

data/lib/trello-client.rb

@@ -0,0 +1,134 @@
+# encoding: utf-8
+
+require 'multi_json'
+require 'open-uri'
+require 'uri'
+
+require 'trello-client/member'
+require 'trello-client/version'
+
+#
+# = Trello::Client - Trello API client
+#
+# == Configuration
+#
+# Get developer API key:
+#   https://trello.com/1/appKey/generate
+#
+# Get user token:
+#   https://trello.com/1/connect?key=$YOUR_API_KEY&name=trello-client.rb&response_type=token
+#
+# == Usage
+#
+#   require 'trello-client'
+#
+#   Trello::Client.new do |client|
+#     # Set API key
+#     client.api_key = ...
+#
+#     # Set token
+#     client.token = ...
+#
+#     # Get member
+#     client.member('me') do |m|
+#       # Returns Trello::Client::Member object
+#       m['id']       # => member identity
+#       m['fullName'] # => member name
+#       m['userName'] # => member user
+#
+#       m.boards.each do |board|
+#         # TODO Returns Board JSON
+#     end 
+#   end
+#
+# == Author
+#
+# blair christensen. <mailto:blair.christensen@gmail.com>
+#
+# == Homepage
+#
+# https://github.com/blairc/trello-client/
+#
+# == See Also
+#
+# * https://trello.com/docs/api/
+#
+# == To Do
+#
+# * Get boards
+# * Get lists
+# * Get cards
+# * Memoize API calls
+# * Add script
+#
+module Trello   # :nodoc:
+
+  #
+  # Trello API client.
+  #
+  class Client
+
+    #
+    # Get/Set Trello API URL
+    #
+    attr_accessor :api
+ 
+    #
+    # Get/Set Trello API key
+    #
+    attr_accessor :api_key
+    
+    #
+    # Get/Set Trello API application token
+    #
+    attr_accessor :api_token
+
+    #
+    # Initialize Trello::Client object
+    # 
+    def initialize
+      @api        = 'https://api.trello.com/1'
+      @api_key    = nil
+      @api_token  = nil
+      yield self if block_given?
+      self
+    end
+
+    #
+    # Get Trello::Client::Member object
+    # 
+    # See https://trello.com/docs/api/member/index.html
+    #
+    # Params:
+    # +id+:: Member identifier
+    # +options+:: (optional) Additional API parameters
+    #
+    def member(id, options = {} )
+      raise('invalid id') if id.nil? || id.empty?
+      _get "#{api}/members/#{id}", options
+    end
+
+
+    private
+
+    def _get( uri, options = {} )
+      raise('invalid URI')        if uri.nil?         || uri.empty?
+      raise('invalid API key')    if @api_key.nil?    || @api_key.empty?
+      raise('invalid API token')  if @api_token.nil?  || @api_token.empty?
+
+      defaults = { :key => @api_key, :token => @api_token }
+      options.merge!(defaults)
+      if options
+        uri << '?'
+        options.keys.sort.each do |k|
+          uri << "#{k}=#{ options[k] }&"
+        end
+      end
+      uri.gsub! /&$/, ''
+      open(uri).read
+    end
+
+  end # class Client
+
+end # module Trello
+

data/lib/trello-client/member.rb

@@ -0,0 +1,38 @@
+# encoding: utf-8
+
+module Trello   # :nodoc:
+  class Client  # :nodoc
+
+    #
+    # Trello::Client::Member object
+    #
+    class Member
+
+      #
+      # Initialize Trello::Member
+      #
+      def initialize(json)
+        @json = MultiJson.decode(json)
+        yield self if block_given?
+        self
+      end
+
+      #
+      # Get Trello::Member property
+      #
+      def[](key)
+        @json[key]
+      end
+
+      #
+      # Get +Array+ of boards
+      #
+      def boards
+        @json['boards'] || []
+      end
+
+    end # class Member
+
+  end # class Client
+end   # module Trello
+

data/lib/trello-client/version.rb

@@ -0,0 +1,10 @@
+# encoding: utf-8
+
+module Trello
+  class Client
+    #
+    # Trello::Client version
+    #
+    VERSION = '0.0.1'
+  end
+end

data/test/data/member.json

@@ -0,0 +1 @@
+{"id":"4f4f9d55cf2e679318098c45","fullName":"blair christensen","initials":"BC","username":"blairchristensen","avatarHash":"65fcb89a59ff96b68b11332686c8f4f9","bio":"","url":"https://trello.com/blairchristensen"}

data/test/data/member_with_boards.json

@@ -0,0 +1 @@
+{"id":"4f4f9d55cf2e679318098c45","fullName":"blair christensen","initials":"BC","username":"blairchristensen","avatarHash":"65fcb89a59ff96b68b11332686c8f4f9","bio":"","url":"https://trello.com/blairchristensen","boards":[{"id":"4f4d0477e4ba0e4f09af1c6c","name":"5E - Survey Database Site Features","desc":"","closed":false,"idOrganization":"","pinned":true,"url":"https://trello.com/board/5e-survey-database-site-features/4f4d0477e4ba0e4f09af1c6c","prefs":{"selfJoin":false,"invitations":"members","comments":"members","voting":"members","permissionLevel":"private"}},{"id":"4f4f9d55cf2e679318098c5b","name":"Welcome Board","desc":"","closed":false,"pinned":true,"url":"https://trello.com/board/welcome-board/4f4f9d55cf2e679318098c5b","prefs":{"selfJoin":false,"invitations":"members","comments":"members","voting":"members","permissionLevel":"private"}},{"id":"4f6c9a79c3974b4d730a5533","name":"uchicago","desc":"","closed":false,"idOrganization":"","pinned":true,"url":"https://trello.com/board/uchicago/4f6c9a79c3974b4d730a5533","prefs":{"selfJoin":false,"invitations":"members","comments":"members","voting":"members","permissionLevel":"private"}}]}

data/test/test_client.rb

@@ -0,0 +1,147 @@
+# encoding: utf-8
+
+require 'simplecov'
+SimpleCov.start
+
+require 'fakeweb'
+require 'mocha'
+require 'trello-client'
+require 'test/unit'
+
+
+class TestClient < Test::Unit::TestCase
+
+  def setup
+    @api_key    = 'test'
+    @api_token  = 'test'
+
+    @test_dir   = File.dirname(__FILE__)
+    @test_data  = File.join( @test_dir, 'data' )
+  end
+
+
+  def test_initialization
+     blockable = false
+     client = Trello::Client.new do |client|
+       assert_kind_of  Trello::Client, client
+       blockable = true
+     end
+     assert         blockable,          'works as block'
+     assert_kind_of Trello::Client, client
+     assert_kind_of Trello::Client, Trello::Client.new
+   end
+
+  def test_accessors
+    Trello::Client.new do |client|
+      assert_equal  'https://api.trello.com/1', client.api
+      assert_nil    client.api_key
+      assert_nil    client.api_token
+    end
+  end
+
+  def test_member_parameter_validation
+    Trello::Client.new do |client|
+      assert_raise(RuntimeError, 'invalid id') { client.member(nil) }
+      assert_raise(RuntimeError, 'invalid id') { client.member('')  }
+
+      assert_nil    client.api_key
+      assert_raise(RuntimeError, 'invalid API key') { client.member('me') }
+      client.api_key = ''
+      assert_equal  '', client.api_key
+      assert_raise(RuntimeError, 'invalid API key') { client.member('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.member('me') }
+      client.api_token = ''
+      assert_equal  '', client.api_token
+      assert_raise(RuntimeError, 'invalid API token') { client.member('me') }
+    end
+  end
+
+  def test_member
+    Trello::Client.new do |client|
+      json  = open( File.join( @test_data, 'member.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_equal  '65fcb89a59ff96b68b11332686c8f4f9',     m['avatarHash']
+      assert_equal  '',                                     m['bio']
+      assert_nil    m['boards']
+      assert_equal  'blair christensen',                    m['fullName']
+      assert_equal  '4f4f9d55cf2e679318098c45',             m['id']
+      assert_equal  'BC',                                   m['initials']
+      assert_equal  'https://trello.com/blairchristensen',  m['url']
+      assert_equal  'blairchristensen',                     m['username']
+
+      assert_not_nil  m.boards
+      assert_kind_of  Array,    m.boards
+      assert_equal    0,        m.boards.size
+    end
+  end
+
+  def test_member_with_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_equal    '65fcb89a59ff96b68b11332686c8f4f9',     m['avatarHash']
+      assert_equal    '',                                     m['bio']
+      assert_not_nil  m['boards']
+      assert_equal    'blair christensen',                    m['fullName']
+      assert_equal    '4f4f9d55cf2e679318098c45',             m['id']
+      assert_equal    'BC',                                   m['initials']
+      assert_equal    'https://trello.com/blairchristensen',  m['url']
+      assert_equal    'blairchristensen',                     m['username']
+
+      assert_not_nil  m.boards
+      assert_kind_of  Array,    m.boards
+      assert_equal    3,        m.boards.size
+    end
+  end
+
+  def test_underscore_get_parameter_validation
+    Trello::Client.new do |client|
+      uri = "#{ client.api }/member/me"
+
+      assert_raise(RuntimeError, 'invalid URI') { client.send( :_get, nil ) }
+      assert_raise(RuntimeError, 'invalid URI') { client.send( :_get, '' )  }
+
+      assert_raise(RuntimeError, 'invalid API key') { client.send( :_get, uri ) }
+      assert_raise(RuntimeError, 'invalid API key') { client.send( :_get, uri ) }
+      client.api_key = @api_key
+
+      assert_raise(RuntimeError, 'invalid API token') { client.send( :_get, uri ) }
+      assert_raise(RuntimeError, 'invalid API token') { client.send( :_get, uri ) }
+      client.api_token = @api_token
+    end
+  end
+
+  def test_underscore_get
+    Trello::Client.new do |client|
+      json      = open( File.join( @test_data, 'member.json' ) ).read
+      uri       = "#{ client.api }/member/me"
+      fake_uri  = "#{uri}?key=test&token=test"
+      FakeWeb.register_uri( :get, fake_uri, :body => json )
+
+      client.api_key    = @api_key
+      client.api_token  = @api_token
+
+      r = client.send( :_get, uri )
+      
+      assert_not_nil  r
+      assert_equal    json, r
+    end
+
+  end
+
+end
+

data/test/test_member.rb

@@ -0,0 +1,19 @@
+# encoding: utf-8
+
+require 'simplecov'
+SimpleCov.start
+
+require 'fakeweb'
+require 'mocha'
+require 'trello-client'
+require 'test/unit'
+
+
+class TestMember < Test::Unit::TestCase
+
+  def test
+    skip 'TODO - Add explicit Test::Client::Member tests'
+  end
+
+end
+

data/trello-client.gemspec

@@ -0,0 +1,27 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/trello-client/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.authors       = ['blair christensen']
+  gem.email         = ['blair.christensen@gmail.com']
+  gem.description   = %q{Trello API client}
+  gem.summary       = %q{Trello API client}
+  gem.homepage      = 'https://github.com/blairc/trello-client/'
+
+  gem.files         = `git ls-files`.split($\)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.name          = 'trello-client'
+  gem.require_paths = ['lib']
+  gem.version       = Trello::Client::VERSION
+
+  gem.add_runtime_dependency  'multi_json'
+
+  gem.add_development_dependency 'fakeweb'
+  gem.add_development_dependency 'mocha'
+  gem.add_development_dependency 'rake'
+  gem.add_development_dependency 'rdoc'
+  gem.add_development_dependency 'rdoc-readme', '~> 0.1.2'
+  gem.add_development_dependency 'simplecov'
+end
+

metadata

@@ -0,0 +1,146 @@
+--- !ruby/object:Gem::Specification
+name: trello-client
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- blair christensen
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-03-28 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: multi_json
+  requirement: &70273668948620 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *70273668948620
+- !ruby/object:Gem::Dependency
+  name: fakeweb
+  requirement: &70273668947980 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70273668947980
+- !ruby/object:Gem::Dependency
+  name: mocha
+  requirement: &70273668947200 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70273668947200
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: &70273668946460 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70273668946460
+- !ruby/object:Gem::Dependency
+  name: rdoc
+  requirement: &70273668945700 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70273668945700
+- !ruby/object:Gem::Dependency
+  name: rdoc-readme
+  requirement: &70273668944700 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.1.2
+  type: :development
+  prerelease: false
+  version_requirements: *70273668944700
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: &70273668965120 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70273668965120
+description: Trello API client
+email:
+- blair.christensen@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- History.rdoc
+- LICENSE
+- README.rdoc
+- Rakefile
+- lib/trello-client.rb
+- lib/trello-client/member.rb
+- lib/trello-client/version.rb
+- test/data/member.json
+- test/data/member_with_boards.json
+- test/test_client.rb
+- test/test_member.rb
+- trello-client.gemspec
+homepage: https://github.com/blairc/trello-client/
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: -3090611917339135223
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: -3090611917339135223
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.11
+signing_key: 
+specification_version: 3
+summary: Trello API client
+test_files:
+- test/data/member.json
+- test/data/member_with_boards.json
+- test/test_client.rb
+- test/test_member.rb