assembla_api 0.1.2

data/lib/assembla_api/client/spaces/standup_away_reports.rb

@@ -0,0 +1,41 @@
+module Assembla
+  class Client::Spaces::StandupAwayReports < API
+
+    VALID_PARAMS_NAMES = %w[
+      what_i_did
+      what_i_will_do
+      roadblocks
+      filled_for
+    ]
+
+    # @example
+    # api.spaces.standup_away_reports.create 'project1', standup_report: { what_i_will_do: 'Work on #400' }
+    def create(*args)
+      arguments(args, required: [:space]) do
+        permit VALID_PARAMS_NAMES, recursive: true
+      end
+
+      post_request("/spaces/#{arguments.space}/away_standup_report", arguments.params)
+    end
+    alias :edit :create
+
+    # @example
+    # api.spaces.standup_away_reports.my 'project1', date: '2014-09-09'
+    def my(*args)
+      arguments(args, required: [:space]) do
+        permit VALID_PARAMS_NAMES + ['date'], recursive: true
+      end
+
+      get_request("/spaces/#{arguments.space}/away_standup_report", arguments.params)
+    end
+
+    # @example
+    # api.spaces.standup_away_reports.list 'project1'
+    def list(*args)
+      arguments(args, required: [:space])
+      response = get_request("/spaces/#{arguments.space}/away_standup_reports", arguments.params)
+      return response unless block_given?
+      response.each { |el| yield el }
+    end
+  end
+end

data/lib/assembla_api/client/spaces/standup_reports.rb

@@ -0,0 +1,41 @@
+module Assembla
+  class Client::Spaces::StandupReports < API
+
+    VALID_PARAMS_NAMES = %w[
+      what_i_did
+      what_i_will_do
+      roadblocks
+      filled_for
+    ]
+
+    # @example
+    # api.spaces.standup_reports.create 'project1', standup_report: { what_i_will_do: 'Work on #400' }
+    def create(*args)
+      arguments(args, required: [:space]) do
+        permit VALID_PARAMS_NAMES, recursive: true
+      end
+
+      post_request("/spaces/#{arguments.space}/standup_report", arguments.params)
+    end
+    alias :edit :create
+
+    # @example
+    # api.spaces.standup_reports.my 'project1'
+    def my(*args)
+      arguments(args, required: [:space]) do
+        permit VALID_PARAMS_NAMES, recursive: true
+      end
+
+      get_request("/spaces/#{arguments.space}/standup_report", arguments.params)
+    end
+
+    # @example
+    # api.spaces.standup_reports.list 'project1'
+    def list(*args)
+      arguments(args, required: [:space])
+      response = get_request("/spaces/#{arguments.space}/standup_reports", arguments.params)
+      return response unless block_given?
+      response.each { |el| yield el }
+    end
+  end
+end

data/lib/assembla_api/client/spaces/tags.rb

@@ -0,0 +1,96 @@
+module Assembla
+  class Client::Spaces::Tags < API
+
+    VALID_PARAMS_NAMES = %w[
+      name
+      state
+    ].freeze
+
+    VALID_REQUEST_PARAM_VALUES = {
+      'state' => [ 1, 2, 4 ]
+    }
+
+    # @example
+    # api.spaces.tags.create 'project1', tag: { name: 'Backend' }
+    def create(*args)
+      arguments(args, required: [:space]) do
+        permit VALID_PARAMS_NAMES, recursive: true
+        assert_required %w[ name ]
+        assert_values VALID_REQUEST_PARAM_VALUES
+      end
+
+      post_request("/spaces/#{arguments.space}/tags", arguments.params)
+    end
+
+    # @example
+    # api.spaces.tags.get 'project1', 'tag-id'
+    def get(*args)
+      arguments(args, required: [:space, :id])
+      get_request("/spaces/#{arguments.space}/tags/#{arguments.id}", arguments.params)
+    end
+
+    # @example
+    # api.spaces.tags.edit 'project1', 'tag-id', tag: { state: 4 }
+    def edit(*args)
+      arguments(args, required: [:space, :id]) do
+        permit VALID_PARAMS_NAMES , recursive: true
+        assert_values VALID_REQUEST_PARAM_VALUES
+      end
+
+      put_request("/spaces/#{arguments.space}/tags/#{arguments.id}", arguments.params)
+    end
+
+    # Delete tag by ID
+    # @example
+    # api.spaces.tags.delete 'project1', 'tag-id'
+    def delete(*args)
+      arguments(args, required: [:space, :id])
+      delete_request("/spaces/#{arguments.space}/tags/#{arguments.id}", arguments.params)
+    end
+
+    # @example
+    # api.spaces.tags.list 'project1'
+    def list(*args)
+      arguments(args, required: [:space])
+      response = get_request("/spaces/#{arguments.space}/tags", arguments.params)
+      return response unless block_given?
+      response.each { |el| yield el }
+    end
+
+    # @example
+    # api.spaces.tags.active 'project1'
+    def active(*args)
+      arguments(args, required: [:space])
+      response = get_request("/spaces/#{arguments.space}/tags/active", arguments.params)
+      return response unless block_given?
+      response.each { |el| yield el }
+    end
+
+    # @example
+    # api.spaces.tags.proposed 'project1'
+    def proposed(*args)
+      arguments(args, required: [:space])
+      response = get_request("/spaces/#{arguments.space}/tags/proposed", arguments.params)
+      return response unless block_given?
+      response.each { |el| yield el }
+    end
+
+    # @example
+    # api.spaces.tags.hidden 'project1'
+    def hidden(*args)
+      arguments(args, required: [:space])
+      response = get_request("/spaces/#{arguments.space}/tags/hidden", arguments.params)
+      return response unless block_given?
+      response.each { |el| yield el }
+    end
+
+    # @example
+    # api.spaces.tags.tickets 'project1', 'tag-id'
+    def tickets(*args)
+      arguments(args, required: [:space, :id])
+      response = get_request("/spaces/#{arguments.space}/tags/#{arguments.id}/tickets", arguments.params)
+      return response unless block_given?
+      response.each { |el| yield el }
+    end
+  end # tags
+end

