ruby-trello-wgibbs 0.4.3

data/lib/trello/client.rb

@@ -0,0 +1,49 @@
+require 'addressable/uri'
+
+module Trello
+  class Client
+    extend Authorization
+
+    class << self
+      def get(path, params = {})
+        uri = Addressable::URI.parse("https://api.trello.com/#{API_VERSION}#{path}")
+        uri.query_values = params unless params.empty?
+        invoke_verb(:get, uri)
+      end
+
+      def post(path, body = {})
+        uri = Addressable::URI.parse("https://api.trello.com/#{API_VERSION}#{path}")
+        invoke_verb(:post, uri, body)
+      end
+
+      def put(path, body = {})
+        uri = Addressable::URI.parse("https://api.trello.com/#{API_VERSION}#{path}")
+        invoke_verb(:put, uri, body)
+      end
+
+      def delete(path)
+        uri = Addressable::URI.parse("https://api.trello.com/#{API_VERSION}#{path}")
+        invoke_verb(:delete, uri)
+      end
+
+      def invoke_verb(name, uri, body = nil)
+        request = Request.new name, uri, {}, body
+        response = TInternet.execute AuthPolicy.authorize(request)
+
+        return '' unless response
+
+        if response.code.to_i == 401 && response.body =~ /expired token/
+          Trello.logger.error("[401 #{name.to_s.upcase} #{uri}]: Your access token has expired.")
+          raise InvalidAccessToken, response.body
+        end
+
+        unless [200, 201].include? response.code
+          Trello.logger.error("[#{response.code} #{name.to_s.upcase} #{uri}]: #{response.body}")
+          raise Error, response.body
+        end
+
+        response.body
+      end
+    end
+  end
+end

data/lib/trello/has_actions.rb

@@ -0,0 +1,9 @@
+module Trello
+  module HasActions
+    # Returns a list of the actions associated with this object.
+    def actions(options = {})
+      actions = Client.get("#{request_prefix}/actions", { :filter => :all }.merge(options)).json_into(Action)
+      MultiAssociation.new(self, actions).proxy
+    end
+  end
+end

data/lib/trello/item.rb

@@ -0,0 +1,18 @@
+module Trello
+  # An Item is a basic task that can be checked off and marked as completed.
+  class Item < BasicData
+    register_attributes :id, :name, :type, :readonly => [ :id, :name, :type ]
+    validates_presence_of :id, :type
+
+    # Updates the fields of an item.
+    #
+    # Supply a hash of string keyed data retrieved from the Trello API representing
+    # an item.
+    def update_fields(fields)
+      attributes[:id]   = fields['id']
+      attributes[:name] = fields['name']
+      attributes[:type] = fields['type']
+      self
+    end
+  end
+end

data/lib/trello/item_state.rb

@@ -0,0 +1,23 @@
+module Trello
+  # Represents the state of an item.
+  class ItemState < BasicData
+    register_attributes :id, :state, :item_id, :readonly => [ :id, :state, :item_id ]
+    validates_presence_of :id, :item_id
+
+    # Update the fields of an item state.
+    #
+    # Supply a hash of string keyed data retrieved from the Trello API representing
+    # an item state.
+    def update_fields(fields)
+      attributes[:id]      = fields['id']
+      attributes[:state]   = fields['state']
+      attributes[:item_id] = fields['idItem']
+      self
+    end
+
+    # Return the item this state belongs to.
+    def item
+      Item.find(item_id)
+    end
+  end
+end

data/lib/trello/label.rb

@@ -0,0 +1,19 @@
+module Trello
+
+  # A colored Label attached to a card
+  class Label < BasicData
+    register_attributes :name, :color
+
+    # Update the fields of a label.
+    #
+    # Supply a hash of stringkeyed data retrieved from the Trello API representing
+    # a label.
+    def update_fields(fields)
+      attributes[:name]  = fields['name']
+      attributes[:color] = fields['color']
+      self
+    end
+
+  end
+
+end

data/lib/trello/list.rb

