ruby-trello-czuger 2.0.0

data/lib/trello/checklist.rb

@@ -0,0 +1,143 @@
+module Trello
+  # A Checklist holds items which are like a "task" list. Checklists are linked to a card.
+  #
+  # @!attribute [r] id
+  #   @return [String]
+  # @!attribute [rw] name
+  #   @return [String]
+  # @!attribute [r] description
+  #   @return [String]
+  # @!attribute [r] closed
+  #   @return [Boolean]
+  # @!attribute [rw] position
+  #   @return [Object]
+  # @!attribute [r] url
+  #   @return [String]
+  # @!attribute [r] check_items
+  #   @return [Object]
+  # @!attribute [r] board_id
+  #   @return [String] A 24-character hex string
+  # @!attribute [r] list_id
+  #   @return [String] A 24-character hex string
+  # @!attribute [r] member_ids
+  #   @return [Array<String>] An array of 24-character hex strings
+  class Checklist < BasicData
+    register_attributes :id, :name, :description, :closed, :position, :url, :check_items, :board_id, :list_id, :card_id, :member_ids,
+                        readonly: [:id, :description, :closed, :url, :check_items, :board_id, :list_id, :card_id, :member_ids]
+    validates_presence_of :id, :board_id, :list_id
+    validates_length_of :name, in: 1..16384
+
+    class << self
+      # Locate a specific checklist by its id.
+      def find(id, params = {})
+        client.find(:checklist, id, params)
+      end
+
+      def create(options)
+        client.create(:checklist,
+                      'name' => options[:name],
+                      'idCard'  => options[:card_id])
+      end
+    end
+
+    # Update the fields of a checklist.
+    #
+    # Supply a hash of string keyed data retrieved from the Trello API representing
+    # a checklist.
+    def update_fields(fields)
+      attributes[:id] = fields['id'] || attributes[:id]
+      attributes[:name] = fields['name'] || fields[:name] || attributes[:name]
+      attributes[:description] = fields['desc'] || attributes[:description]
+      attributes[:closed] = fields['closed'] if fields.has_key?('closed')
+      attributes[:url] = fields['url'] || attributes[:url]
+      attributes[:check_items] = fields['checkItems'] if fields.has_key?('checkItems')
+      attributes[:position] = fields['pos'] || attributes[:position]
+      attributes[:board_id] = fields['idBoard'] || attributes[:board_id]
+      attributes[:card_id] = fields['idCard'] || fields[:card_id] || attributes[:card_id]
+      attributes[:list_id] = fields['idList'] || attributes[:list_id]
+      attributes[:member_ids] = fields['idMembers'] || attributes[:member_ids]
+      self
+    end
+
+    # Check if the checklist is currently active.
+    def closed?
+      closed
+    end
+
+    # Save a record.
+    def save
+      return update! if id
+
+      from_response(client.post("/checklists", {
+        name: name,
+        idCard: card_id
+      }))
+    end
+
+    def update!
+      from_response(client.put("/checklists/#{id}", {name: name, pos: position}))
+    end
+
+    # Return a list of items on the checklist.
+    def items
+      check_items.map do |item_fields|
+        Item.new(item_fields)
+      end
+    end
+
+    # Return a reference to the board the checklist is on.
+    one :board, path: :checklists, using: :board_id
+
+    # Return a reference to the card the checklist is on.
+    one :card, path: :checklists, using: :card_id
+
+    # Return a reference to the list the checklist is on.
+    one :list, path: :lists, using: :list_id
+
+    # Return a list of members active in this checklist.
+    def members
+      members = member_ids.map do |member_id|
+        Member.find(member_id)
+      end
+      MultiAssociation.new(self, members).proxy
+    end
+
+    # Add an item to the checklist
+    def add_item(name, checked = false, position = 'bottom')
+      client.post("/checklists/#{id}/checkItems", {name: name, checked: checked, pos: position})
+    end
+
+    # Update a checklist item's state, e.g.: "complete" or "incomplete"
+    def update_item_state(item_id, state)
+      state = ( state ? 'complete' : 'incomplete' ) unless state.is_a?(String)
+      client.put(
+          "/cards/#{card_id}/checkItem/#{item_id}",
+          state: state
+      )
+    end
+
+    # Delete a checklist item
+    def delete_checklist_item(item_id)
+      client.delete("/checklists/#{id}/checkItems/#{item_id}")
+    end
+
+    # Delete a checklist
+    def delete
+      client.delete("/checklists/#{id}")
+    end
+
+    # Copy a checklist (i.e., same attributes, items, etc.)
+    def copy
+      checklist_copy = self.class.create(name: self.name, board_id: self.board_id, card_id: self.card_id)
+      copy_items_to(checklist_copy)
+      return checklist_copy
+    end
+
+    private
+    def copy_items_to(another_checklist)
+      items.each do |item|
+        another_checklist.add_item(item.name, item.complete?)
+      end
+    end
+  end
+end