data/lib/assembla_api/client/spaces/tickets.rb

@@ -0,0 +1,154 @@
+module Assembla
+  class Client::Spaces::Tickets < API
+    require_all 'assembla_api/client/spaces/tickets',
+      'custom_fields',
+      'associations',
+      'comments',
+      'statuses'
+
+    # Access to Spaces::Tickets::Statuses API
+    namespace :statuses
+    namespace :custom_fields
+    namespace :associations
+    namespace :comments
+
+    VALID_PARAMS_NAMES = %w[
+      summary
+      description
+      priority
+      component_id
+      created_on
+      permission_type
+      is_story
+      milestone_id
+      tags
+      followers
+      notification_list
+      status
+      story_importance
+      working_hours
+      estimate
+      assigned_to_id
+      custom_fields
+      hierarchy_type
+      is_support
+    ].freeze
+
+    # @example
+    # api.spaces.tickets.create 'project1', ticket: { summary: 'First ticket' }
+    def create(*args)
+      arguments(args, required: [:space]) do
+        permit VALID_PARAMS_NAMES, recursive: true
+        assert_required %w[ summary ]
+        # TODO assert_values VALID_REQUEST_PARAM_VALUES
+      end
+
+      post_request("/spaces/#{arguments.space}/tickets", arguments.params)
+    end
+
+    # @example
+    # api.spaces.tickets.get 'project1', 7
+    def get(*args)
+      arguments(args, required: [:space, :number])
+      get_request("/spaces/#{arguments.space}/tickets/#{arguments.number}", arguments.params)
+    end
+
+    # @example
+    # api.spaces.tickets.get_by_id 'project1', 1710
+    def get_by_id(*args)
+      arguments(args, required: [:space, :ticket_id])
+      get_request("/spaces/#{arguments.space}/tickets/id/#{arguments.ticket_id}", arguments.params)
+    end
+
+    # @example
+    # api.spaces.tickets.edit 'project1', 7, ticket: {description: 'REQ changed...'}
+    def edit(*args)
+      arguments(args, required: [:space, :number]) do
+        permit VALID_PARAMS_NAMES , recursive: true
+        # TODO assert_values VALID_REQUEST_PARAM_VALUES
+      end
+
+      put_request("/spaces/#{arguments.space}/tickets/#{arguments.number}", arguments.params)
+    end
+
+    # Delete ticket by number
+    # @example
+    # api.spaces.tickets.delete 'project1', 7
+    def delete(*args)
+      arguments(args, required: [:space, :number])
+      delete_request("/spaces/#{arguments.space}/tickets/#{arguments.number}", arguments.params)
+    end
+
+    # @example
+    # api.spaces.tickets.list 'project1'
+    def list(*args)
+      arguments(args, required: [:space])
+      response = get_request("/spaces/#{arguments.space}/tickets", arguments.params)
+      return response unless block_given?
+      response.each { |el| yield el }
+    end
+
+    # @example
+    # api.spaces.tickets.my 'project1'
+    def my(*args)
+      arguments(args, required: [:space])
+      response = get_request("/spaces/#{arguments.space}/tickets/my_active", arguments.params)
+      return response unless block_given?
+      response.each { |el| yield el }
+    end
+
+    # @example
+    # api.spaces.tickets.followed 'project1'
+    def followed(*args)
+      arguments(args, required: [:space])
+      response = get_request("/spaces/#{arguments.space}/tickets/my_followed", arguments.params)
+      return response unless block_given?
+      response.each { |el| yield el }
+    end
+
+    # @example
+    # api.spaces.tickets.by_milestone_id 'project1', 49
+    def by_milestone_id(*args)
+      arguments(args, required: [:space, :milestone_id])
+      response = get_request("/spaces/#{arguments.space}/tickets/milestone/#{arguments.milestone_id}", arguments.params)
+      return response unless block_given?
+      response.each { |el| yield el }
+    end
+
+    # @example
+    # api.spaces.tickets.by_milestone_id 'project1'
+    def without_milestone(*args)
+      arguments(args, required: [:space])
+      response = get_request("/spaces/#{arguments.space}/tickets/no_milestone", arguments.params)
+      return response unless block_given?
+      response.each { |el| yield el }
+    end
+
+    # @example
+    # api.spaces.tickets.attachments 'project1', 14
+    def attachments(*args)
+      arguments(args, required: [:space, :number])
+      response = get_request("/spaces/#{arguments.space}/tickets/#{arguments.number}/attachments", arguments.params)
+      return response unless block_given?
+      response.each { |el| yield el }
+    end
+
+    # @example
+    # api.spaces.tickets.tags 'project1', 14
+    def tags(*args)
+      arguments(args, required: [:space, :number])
+      response = get_request("/spaces/#{arguments.space}/tickets/#{arguments.number}/tags", arguments.params)
+      return response unless block_given?
+      response.each { |el| yield el }
+    end
+
+    # @example
+    # api.spaces.tickets.custom_reports 'project1'
+    def custom_reports(*args)
+      arguments(args, required: [:space])
+      response = get_request("/spaces/#{arguments.space}/tickets/custom_reports", arguments.params)
+      return response unless block_given?
+      response.each { |el| yield el }
+    end
+  end # Tickets
+end