@@ -0,0 +1,71 @@
+module Trello
+  # A List is a container which holds cards. Lists are items on a board.
+  class List < BasicData
+    register_attributes :id, :name, :closed, :board_id, :readonly => [ :id, :board_id ]
+    validates_presence_of :id, :name, :board_id
+    validates_length_of   :name, :in => 1..16384
+
+    include HasActions
+
+    class << self
+      # Finds a specific list, given an id.
+      def find(id)
+        super(:lists, id)
+      end
+
+      def create(options)
+        new('name'    => options[:name],
+            'idBoard' => options[:board_id]).save
+      end
+    end
+
+    # Updates the fields of a list.
+    #
+    # Supply a hash of string keyed data retrieved from the Trello API representing
+    # a List.
+    def update_fields(fields)
+      attributes[:id]       = fields['id']
+      attributes[:name]     = fields['name']
+      attributes[:closed]   = fields['closed']
+      attributes[:board_id] = fields['idBoard']
+      self
+    end
+
+    def save
+      return update! if id
+
+      Client.post("/lists", {
+        :name    => name,
+        :closed  => closed || false,
+        :idBoard => board_id
+      }).json_into(self)
+    end
+
+    def update!
+      Client.put("/lists", {
+        :name   => name,
+        :closed => closed
+      }).json_into(self)
+    end
+
+    # Check if the list is not active anymore.
+    def closed?
+      closed
+    end
+
+    # Return the board the list is connected to.
+    one :board, :using => :board_id
+
+    # Returns all the cards on this list.
+    #
+    # The options hash may have a filter key which can have its value set as any
+    # of the following values:
+    #    :filter => [ :none, :open, :closed, :all ] # default :open
+    many :cards, :filter => :open
+
+    # :nodoc:
+    def request_prefix
+      "/lists/#{id}"
+    end
+  end
+end

data/lib/trello/member.rb

@@ -0,0 +1,93 @@
+module Trello
+  # A Member is a user of the Trello service.
+  class Member < BasicData
+    register_attributes :id, :username, :full_name, :avatar_id, :bio, :url, :readonly => [ :id, :username, :avatar_id, :url ]
+    validates_presence_of :id, :username
+    validates_length_of   :full_name, :minimum => 4
+    validates_length_of   :bio,       :maximum => 16384
+
+    include HasActions
+
+    class << self
+      # Finds a user
+      #
+      # The argument may be specified as either an _id_ or a _username_.
+      def find(id_or_username)
+        super(:members, id_or_username)
+      end
+    end
+
+    # Update the fields of a member.
+    #
+    # Supply a hash of string keyed data retrieved from the Trello API representing
+    # an Member.
+    def update_fields(fields)
+      attributes[:id]        = fields['id']
+      attributes[:full_name] = fields['fullName']
+      attributes[:username]  = fields['username']
+      attributes[:avatar_id] = fields['avatarHash']
+      attributes[:bio]       = fields['bio']
+      attributes[:url]       = fields['url']
+      self
+    end
+
+    # Retrieve a URL to the avatar.
+    # 
+    # Valid values for options are:
+    #   :large (170x170)
+    #   :small (30x30)
+    def avatar_url(options = { :size => :large })
+      size = options[:size] == :small ? 30 : 170
+      "https://trello-avatars.s3.amazonaws.com/#{avatar_id}/#{size}.png"
+    end
+
+    # Returns a list of the boards a member is a part of.
+    #
+    # This method, when called, can take a hash table with a filter key containing any
+    # of the following values:
+    #   :filter => [ :none, :members, :organization, :public, :open, :closed, :all ] # default: :all
+    # i.e.,
+    #    me.boards(:filter => :closed) # retrieves all closed boards
+    many :boards, :filter => :all
+
+    # Returns a list of cards the member is assigned to.
+    #
+    # This method, when called, can take a hash table with a filter key containing any
+    # of the following values:
+    #    :filter => [ :none, :open, :closed, :all ] # default :open
+    # i.e.,
+    #    me.cards(:filter => :closed) # retrieves all closed cards
+    many :cards, :filter => :open
+
+    # Returns a list of the organizations this member is a part of.
+    #
+    # This method, when called, can take a hash table with a filter key containing any
+    # of the following values:
+    #   :filter => [ :none, :members, :public, :all ] # default: all
+    # i.e.,
+    #    me.organizations(:filter => :public) # retrieves all public organizations
+    many :organizations, :filter => :all
+
+    # Returns a list of notifications for the user
+    many :notifications
+
+    def save
+      @previously_changed = changes
+      @changed_attributes.clear
+
+      return update! if id
+    end
+
+    def update!
+      Client.put(request_prefix, {
+        :fullName => full_name,
+        :bio      => bio
+      }).json_into(self)
+    end
+
+    # :nodoc:
+    def request_prefix
+      "/members/#{id}"
+    end
+  end
+end