data/lib/trello/client.rb

@@ -0,0 +1,120 @@
+require 'addressable/uri'
+require 'forwardable'
+require 'active_support/inflector'
+
+module Trello
+  class Client
+    extend Forwardable
+    include Authorization
+
+    def_delegators :configuration, :credentials, *Configuration.configurable_attributes
+
+    def initialize(attrs = {})
+      self.configuration.attributes = attrs
+    end
+
+    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
+
+    # Finds given resource by id
+    #
+    # Examples:
+    #   client.find(:board, "board1234")
+    #   client.find(:member, "user1234")
+    #
+    def find(path, id, params = {})
+      response = get("/#{path.to_s.pluralize}/#{id}", params)
+      trello_class = class_from_path(path)
+      trello_class.parse response do |data|
+        data.client = self
+      end
+    end
+
+    # Finds given resource by path with params
+    def find_many(trello_class, path, params = {})
+      response = get(path, params)
+      trello_class.parse_many response do |data|
+        data.client = self
+      end
+    end
+
+    # Creates resource with given options (attributes)
+    #
+    # Examples:
+    #   client.create(:member, options)
+    #   client.create(:board, options)
+    #
+    def create(path, options)
+      trello_class = class_from_path(path)
+      trello_class.save options do |data|
+        data.client = self
+      end
+    end
+
+    def configure
+      yield configuration if block_given?
+    end
+
+    def configuration
+      @configuration ||= Configuration.new
+    end
+
+    def auth_policy
+      @auth_policy ||= auth_policy_class.new(credentials)
+    end
+
+    private
+
+    def invoke_verb(name, uri, body = nil)
+      request = Request.new name, uri, {}, body
+      response = TInternet.execute auth_policy.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
+
+    def auth_policy_class
+      if configuration.oauth?
+        OAuthPolicy
+      elsif configuration.basic?
+        BasicAuthPolicy
+      else
+        AuthPolicy
+      end
+    end
+
+    def class_from_path(path_or_class)
+      return path_or_class if path_or_class.is_a?(Class)
+      Trello.const_get(path_or_class.to_s.singularize.camelize)
+    end
+  end
+end

data/lib/trello/comment.rb

@@ -0,0 +1,62 @@
+module Trello
+  # A Comment is a string with a creation date; it resides inside a Card and belongs to a User.
+  #
+  # @!attribute [r] action_id
+  #   @return [String]
+  # @!attribute [r] text
+  #   @return [String]
+  # @!attribute [r] date
+  #   @return [Datetime]
+  # @!attribute [r] member_creator_id
+  #   @return [String]
+  class Comment < BasicData
+    register_attributes :action_id, :text, :date, :member_creator_id,
+      readonly: [ :action_id, :text, :date, :member_creator_id ]
+    validates_presence_of :action_id, :text, :date, :member_creator_id
+    validates_length_of   :text,        in: 1..16384
+
+    class << self
+      # Locate a specific action and return a new Comment object.
+      def find(action_id)
+        client.find(:action, action_id, filter: commentCard)
+      end
+    end
+
+    # Update the attributes of a Comment
+    #
+    # Supply a hash of string keyed data retrieved from the Trello API representing
+    # a Comment.
+    def update_fields(fields)
+      attributes[:action_id]          = fields['id'] || attributes[:action_id]
+      attributes[:text]               = fields['data']['text'] || attributes[:text]
+      attributes[:date]               = Time.iso8601(fields['date']) if fields.has_key?('date')
+      attributes[:member_creator_id]  = fields['idMemberCreator'] || attributes[:member_creator_id]
+      self
+    end
+
+    # Returns the board this comment is located
+    def board
+      Board.from_response client.get("/actions/#{action_id}/board")
+    end
+
+    # Returns the card the comment is located
+    def card
+      Card.from_response client.get("/actions/#{action_id}/card")
+    end
+
+    # Returns the list the comment is located
+    def list
+      List.from_response client.get("/actions/#{action_id}/list")
+    end
+
+    # Deletes the comment from the card
+    def delete
+      ruta = "/actions/#{action_id}"
+      client.delete(ruta)
+    end
+
+
+    # Returns the member who created the comment.
+    one :member_creator, via: Member, path: :members, using: :member_creator_id
+  end
+end