data/lib/assembla_api/client/spaces/tickets/associations.rb

@@ -0,0 +1,57 @@
+module Assembla
+  class Client::Spaces::Tickets::Associations < API
+    VALID_PARAMS_NAMES = %w{ ticket2_id relationship }
+    VALID_REQUEST_PARAM_VALUES = {
+      'relationship' => 0..8,
+    }
+
+    # @example
+    # api.spaces.tickets.associations.create 'project1', 500,
+    #      ticket_association: { ticket2_id: 125, relationship: 6 }
+    def create(*args)
+      arguments(args, required: [:space, :number]) do
+        permit VALID_PARAMS_NAMES, recursive: true
+        assert_required %w[ ticket2_id ]
+        assert_values VALID_REQUEST_PARAM_VALUES
+      end
+
+      post_request("/spaces/#{arguments.space}/tickets/#{arguments.number}/ticket_associations", arguments.params)
+    end
+
+    # @example
+    # api.spaces.tickets.associations.get 'project1', 500, 123
+    def get(*args)
+      arguments(args, required: [:space, :number, :id])
+      get_request("/spaces/#{arguments.space}/tickets/#{arguments.number}/ticket_associations/#{arguments.id}", arguments.params)
+    end
+
+    # @example
+    # api.spaces.tickets.associations.edit 'project1', 500, 123, ticket_association: {relationship: 3}
+    def edit(*args)
+      arguments(args, required: [:space, :number, :id]) do
+        permit VALID_PARAMS_NAMES - ['ticket2_id'] , recursive: true
+        assert_required %w[ relationship ]
+        assert_values VALID_REQUEST_PARAM_VALUES
+      end
+
+      put_request("/spaces/#{arguments.space}/tickets/#{arguments.number}/ticket_associations/#{arguments.id}", arguments.params)
+    end
+
+    # Delete ticket association by ID
+    # @example
+    # api.spaces.tickets.associations.delete 'project1', 500, 123
+    def delete(*args)
+      arguments(args, required: [:space, :number, :id])
+      delete_request("/spaces/#{arguments.space}/tickets/#{arguments.number}/ticket_associations/#{arguments.id}", arguments.params)
+    end
+
+    # @example
+    # api.spaces.tickets.associations.list 'project1', 500
+    def list(*args)
+      arguments(args, required: [:space, :number])
+      response = get_request("/spaces/#{arguments.space}/tickets/#{arguments.number}/ticket_associations", arguments.params)
+      return response unless block_given?
+      response.each { |el| yield el }
+    end
+  end
+end