data/lib/trello/multi_association.rb

@@ -0,0 +1,10 @@
+module Trello
+  class MultiAssociation < Association
+    delegate :count, :to => :target
+
+    def initialize(owner, target = [])
+      super
+      @proxy = AssociationProxy.new(self)
+    end
+  end
+end

data/lib/trello/net.rb

@@ -0,0 +1,37 @@
+module Trello
+  Request = Struct.new "Request", :verb, :uri, :headers, :body
+  Response = Struct.new "Response", :code, :headers, :body
+
+  class TInternet
+    class << self
+      def execute(request)
+        try_execute request
+      end
+
+      private 
+
+      def try_execute(request)
+        begin
+          if request
+            result = execute_core request
+            Response.new(200, {}, result)
+          end
+        rescue Exception => e
+          Response.new(e.http_code, {}, e.http_body)
+        end
+      end
+
+      def execute_core(request)
+        require "rest_client"
+        
+        RestClient::Request.execute(
+          :method => request.verb, 
+          :url => request.uri.to_s, 
+          :headers => request.headers, 
+          :payload => request.body, 
+          :timeout => 10
+        )
+      end
+    end
+  end
+end

data/lib/trello/notification.rb

@@ -0,0 +1,48 @@
+module Trello
+  class Notification < BasicData
+    register_attributes :id, :unread, :type, :date, :data, :member_creator_id,
+      :read_only => [ :id, :unread, :type, :date, :member_creator_id ]
+    validates_presence_of :id, :type, :date, :member_creator_id
+
+    class << self
+      # Locate a notification by its id
+      def find(id)
+        super(:notifications, id)
+      end
+    end
+
+    def update_fields(fields)
+      attributes[:id]                = fields['id']
+      attributes[:unread]            = fields['unread']
+      attributes[:type]              = fields['type']
+      attributes[:date]              = fields['date']
+      attributes[:data]              = fields['data']
+      attributes[:member_creator_id] = fields['idMemberCreator']
+      self
+    end
+
+    alias :unread? :unread
+
+    one :member_creator, :via => Member, :using => :member_creator_id
+
+    def board
+      Client.get("/notifications/#{id}/board").json_into(Board)
+    end
+
+    def list
+      Client.get("/notifications/#{id}/list").json_into(List)
+    end
+
+    def card
+      Client.get("/notifications/#{id}/card").json_into(Card)
+    end
+
+    def member
+      Client.get("/notifications/#{id}/member").json_into(Member)
+    end
+
+    def organization
+      Client.get("/notifications/#{id}/organization").json_into(Organization)
+    end
+  end
+end

data/lib/trello/organization.rb

@@ -0,0 +1,47 @@
+module Trello
+  # Organizations are useful for linking members together.
+  class Organization < BasicData
+    register_attributes :id, :name, :display_name, :description, :url,
+      :readonly => [ :id, :name, :display_name, :description, :url ]
+    validates_presence_of :id, :name
+
+    include HasActions
+
+    class << self
+      # Find an organization by its id.
+      def find(id)
+        super(:organizations, id)
+      end
+    end
+
+    # Update the fields of an organization.
+    #
+    # Supply a hash of string keyed data retrieved from the Trello API representing
+    # an Organization.
+    def update_fields(fields)
+      attributes[:id]           = fields['id']
+      attributes[:name]         = fields['name']
+      attributes[:display_name] = fields['displayName']
+      attributes[:description]  = fields['description']
+      attributes[:url]          = fields['url']
+      self
+    end
+
+    # Returns a list of boards under this organization.
+    def boards
+      boards = Client.get("/organizations/#{id}/boards/all").json_into(Board)
+      MultiAssociation.new(self, boards).proxy
+    end
+
+    # Returns an array of members associated with the organization.
+    def members
+      members = Client.get("/organizations/#{id}/members/all").json_into(Member)
+      MultiAssociation.new(self, members).proxy
+    end
+
+    # :nodoc:
+    def request_prefix
+      "/organizations/#{id}"
+    end
+  end
+end

