ruby-trello-czuger 2.0.0

data/lib/trello/multi_association.rb

@@ -0,0 +1,12 @@
+module Trello
+  class MultiAssociation < Association
+    extend Forwardable
+
+    def_delegator :target, :count
+
+    def initialize(owner, target = [])
+      super
+      @proxy = AssociationProxy.new(self)
+    end
+  end
+end

data/lib/trello/net.rb

@@ -0,0 +1,39 @@
+module Trello
+  Request = Struct.new "Request", :verb, :uri, :headers, :body
+  Response = Struct.new "Response", :code, :headers, :body
+
+  class TInternet
+    class << self
+      require "rest_client"
+
+      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 RestClient::Exception => e
+          raise if !e.respond_to?(:http_code) || e.http_code.nil?
+          Response.new(e.http_code, {}, e.http_body)
+        end
+      end
+
+      def execute_core(request)
+        RestClient.proxy = ENV['HTTP_PROXY'] if ENV['HTTP_PROXY']
+        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,61 @@
+module Trello
+
+  # @!attribute [r] id
+  #   @return [String]
+  # @!attribute [rw] unread
+  #   @return [Boolean]
+  # @!attribute [r] type
+  #   @return [Object]
+  # @!attribute [r] date
+  #   @return [Datetime]
+  # @!attribute [rw] data
+  #   @return [Object]
+  # @!attribute [r] member_creator_id,
+  #   @return [String]
+  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, params = {})
+        client.find(:notification, id, params)
+      end
+    end
+
+    def update_fields(fields)
+      attributes[:id]                = fields['id'] || attributes[:id]
+      attributes[:unread]            = fields['unread'] if fields.has_key?('unread')
+      attributes[:type]              = fields['type'] || attributes[:type]
+      attributes[:date]              = fields['date'] || attributes[:date]
+      attributes[:data]              = fields['data'] || attributes[:data]
+      attributes[:member_creator_id] = fields['idMemberCreator'] || attributes[:member_creator_id]
+      self
+    end
+
+    alias :unread? :unread
+
+    one :member_creator, path: :members, via: Member, using: :member_creator_id
+
+    def board
+      Board.from_response client.get("/notifications/#{id}/board")
+    end
+
+    def list
+      List.from_response client.get("/notifications/#{id}/list")
+    end
+
+    def card
+      Card.from_response client.get("/notifications/#{id}/card")
+    end
+
+    def member
+      Member.from_response client.get("/notifications/#{id}/member")
+    end
+
+    def organization
+      Organization.from_response client.get("/notifications/#{id}/organization")
+    end
+  end
+end

data/lib/trello/organization.rb

@@ -0,0 +1,68 @@
+module Trello
+  # Organizations are useful for linking members together.
+  #
+  # @!attribute [r] id
+  #   @return [String]
+  # @!attribute [r] name
+  #   @return [String]
+  # @!attribute [r] display_name
+  #   @return [String]
+  # @!attribute [r] description
+  #   @return [String]
+  # @!attribute [r] url
+  #   @return [String]
+  class Organization < BasicData
+    register_attributes :id, :name, :display_name, :description, :url, :invited,
+      :website, :logo_hash, :billable_member_count, :active_billable_member_count,
+      :memberships,
+      readonly: [ :id, :name, :display_name, :description, :url, :invited,
+        :website, :logo_hash, :billable_member_count, :active_billable_member_count,
+        :memberships ]
+    validates_presence_of :id, :name
+
+    include HasActions
+
+    class << self
+      # Find an organization by its id.
+      def find(id, params = {})
+        client.find(:organization, id, params)
+      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[:id]
+      attributes[:name]                         = fields['name'] || attributes[:name]
+      attributes[:display_name]                 = fields['displayName'] || attributes[:display_name]
+      attributes[:description]                  = fields['desc'] || attributes[:description]
+      attributes[:url]                          = fields['url'] || attributes[:url]
+      attributes[:invited]                      = fields['invited'] if fields.has_key?('invited')
+      attributes[:website]                      = fields['website'] || attributes[:website]
+      attributes[:logo_hash]                    = fields['logoHash'] || attributes[:logo_hash]
+      attributes[:billable_member_count]        = fields['billableMemberCount'] || attributes[:billable_member_count]
+      attributes[:active_billable_member_count] = fields['activeBillableMemberCount'] || attributes[:active_billable_member_count]
+      attributes[:memberships]                  = fields['memberships'] || attributes[:memberships]
+      self
+    end
+
+    # Returns a list of boards under this organization.
+    def boards
+      boards = Board.from_response client.get("/organizations/#{id}/boards/all")
+      MultiAssociation.new(self, boards).proxy
+    end
+
+    # Returns an array of members associated with the organization.
+    def members(params = {})
+      members = Member.from_response client.get("/organizations/#{id}/members/all", params)
+      MultiAssociation.new(self, members).proxy
+    end
+
+    # :nodoc:
+    def request_prefix
+      "/organizations/#{id}"
+    end
+  end
+end