data/lib/assembla_api/client/spaces/tickets/comments.rb

@@ -0,0 +1,45 @@
+module Assembla
+  class Client::Spaces::Tickets::Comments < API
+    VALID_PARAMS_NAMES = %w{ user_id comment created_on }
+
+    # @example
+    # api.spaces.tickets.comments.create 'project1', 500,
+    #      ticket_comment: { comment: 'I will do it now' }
+    def create(*args)
+      arguments(args, required: [:space, :number]) do
+        permit VALID_PARAMS_NAMES, recursive: true
+        assert_required %w[ comment ]
+      end
+
+      post_request("/spaces/#{arguments.space}/tickets/#{arguments.number}/ticket_comments", arguments.params)
+    end
+
+    # @example
+    # api.spaces.tickets.comments.get 'project1', 500, 142857
+    def get(*args)
+      arguments(args, required: [:space, :number, :id])
+      get_request("/spaces/#{arguments.space}/tickets/#{arguments.number}/ticket_comments/#{arguments.id}", arguments.params)
+    end
+
+    # @example
+    # api.spaces.tickets.comments.edit 'project1', 500, 142857,
+    #   ticket_comment: {  comment: 'Ops, I made a typo' }
+    def edit(*args)
+      arguments(args, required: [:space, :number, :id]) do
+        permit ['comment'] , recursive: true
+        assert_required %w[ comment ]
+      end
+
+      put_request("/spaces/#{arguments.space}/tickets/#{arguments.number}/ticket_comments/#{arguments.id}", arguments.params)
+    end
+
+    # @example
+    # api.spaces.tickets.comments.list 'project1', 500
+    def list(*args)
+      arguments(args, required: [:space, :number])
+      response = get_request("/spaces/#{arguments.space}/tickets/#{arguments.number}/ticket_comments", arguments.params)
+      return response unless block_given?
+      response.each { |el| yield el }
+    end
+  end
+end

data/lib/assembla_api/client/spaces/tickets/custom_fields.rb

@@ -0,0 +1,57 @@
+module Assembla
+  class Client::Spaces::Tickets::CustomFields < API
+    VALID_PARAMS_NAMES = %w{type title order required hide default_value list_options}
+    VALID_REQUEST_PARAM_VALUES = {
+      'type' => %w{text numeric team\ list list date},
+      'required' => [true, false],
+      'hide' => [true, false]
+    }
+
+    # @example
+    # api.spaces.tickets.custom_fields.create 'project1', custom_field: { title: 'Build' }
+    def create(*args)
+      arguments(args, required: [:space]) do
+        permit VALID_PARAMS_NAMES, recursive: true
+        assert_required %w[ title ]
+        assert_values VALID_REQUEST_PARAM_VALUES
+      end
+
+      post_request("/spaces/#{arguments.space}/tickets/custom_fields", arguments.params)
+    end
+
+    # @example
+    # api.spaces.tickets.custom_fields.get 'project1', 34
+    def get(*args)
+      arguments(args, required: [:space, :id])
+      get_request("/spaces/#{arguments.space}/tickets/custom_fields/#{arguments.id}", arguments.params)
+    end
+
+    # @example
+    # api.spaces.tickets.custom_fields.edit 'project1', 34, custom_field: {title: 'Build Number', type: 'numeric'}
+    def edit(*args)
+      arguments(args, required: [:space, :id]) do
+        permit VALID_PARAMS_NAMES , recursive: true
+        assert_values VALID_REQUEST_PARAM_VALUES
+      end
+
+      put_request("/spaces/#{arguments.space}/tickets/custom_fields/#{arguments.id}", arguments.params)
+    end
+
+    # Delete ticket status by ID
+    # @example
+    # api.spaces.tickets.custom_fields.delete 'project1', 34
+    def delete(*args)
+      arguments(args, required: [:space, :id])
+      delete_request("/spaces/#{arguments.space}/tickets/custom_fields/#{arguments.id}", arguments.params)
+    end
+
+    # @example
+    # api.spaces.tickets.custom_fields.list 'project1'
+    def list(*args)
+      arguments(args, required: [:space])
+      response = get_request("/spaces/#{arguments.space}/tickets/custom_fields", arguments.params)
+      return response unless block_given?
+      response.each { |el| yield el }
+    end
+  end
+end