data/lib/trello/string.rb

@@ -0,0 +1,36 @@
+class String
+  # Decodes some JSON text in the receiver, and marshals it into a class specified
+  # in _obj_. If _obj_ is not a class, then we marshall the data into that instance
+  # via _update_fields_.
+  #
+  # For instance:
+  #
+  #   class Stuff
+  #     attr_reader :a, :b
+  #     def initialize(values)
+  #       @a = values['a']
+  #       @b = values['b']
+  #     end
+  #   end
+  #   thing = '{"a":42,"b":"foo"}'.json_into(Stuff)
+  #   thing.a == 42
+  #   thing.b == "foo"
+  def json_into(obj)
+    data = JSON.parse(self)
+    action = obj.kind_of?(Class) ? :new : :update_fields
+    if data.kind_of? Hash
+      obj.send(action, JSON.parse(self))
+    else
+      data.map { |element| obj.send(action, element) }
+    end
+  rescue JSON::ParserError => json_error
+    if json_error.message =~ /model not found/
+      Trello.logger.error "Could not find that record."
+      raise Trello::Error, "Request could not be found."
+    elsif json_error.message =~ /A JSON text must at least contain two octets/
+    else
+      Trello.logger.error "Unknown error."
+      raise
+    end
+  end
+end

data/lib/trello/token.rb

@@ -0,0 +1,24 @@
+module Trello
+  class Token < BasicData
+    register_attributes :id, :member_id, :created_at, :permissions,
+      :readonly => [ :id, :member_id, :created_at, :permissions ]
+  
+    class << self
+      # Finds a token
+      def find(token)
+        super(:tokens, token)
+      end
+    end
+
+    # :nodoc:
+    def update_fields(fields)
+      attributes[:id]          = fields['id']
+      attributes[:member_id]   = fields['idMember']
+      attributes[:created_at]  = Time.iso8601(fields['dateCreated'])
+      attributes[:permissions] = fields['permissions'] || {}
+    end
+
+    # Returns a reference to the user who authorized the token.
+    one :member, :using => :member_id
+  end
+end

data/lib/trello.rb

