ruby-trello 0.1.0

data/README.md

@@ -0,0 +1,26 @@
+# Ruby Trello API
+
+[![Build Status](https://secure.travis-ci.org/jeremytregunna/ruby-trello.png)](http://travis-ci.org/jeremytregunna/ruby-trello)
+
+This library implements the [Trello](http://www.trello.com/) [API](http://trello.com/api).
+
+Trello is an awesome tool for organization. Not just aimed at developers, but everybody.
+Seriously, [check it out](http://www.trello.com/).
+
+## Installation
+
+Full disclosure: It doesn't presently work. I'm in the process of implementing
+the specs and the functionality. But if you want to check it out, clone the
+repo for now. I will produce a gem when it's at least minimally usable. When
+that is the case, I'll post that information here.
+
+## Contributing
+
+Pick up an editor, fix a test! (If you want to, of course.) Send a pull
+request, and I'll look at it. I only ask a few things:
+
+1. Feature branches please!
+2. Adding or refactoring existing features, ensure there are tests.
+
+Also, don't be afraid to send a pull request if your changes aren't done. Just
+let me know.

data/lib/trello.rb

@@ -0,0 +1,14 @@
+# Ruby wrapper around the Trello API
+# Copyright (c) 2012, Jeremy Tregunna
+# Use and distribution terms may be found in the file LICENSE included in this distribution.
+
+require 'oauth'
+require 'yajl'
+
+module Trello
+  autoload :Board,        'trello/board'
+  autoload :Card,         'trello/card'
+  autoload :Client,       'trello/client'
+  autoload :Member,       'trello/member'
+  autoload :Organization, 'trello/organization'
+end

data/lib/trello/board.rb

@@ -0,0 +1,54 @@
+# Ruby wrapper around the Trello API
+# Copyright (c) 2012, Jeremy Tregunna
+# Use and distribution terms may be found in the file LICENSE included in this distribution.
+
+module Trello
+  class Board
+    class << self
+      def find(id)
+        response = Client.query("/1/boards/#{id}")
+        new(Yajl::Parser.parse(response.read_body))
+      end
+    end
+
+   def initialize(fields = {})
+      @fields = fields
+    end
+
+    # Fields
+
+    def id
+      @fields['id']
+    end
+
+    def name
+      @fields['name']
+    end
+
+    def description
+      @fields['desc']
+    end
+
+    def closed
+      @fields['closed']
+    end
+
+    def url
+      @fields['url']
+    end
+
+    # Links to other data structures
+
+    def cards
+      response  = Client.query("/1/boards/#{id}/cards/all")
+      all_cards = Yajl::Parser.parse(response.read_body)
+      all_cards.map do |card_fields|
+        Card.new(card_fields)
+      end
+    end
+
+    def organization
+      Organization.find(@fields['idOrganization'])
+    end
+  end
+end

data/lib/trello/card.rb

@@ -0,0 +1,53 @@
+# Ruby wrapper around the Trello API
+# Copyright (c) 2012, Jeremy Tregunna
+# Use and distribution terms may be found in the file LICENSE included in this distribution.
+
+module Trello
+  class Card
+    class << self
+      def find(id)
+        response = Client.query("/1/cards/#{id}")
+        new(Yajl::Parser.parse(response.read_body))
+      end
+    end
+
+    def initialize(fields = {})
+      @fields = fields
+    end
+
+    # Fields
+
+    def id
+      @fields['id']
+    end
+
+    def name
+      @fields['name']
+    end
+
+    def description
+      @fields['desc']
+    end
+
+    def closed
+      @fields['closed']
+    end
+
+    def url
+      @fields['url']
+    end
+
+    # Links to other data structures
+
+    def board
+      Board.find(@fields['idBoard'])
+    end
+
+    def members
+      @fields['idMembers'].map do |member_id|
+        response  = Client.query("/1/members/#{member_id}")
+        Member.new(Yajl::Parser.parse(response.read_body))
+      end
+    end
+  end
+end

data/lib/trello/client.rb

@@ -0,0 +1,42 @@
+# Ruby wrapper around the Trello API
+# Copyright (c) 2012, Jeremy Tregunna
+# Use and distribution terms may be found in the file LICENSE included in this distribution.
+
+require 'addressable/uri'
+
+module Trello
+  class Client
+    class EnterYourPublicKey < StandardError; end
+    class EnterYourSecret < StandardError; end
+
+    class << self
+      attr_writer :public_key, :secret, :app_name
+
+      def query(path, options = { :method => :get, :params => {} })
+        uri = Addressable::URI.parse("https://api.trello.com#{path}")
+        uri.query_values = options[:params]
+
+        access_token.send(options[:method], uri.to_s)
+      end
+
+      protected
+
+      def consumer
+        raise EnterYourPublicKey if @public_key.to_s.empty?
+        raise EnterYourSecret if @secret.to_s.empty?
+
+        OAuth::Consumer.new(@public_key, @secret, :site => 'https://trello.com',
+                                                  :request_token_path => '/1/OAuthGetRequestToken',
+                                                  :authorize_path => '/1/OAuthAuthorizeToken',
+                                                  :access_token_path => '/1/OAuthGetAccessToken',
+                                                  :http_method => :get)
+      end
+
+      def access_token
+        return @access_token if @access_token
+
+        @access_token = OAuth::AccessToken.new(consumer)
+      end
+    end
+  end
+end

data/lib/trello/member.rb

@@ -0,0 +1,62 @@
+# Ruby wrapper around the Trello API
+# Copyright (c) 2012, Jeremy Tregunna
+# Use and distribution terms may be found in the file LICENSE included in this distribution.
+
+module Trello
+  class Member
+    class << self
+      def find(id_or_username)
+        response = Client.query("/1/members/#{id_or_username}")
+        new(Yajl::Parser.parse(response.read_body))
+      end
+    end
+
+    def initialize(fields = {})
+      @fields = fields
+    end
+
+    # Fields of a user
+
+    def id
+      @fields['id']
+    end
+
+    def full_name
+      @fields['fullName']
+    end
+
+    def username
+      @fields['username']
+    end
+
+    def gravatar_id
+      @fields['gravatar']
+    end
+
+    def bio
+      @fields['bio']
+    end
+
+    def url
+      @fields['url']
+    end
+
+    # Links to other data structures
+
+    def boards
+      response   = Client.query("/1/members/#{username}/boards/all")
+      all_boards = Yajl::Parser.parse(response.read_body)
+      all_boards.map do |board_fields|
+        Board.new(board_fields)
+      end
+    end
+
+    def organizations
+      response = Client.query("/1/members/#{username}/organizations/all")
+      all_orgs = Yajl::Parser.parse(response.read_body)
+      all_orgs.map do |org_fields|
+        Organization.new(org_fields)
+      end
+    end
+  end
+end

data/lib/trello/organization.rb

@@ -0,0 +1,40 @@
+# Ruby wrapper around the Trello API
+# Copyright (c) 2012, Jeremy Tregunna
+# Use and distribution terms may be found in the file LICENSE included in this distribution.
+
+module Trello
+  class Organization
+    class << self
+      def find(id)
+        response = Client.query("/1/organizations/#{id}")
+        new(Yajl::Parser.parse(response.read_body))
+      end
+    end
+
+    def initialize(fields = {})
+      @fields = fields
+    end
+
+    # Fields
+
+    def id
+      @fields['id']
+    end
+
+    def name
+      @fields['name']
+    end
+
+    def display_name
+      @fields['display_name']
+    end
+
+    def description
+      @fields['desc']
+    end
+
+    def url
+      @fields['url']
+    end
+  end
+end

data/spec/board_spec.rb

@@ -0,0 +1,52 @@
+require 'spec_helper'
+
+module Trello
+  describe Board do
+    include Helpers
+
+    before(:all) do
+      Client.public_key = 'dummy'
+      Client.secret     = 'dummy'
+    end
+
+    before(:each) do
+      stub_request(:get, "https://api.trello.com/1/boards/abcdef123456789123456789?").
+        with(:headers => {'Accept'=>'*/*', 'Authorization'=>/.*/, 'User-Agent' => /.*/}).
+        to_return(:status => 200, :headers => {}, :body => Yajl::Encoder.encode(boards_details.first))
+
+      @board = Board.find('abcdef123456789123456789')
+    end
+
+    context "fields" do
+      it "gets an id" do
+        @board.id.should_not be_nil
+      end
+
+      it "gets a name" do
+        @board.name.should_not be_nil
+      end
+
+      it "gets the description" do
+        @board.description.should_not be_nil
+      end
+
+      it "knows if it is closed or open" do
+        @board.closed.should_not be_nil
+      end
+
+      it "gets its url" do
+        @board.url.should_not be_nil
+      end
+    end
+
+    context "cards" do
+      it "gets its list of cards" do
+        stub_request(:get, "https://api.trello.com/1/boards/abcdef123456789123456789/cards/all?").
+          with(:headers => {'Accept'=>'*/*', 'Authorization'=>/.*/, 'User-Agent' => /.*/}).
+          to_return(:status => 200, :headers => {}, :body => cards_payload)
+
+        @board.cards.count.should be > 0
+      end
+    end
+  end
+end

data/spec/card_spec.rb

@@ -0,0 +1,66 @@
+require 'spec_helper'
+
+module Trello
+  describe Card do
+    include Helpers
+
+    before(:all) do
+      Client.public_key = 'dummy'
+      Client.secret     = 'dummy'
+    end
+
+    before(:each) do
+      stub_request(:get, "https://api.trello.com/1/cards/abcdef123456789123456789?").
+        with(:headers => {'Accept'=>'*/*', 'Authorization'=>/.*/, 'User-Agent' => /.*/}).
+        to_return(:status => 200, :headers => {}, :body => Yajl::Encoder.encode(cards_details.first))
+
+      @card = Card.find('abcdef123456789123456789')
+    end
+
+    context "fields" do
+      it "gets its id" do
+        @card.id.should_not be_nil
+      end
+
+      it "gets its name" do
+        @card.name.should_not be_nil
+      end
+
+      it "gets its description" do
+        @card.description.should_not be_nil
+      end
+
+      it "knows if it is open or closed" do
+        @card.closed.should_not be_nil
+      end
+
+      it "gets its url" do
+        @card.url.should_not be_nil
+      end
+    end
+
+    context "boards" do
+      it "has a board" do
+        stub_request(:get, "https://api.trello.com/1/boards/abcdef123456789123456789?").
+          with(:headers => {'Accept'=>'*/*', 'Authorization'=>/.*/, 'User-Agent' => /.*/}).
+          to_return(:status => 200, :headers => {}, :body => Yajl::Encoder.encode(boards_details.first))
+
+        @card.board.should_not be_nil
+      end
+    end
+
+    context "members" do
+      it "has a list of members" do
+        stub_request(:get, "https://api.trello.com/1/boards/abcdef123456789123456789?").
+          with(:headers => {'Accept'=>'*/*', 'Authorization'=>/.*/, 'User-Agent' => /.*/}).
+          to_return(:status => 200, :headers => {}, :body => Yajl::Encoder.encode(boards_details.first))
+        stub_request(:get, "https://api.trello.com/1/members/abcdef123456789123456789?").
+          with(:headers => {'Accept'=>'*/*', 'Authorization'=>/.*/, 'User-Agent' => /.*/}).
+          to_return(:status => 200, :headers => {}, :body => user_payload)
+
+        @card.board.should_not be_nil
+        @card.members.should_not be_nil
+      end
+    end
+  end
+end

data/spec/client_spec.rb

@@ -0,0 +1,30 @@
+require 'spec_helper'
+
+module Trello
+  describe Client do
+    before(:all) do
+      Client.public_key = 'dummy'
+      Client.secret     = 'dummy'
+    end
+
+    context 'keys' do
+      after do
+        Client.public_key = 'dummy'
+      end
+
+      it 'throws an error if the public key is ommitted' do
+        Client.public_key = ''
+        lambda { Client.send(:consumer) }.should raise_error(Client::EnterYourPublicKey)
+      end
+
+      after do
+        Client.secret = 'dummy'
+      end
+
+      it 'throws an error if the secret is ommitted' do
+        Client.secret = ''
+        lambda { Client.send(:consumer) }.should raise_error(Client::EnterYourSecret)
+      end
+    end
+  end
+end

data/spec/member_spec.rb

@@ -0,0 +1,68 @@
+# Specs covering the members namespace in the Trello API
+
+require 'spec_helper'
+
+module Trello
+  describe Member do
+    include Helpers
+
+    before(:all) do
+      Client.public_key = 'dummy'
+      Client.secret     = 'dummy'
+    end
+
+    before(:each) do
+      stub_oauth!
+      @member = Member.find('me')
+    end
+
+    context "actions" do
+      # This spec needs a better name
+      it "retrieves a list of actions"
+    end
+
+    context "boards" do
+      it "has a list of boards" do
+        stub_request(:get, "https://api.trello.com/1/members/me/boards/all?").
+          with(:headers => {'Accept'=>'*/*', 'Authorization'=>/.*/, 'User-Agent' => /.*/}).
+          to_return(:status => 200, :headers => {}, :body => boards_payload)
+
+        boards = @member.boards
+        boards.count.should be > 0
+      end
+    end
+
+    context "organizations" do
+      it "has a list of organizations" do
+        stub_request(:get, "https://api.trello.com/1/members/me/organizations/all?").
+          with(:headers => {'Accept'=>'*/*', 'Authorization'=>/.*/, 'User-Agent' => /.*/}).
+          to_return(:status => 200, :headers => {}, :body => orgs_payload)
+
+        orgs = @member.organizations
+        orgs.count.should be > 0
+      end
+    end
+
+    context "personal" do
+      it "gets the members bio" do
+        @member.bio.should_not be_nil
+      end
+
+      it "gets the full name" do
+        @member.full_name.should_not be_nil
+      end
+
+      it "gets the gravatar id" do
+        @member.gravatar_id.should_not be_nil
+      end
+
+      it "gets the url" do
+        @member.url.should_not be_nil
+      end
+
+      it "gets the username" do
+        @member.username.should_not be_nil
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,86 @@
+require 'rubygems'
+
+# Set up gems listed in the Gemfile.
+begin
+  ENV['BUNDLE_GEMFILE'] = File.expand_path('../Gemfile', File.dirname(__FILE__))
+  require 'bundler'
+  Bundler.setup
+rescue Bundler::GemNotFound => e
+  STDERR.puts e.message
+  STDERR.puts "Try running `bundle install`."
+  exit!
+end
+
+Bundler.require(:spec)
+
+require 'trello'
+require 'webmock/rspec'
+
+module Helpers
+  def user_details
+    {
+      "id"       => "abcdef123456789012345678",
+      "fullName" => "Test User",
+      "username" => "me",
+      "gravatar" => "abcdef1234567890abcdef1234567890",
+      "bio"      => "a rather dumb user",
+      "url"      => "https://trello.com/me"
+    }
+  end
+
+  def user_payload
+    Yajl::Encoder.encode(user_details)
+  end
+
+  def boards_details
+    [{
+      "id"             => "abcdef123456789123456789",
+      "name"           => "Test",
+      "desc"           => "This is a test board",
+      "closed"         => false,
+      "idOrganization" => "abcdef123456789123456789",
+      "url"            => "https://trello.com/board/test/abcdef123456789123456789"
+    }]
+  end
+
+  def boards_payload
+    Yajl::Encoder.encode(boards_details)
+  end
+
+  def cards_details
+    [{
+      "id"        => "abcdef123456789123456789",
+      "name"      => "Do something awesome",
+      "desc"      => "Awesome things are awesome.",
+      "closed"    => false,
+      "idList"    => "abcdef123456789123456789",
+      "idBoard"   => "abcdef123456789123456789",
+      "idMembers" => ["abcdef123456789123456789"],
+      "url"       => "https://trello.com/card/board/specify-the-type-and-scope-of-the-jit-in-a-lightweight-spec/abcdef123456789123456789/abcdef123456789123456789"
+    }]
+  end
+
+  def cards_payload
+    Yajl::Encoder.encode(cards_details)
+  end
+
+  def orgs_details
+    [{
+      "id"          => "abcdef123456789123456789",
+      "name"        => "test",
+      "displayName" => "Test Organization",
+      "desc"        => "This is a test organization",
+      "url"         => "https://trello.com/test"
+    }]
+  end
+
+  def orgs_payload
+    Yajl::Encoder.encode(orgs_details)
+  end
+
+  def stub_oauth!
+    stub_request(:get, "https://api.trello.com/1/members/me?").
+       with(:headers => {'Accept'=>'*/*', 'Authorization'=>/.*/, 'User-Agent' => /.*/}).
+       to_return(:status => 200, :headers => {}, :body => user_payload)
+  end
+end

metadata

@@ -0,0 +1,109 @@
+--- !ruby/object:Gem::Specification
+name: ruby-trello
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+  prerelease: 
+platform: ruby
+authors:
+- Jeremy Tregunna
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-01-07 00:00:00.000000000Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: yajl-ruby
+  requirement: &70132949849940 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 1.1.0
+  type: :runtime
+  prerelease: false
+  version_requirements: *70132949849940
+- !ruby/object:Gem::Dependency
+  name: oauth
+  requirement: &70132949849480 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.4.5
+  type: :runtime
+  prerelease: false
+  version_requirements: *70132949849480
+- !ruby/object:Gem::Dependency
+  name: addressable
+  requirement: &70132949849020 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.2.6
+  type: :runtime
+  prerelease: false
+  version_requirements: *70132949849020
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: &70132949874400 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+  type: :development
+  prerelease: false
+  version_requirements: *70132949874400
+description: A wrapper around the trello.com API.
+email: jeremy@tregunna.ca
+executables: []
+extensions: []
+extra_rdoc_files:
+- README.md
+files:
+- lib/trello/board.rb
+- lib/trello/card.rb
+- lib/trello/client.rb
+- lib/trello/member.rb
+- lib/trello/organization.rb
+- lib/trello.rb
+- README.md
+- spec/board_spec.rb
+- spec/card_spec.rb
+- spec/client_spec.rb
+- spec/member_spec.rb
+- spec/organization_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/jeremytregunna/ruby-trello
+licenses: []
+post_install_message: 
+rdoc_options:
+- --charset=UTF-8
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: 1.3.6
+requirements: []
+rubyforge_project: ruby-trello
+rubygems_version: 1.8.10
+signing_key: 
+specification_version: 3
+summary: A wrapper around the trello.com API.
+test_files:
+- spec/board_spec.rb
+- spec/card_spec.rb
+- spec/client_spec.rb
+- spec/member_spec.rb
+- spec/organization_spec.rb
+- spec/spec_helper.rb