data/lib/trello/plugin_datum.rb

@@ -0,0 +1,34 @@
+module Trello
+  # A file or url that is linked to a Trello card
+  #
+  # @!attribute id
+  #   @return [String]
+  # @!attribute idPlugin
+  #   @return [String]
+  # @!attribute scope
+  #   @return [String]
+  # @!attribute idModel
+  #   @return [String]
+  # @!attribute value
+  #   @return [String]
+  # @!attribute access
+  #   @return [String]
+    class PluginDatum < BasicData
+    # Update the fields of a plugin.
+    register_attributes :id, :idPlugin, :scope, :idModel, :value, :access
+
+
+    # Supply a hash of stringkeyed data retrieved from the Trello API representing
+    # an attachment.
+    def update_fields(fields)
+      attributes[:id]        = fields['id'] || attributes[:id]
+      attributes[:idPlugin]  = fields['idPlugin'] || attributes[:idPlugin]
+      attributes[:scope]     = fields['scope'] || attributes[:scope]
+      attributes[:value]     = JSON.parse(fields['value']).presence if fields.has_key?('value')
+      attributes[:idModel]   = fields['idModel'] || attributes[:idModel]
+      attributes[:access]    = fields['access'] || attributes[:access]
+      self
+    end
+  end
+
+end

data/lib/trello/token.rb

@@ -0,0 +1,37 @@
+module Trello
+
+  # @!attribute [r] id
+  #   @return [String]
+  # @!attribute [r] member_id
+  #   @return [String]
+  # @!attribute [r] created_at
+  #   @return [Datetime]
+  # @!attribute [r] permissions
+  #   @return [Object]
+  # @!attribute [r] webhooks
+  #   @return [Object]
+  class Token < BasicData
+    register_attributes :id, :member_id, :created_at, :permissions, :webhooks,
+      readonly: [ :id, :member_id, :created_at, :permissions, :webhooks ]
+
+    class << self
+      # Finds a token
+      def find(token, params = {webhooks: true})
+        client.find(:token, token, params)
+      end
+    end
+
+    # :nodoc:
+    def update_fields(fields)
+      attributes[:id]          = fields['id'] || attributes[:id]
+      attributes[:member_id]   = fields['idMember'] || attributes[:member_id]
+      attributes[:created_at]  = Time.iso8601(fields['dateCreated']) rescue nil if fields.has_key?('dateCreated')
+      attributes[:permissions] = fields['permissions'] || attributes[:permissions]
+      attributes[:permissions] ||= {}
+      attributes[:webhooks]    = fields['webhooks'] || attributes[:webhooks]
+    end
+
+    # Returns a reference to the user who authorized the token.
+    one :member, path: :members, using: :member_id
+  end
+end

data/lib/trello/webhook.rb

@@ -0,0 +1,103 @@
+module Trello
+  # A webhook is a URL called each time a specified model is updated
+  #
+  # @!attribute [r] id
+  #   @return [String]
+  # @!attribute [r] description
+  #   @return [String]
+  # @!attribute [r] id_model
+  #   @return [String] A 24-character hex string
+  # @!attribute [r] callback_url
+  #   @return [String]
+  # @!attribute [r] active
+  #   @return [Boolean]
+  class Webhook < BasicData
+    register_attributes :id, :description, :id_model, :callback_url, :active,
+      readonly: [ :id ]
+    validates_presence_of :id, :id_model, :callback_url
+    validates_length_of   :description,  in: 1..16384
+
+    class << self
+      # Find a specific webhook by its ID.
+      #
+      # @raise [Trello::Error] if a Webhook with the given ID can't be found.
+      # @return [Trello::Webhook] the Webhook with the given ID.
+      def find(id, params = {})
+        client.find(:webhook, id, params)
+      end
+
+      # Create a new webhook and save it to Trello.
+      #
+      # @param [Hash] options
+      #
+      # @option options [String] :description (optional) A string with a length from 0 to 16384
+      # @option options [String] :callback_url (required) A valid URL that is
+      #    reachable with a HEAD request
+      # @option options [String] :id_model (required) id of the model that should be hooked
+      #
+      # @raise [Trello::Error] if the Webhook could not be created.
+      #
+      # @return [Trello::Webhook]
+      def create(options)
+        client.create(:webhook,
+            'description' => options[:description],
+            'idModel'     => options[:id_model],
+            'callbackURL' => options[:callback_url])
+      end
+    end
+
+    # @return [Trello::Webhook] self
+    def update_fields(fields)
+      attributes[:id]              = fields['id'] || attributes[:id]
+      attributes[:description]     = fields['description'] || fields[:description] || attributes[:description]
+      attributes[:id_model]        = fields['idModel'] || fields[:id_model] || attributes[:id_model]
+      attributes[:callback_url]    = fields['callbackURL'] || fields[:callback_url] || attributes[:callback_url]
+      attributes[:active]          = fields['active'] if fields.has_key?('active')
+      self
+    end
+
+    # Save the webhook.
+    #
+    # @raise  [Trello::Error] if the Webhook could not be saved.
+    #
+    # @return [String] the JSON representation of the saved webhook.
+    def save
+      # If we have an id, just update our fields.
+      return update! if id
+
+      from_response client.post("/webhooks", {
+        description: description,
+        idModel: id_model,
+        callbackURL: callback_url
+      })
+    end
+
+    # Update the webhook.
+    #
+    # @raise  [Trello::Error] if the Webhook could not be saved.
+    #
+    # @return [String] the JSON representation of the updated webhook.
+    def update!
+      client.put("/webhooks/#{id}", {
+        description: description,
+        idModel: id_model,
+        callbackURL: callback_url,
+        active: active
+      })
+    end
+
+    # Delete this webhook
+    #
+    # @return [String] the JSON response from the Trello API
+    def delete
+      client.delete("/webhooks/#{id}")
+    end
+
+    # Check if the webhook is activated
+    #
+    # @return [Boolean]
+    def activated?
+      active
+    end
+  end
+end