data/lib/trello/configuration.rb

@@ -0,0 +1,68 @@
+module Trello
+  class Configuration
+    CONFIGURABLE_ATTRIBUTES = [
+      :developer_public_key,
+      :member_token,
+      :consumer_key,
+      :consumer_secret,
+      :oauth_token,
+      :oauth_token_secret,
+      :callback,
+      :return_url
+    ]
+
+    attr_accessor *CONFIGURABLE_ATTRIBUTES
+
+    def self.configurable_attributes
+      CONFIGURABLE_ATTRIBUTES
+    end
+
+    def initialize(attrs = {})
+      self.attributes = attrs
+    end
+
+    def attributes=(attrs = {})
+      attrs.each { |key, value| instance_variable_set("@#{key}", value) }
+    end
+
+    def credentials
+      case
+      when oauth?
+        oauth_credentials
+      when basic?
+        basic_credentials
+      else
+        {}
+      end
+    end
+
+    def oauth?
+      consumer_key && consumer_secret
+    end
+
+    def basic?
+      developer_public_key && member_token
+    end
+
+    private
+
+    def oauth_credentials
+      {
+        consumer_key: consumer_key,
+        consumer_secret: consumer_secret,
+        oauth_token: oauth_token,
+        oauth_token_secret: oauth_token_secret,
+        return_url: return_url,
+        callback: callback,
+      }.delete_if { |key, value| value.nil? }
+    end
+
+    def basic_credentials
+      {
+        developer_public_key: developer_public_key,
+        member_token: member_token
+      }
+    end
+
+  end
+end

data/lib/trello/core_ext/array.rb

@@ -0,0 +1,6 @@
+warn "Use of trello/core_ext/array is deprecated. Use Trello::JsonUtils instead"
+class Array
+  def jsoned_into(obj)
+    obj.from_json(self)
+  end
+end

data/lib/trello/core_ext/hash.rb

@@ -0,0 +1,6 @@
+warn "Use of trello/core_ext/hash is deprecated. Use Trello::JsonUtils instead"
+class Hash
+  def jsoned_into(obj)
+    obj.from_json(self)
+  end
+end

data/lib/trello/core_ext/string.rb

@@ -0,0 +1,6 @@
+warn "Use of trello/core_ext/string is deprecated. Use Trello::JsonUtils instead"
+class String
+  def json_into(obj, encoding = 'UTF-8')
+    obj.from_response(self, encoding)
+  end
+end

data/lib/trello/cover_image.rb

@@ -0,0 +1,8 @@
+module Trello
+  # The trello cover image
+  #
+  # This is normally an attachment that the user (or trello) has set
+  # as the cover image
+  class CoverImage < Attachment
+  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 = Action.from_response client.get("#{request_prefix}/actions", { filter: :all }.merge(options))
+      MultiAssociation.new(self, actions).proxy
+    end
+  end
+end

data/lib/trello/item.rb

@@ -0,0 +1,37 @@
+module Trello
+  # An Item is a basic task that can be checked off and marked as completed.
+  #
+  # @!attribute [r] id
+  #   @return [String]
+  # @!attribute [r] name
+  #   @return [String]
+  # @!attribute [r] type
+  #   @return [Object]
+  # @!attribute [r] state
+  #   @return [Object]
+  # @!attribute [r] pos
+  #   @return [Object]
+  class Item < BasicData
+    register_attributes :id, :name, :type, :state, :pos, readonly: [ :id, :name, :type, :state, :pos ]
+    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[:id]
+      attributes[:card_id]      = fields['idCard'] || attributes[:card_id]
+      attributes[:checklist_id] = fields['idChecklist'] || attributes[:checklist_id]
+      attributes[:name]         = fields['name'] || attributes[:name]
+      attributes[:type]         = fields['type'] || attributes[:type]
+      attributes[:state]        = fields['state'] || attributes[:state]
+      attributes[:pos]          = fields['pos'] || attributes[:pos]
+      self
+    end
+
+    def complete?
+      state == "complete"
+    end
+  end
+end