@@ -0,0 +1,83 @@
+require 'oauth'
+require 'json'
+require 'logger'
+require 'active_model'
+
+# Ruby wrapper around the Trello[http://trello.com] API
+#
+# First, set up your key information. You can get this information by {clicking here}[https://trello.com/1/appKey/generate].
+#
+#   include Trello
+#   include Trello::Authorization
+#   
+#   Trello::Authorization.const_set :AuthPolicy, OAuthPolicy
+#   
+#   OAuthPolicy.consumer_credential = OAuthCredential.new 'PUBLIC_KEY', 'SECRET'
+#
+# You can get the key by going to this url in your browser:
+# https://trello.com/1/connect?key=PUBLIC_KEY_FROM_ABOVE&name=MyApp&response_type=token&scope=read,write,account&expiration=never
+# Only request the permissions you need; i.e., scope=read if you only need read, or scope=write if you only need write. Comma separate scopes you need.
+# If you want your token to expire after 30 days, drop the &expiration=never. Then run the following code, where KEY denotes the key returned from the
+# url above:
+#
+#   OAuthPolicy.token = OAuthCredential.new 'KEY', nil
+#
+# All the calls this library make to Trello require authentication using these keys. Be sure to protect them.
+#
+# So lets say you want to get information about the user *bobtester*. We can do something like this:
+#
+#   bob = Member.find("bobtester")
+#   # Print out his name
+#   puts bob.full_name # "Bob Tester"
+#   # Print his bio
+#   puts bob.bio # A wonderfully delightful test user
+#   # How about a list of his boards?
+#   bob.boards
+#
+# And so much more. Consult the rest of the documentation for more information.
+#
+# Feel free to {peruse and participate in our Trello board}[https://trello.com/board/ruby-trello/4f092b2ee23cb6fe6d1aaabd]. It's completely open to the public.
+module Trello
+  autoload :Action,            'trello/action'
+  autoload :Association,       'trello/association'
+  autoload :AssociationProxy,  'trello/association_proxy'
+  autoload :BasicData,         'trello/basic_data'
+  autoload :Board,             'trello/board'
+  autoload :Card,              'trello/card'
+  autoload :Checklist,         'trello/checklist'
+  autoload :Client,            'trello/client'
+  autoload :HasActions,        'trello/has_actions'
+  autoload :Item,              'trello/item'
+  autoload :ItemState,         'trello/item_state'
+  autoload :Label,             'trello/label'
+  autoload :List,              'trello/list'
+  autoload :Member,            'trello/member'
+  autoload :MultiAssociation,  'trello/multi_association'
+  autoload :Notification,      'trello/notification'
+  autoload :Organization,      'trello/organization'
+  autoload :Request,           'trello/net'
+  autoload :TInternet,         'trello/net'
+  autoload :Token,             'trello/token'
+
+  module Authorization
+    autoload :AuthPolicy,      'trello/authorization'
+    autoload :BasicAuthPolicy, 'trello/authorization'
+    autoload :OAuthPolicy,     'trello/authorization'
+  end
+
+  # Version of the Trello API that we use by default.
+  API_VERSION = 1
+
+  # Raise this when we hit a Trello error.
+  class Error < StandardError; end
+  # This specific error is thrown when your access token is invalid. You should get a new one.
+  class InvalidAccessToken < StandardError; end
+
+  def self.logger
+    @logger ||= Logger.new(STDOUT)
+  end
+
+  def self.logger=(logger)
+    @logger = logger
+  end
+end

data/spec/action_spec.rb

@@ -0,0 +1,71 @@
+require 'spec_helper'
+
+module Trello
+  describe Action do
+    include Helpers
+
+    before(:each) do
+      Client.stub(:get).with("/actions/4ee2482134a81a757a08af47").
+        and_return JSON.generate(actions_details.first)
+
+      @action = Action.find('4ee2482134a81a757a08af47')
+    end
+
+    context "fields" do
+      before(:all) do
+        @detail = actions_details.first
+      end
+
+      it "gets its id" do
+        @action.id.should == @detail['id']
+      end
+
+      it "gets its type" do
+        @action.type.should == @detail['type']
+      end
+
+      it "has the same data" do
+        @action.data.should == @detail['data']
+      end
+
+      it "gets the date" do
+        @action.date.utc.iso8601.should == @detail['date']
+      end
+    end
+
+    context "boards" do
+      it "has a board" do
+        Client.stub(:get).with("/actions/4ee2482134a81a757a08af47/board").
+          and_return JSON.generate(boards_details.first)
+
+        @action.board.should_not be_nil
+      end
+    end
+
+    context "card" do
+      it "has a card" do
+        Client.stub(:get).with("/actions/4ee2482134a81a757a08af47/card").
+          and_return JSON.generate(cards_details.first)
+        
+        @action.card.should_not be_nil
+      end
+    end
+
+    context "list" do
+      it "has a list of lists" do
+        Client.stub(:get).with("/actions/4ee2482134a81a757a08af47/list").
+          and_return JSON.generate(lists_details.first)
+
+        @action.list.should_not be_nil
+      end
+    end
+
+    context "member creator" do
+      it "knows its member creator" do
+        Client.stub(:get).with("/members/abcdef123456789123456789").and_return user_payload
+
+        @action.member_creator.should_not be_nil
+      end
+    end
+  end
+end