data/spec/action_spec.rb

@@ -0,0 +1,149 @@
+require 'spec_helper'
+
+module Trello
+  describe Action do
+    include Helpers
+
+    let(:client)  { Client.new }
+    let(:action)  { client.find(:action, '4ee2482134a81a757a08af47') }
+
+    before do
+      allow(client)
+        .to receive(:get)
+        .with('/actions/4ee2482134a81a757a08af47', {})
+        .and_return JSON.generate(actions_details.first)
+    end
+
+    context 'finding' do
+      let(:client) { Trello.client }
+
+      it 'delegates to Trello.client#find' do
+        expect(client)
+          .to receive(:find)
+          .with(:action, '4ee2482134a81a757a08af47', {})
+
+        Action.find('4ee2482134a81a757a08af47')
+      end
+
+      it do
+        expect(Action.find('4ee2482134a81a757a08af47')).to eq(action)
+      end
+    end
+
+    context 'search' do
+      let(:client) { Trello.client }
+      let(:payload) { JSON.generate({ "cards" => cards_details }) }
+
+      it "searches and get back a card object" do
+        expect(client)
+          .to receive(:get)
+          .with("/search/", { query: "something"})
+          .and_return payload
+
+        expect(Action.search("something"))
+          .to eq({ "cards" => cards_details.jsoned_into(Card) })
+      end
+    end
+
+    context 'fields' do
+      let(:detail) { actions_details.first }
+
+      it 'gets its id' do
+        expect(action.id).to eq detail['id']
+      end
+
+      it 'gets its type' do
+        expect(action.type).to eq detail['type']
+      end
+
+      it 'has the same data' do
+        expect(action.data).to eq detail['data']
+      end
+
+      it 'gets the date' do
+        expect(action.date.utc.iso8601).to eq detail['date']
+      end
+    end
+
+    context 'boards' do
+      let(:payload) { JSON.generate(boards_details.first) }
+
+      before do
+        allow(client)
+          .to receive(:get)
+          .with('/actions/4ee2482134a81a757a08af47/board')
+          .and_return payload
+      end
+
+      it 'has a board' do
+        expect(action.board).to_not be_nil
+      end
+    end
+
+
+    context 'card' do
+      let(:payload) { JSON.generate(cards_details.first) }
+
+      before do
+        allow(client)
+          .to receive(:get)
+          .with('/actions/4ee2482134a81a757a08af47/card')
+          .and_return payload
+      end
+
+      it 'has a card' do
+        expect(action.card).to_not be_nil
+      end
+    end
+
+    context 'list' do
+      let(:payload) { JSON.generate(lists_details.first) }
+
+      before do
+        allow(client)
+          .to receive(:get)
+          .with('/actions/4ee2482134a81a757a08af47/list')
+          .and_return payload
+      end
+
+      it 'has a list of lists' do
+        expect(action.list).to_not be_nil
+      end
+    end
+
+    context 'member creator' do
+
+      before do
+        allow(client)
+          .to receive(:get)
+          .with('/members/abcdef123456789123456789', {})
+          .and_return user_payload
+      end
+
+      it 'knows its member creator' do
+        expect(action.member_creator).to_not be_nil
+      end
+    end
+
+    describe "#update_fields" do
+      it "does not set any fields when the fields argument is empty" do
+        expected = {
+          'id' => 'id',
+          'type' => 'type',
+          'data' => 'data',
+          'idMemberCreator' => 'member_creator_id',
+          'member' => 'member_participant'
+        }
+
+        action = Action.new(expected)
+        action.client = client
+
+        action.update_fields({})
+
+        expected.each do |key, value|
+          expect(action.send(value)).to eq expected[key]
+        end
+      end
+    end
+  end
+end