assembla_api 0.1.2

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

@@ -0,0 +1,13 @@
+module Assembla
+  class Client::Portfolio::Spaces < API
+
+    # @example
+    # api.portfolio.spaces.list
+    def list(*args)
+      arguments(args)
+      response = get_request("/spaces", arguments.params)
+      return response unless block_given?
+      response.each { |el| yield el }
+    end
+  end
+end

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

@@ -0,0 +1,34 @@
+module Assembla
+  class Client::Portfolio::StandupReports < API
+
+    # @example
+    # api.portfolio.standup_reports.list
+    def list(*args)
+      arguments(args)
+      response = get_request("/standup_reports", arguments.params)
+      return response unless block_given?
+      response.each { |el| yield el }
+    end
+
+    # @example
+    # api.portfolio.standup_reports.away
+    def away(*args)
+      arguments(args) do
+        permit %w{ from to }
+      end
+
+      response = get_request("/standup_reports/away", arguments.params)
+      return response unless block_given?
+      response.each { |el| yield el }
+    end
+
+    # @example
+    # api.portfolio.standup_reports.with_needs
+    def with_needs(*args)
+      arguments(args)
+      response = get_request("/standup_reports/with_needs", arguments.params)
+      return response unless block_given?
+      response.each { |el| yield el }
+    end
+  end
+end

data/lib/assembla_api/client/portfolio/tasks.rb

@@ -0,0 +1,13 @@
+module Assembla
+  class Client::Portfolio::Tasks < API
+
+    # @example
+    # api.portfolio.tasks.list
+    def list(*args)
+      arguments(args)
+      response = get_request("/tasks", arguments.params)
+      return response unless block_given?
+      response.each { |el| yield el }
+    end
+  end
+end

data/lib/assembla_api/client/portfolio/ticket_reports.rb

@@ -0,0 +1,13 @@
+module Assembla
+  class Client::Portfolio::TicketReports < API
+
+    # @example
+    # api.portfolio.ticket_reports.list
+    def list(*args)
+      arguments(args)
+      response = get_request("/ticket_reports", arguments.params)
+      return response unless block_given?
+      response.each { |el| yield el }
+    end
+  end
+end

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

@@ -0,0 +1,13 @@
+module Assembla
+  class Client::Portfolio::Tickets < API
+
+    # @example
+    # api.portfolio.tickets.list
+    def list(*args)
+      arguments(args)
+      response = get_request("/tickets", arguments.params)
+      return response unless block_given?
+      response.each { |el| yield el }
+    end
+  end
+end

data/lib/assembla_api/client/portfolio/users.rb

@@ -0,0 +1,13 @@
+module Assembla
+  class Client::Portfolio::Users < API
+
+    # @example
+    # api.portfolio.tasks.list
+    def list(*args)
+      arguments(args)
+      response = get_request("/users", arguments.params)
+      return response unless block_given?
+      response.each { |el| yield el }
+    end
+  end
+end

data/lib/assembla_api/client/spaces.rb

@@ -0,0 +1,140 @@
+# encoding: utf-8
+
+module Assembla
+  class Client::Spaces < API
+    require_all 'assembla_api/client/spaces',
+      'space_tools',
+      'tickets',
+      'tags',
+      'milestones',
+      'documents',
+      'wiki_pages',
+      'webhooks',
+      'ssh',
+      'standup_reports',
+      'standup_away_reports',
+      'user_roles',
+      'users'
+
+    VALID_PARAMS_NAMES = %w[
+      name
+      wiki_name
+      description
+      public_permissions
+      team_permissions
+      watcher_permissions
+      share_permissions
+      status
+      team_tab_role
+      default_showpage
+      tabs_order
+      banner
+      banner_height
+      banner_text
+      banner_link
+      style
+      approved
+      can_join
+      wiki_format
+    ].freeze
+
+    VALID_REQUEST_PARAM_VALUES = {
+      'status' => [0, 1, 2, 3, 4],
+      'team_tab_role' => [0, 10, 50, 90],
+      'public_permissions' => [0, 1],
+      'team_permissions' => [1, 2, 3],
+      'watcher_permissions' => [0, 1],
+    }
+
+    # Access to Spaces::Users API
+    namespace :users
+
+    # Access to Spaces::UserRoles API
+    namespace :user_roles
+
+    # Access to Spaces::Tickets API
+    namespace :tickets
+    namespace :tags
+    namespace :milestones
+    namespace :documents
+    namespace :wiki_pages
+    namespace :webhooks
+    namespace :ssh
+    namespace :space_tools
+    namespace :standup_reports
+    namespace :standup_away_reports
+
+    #
+    def my(*args)
+      arguments(args)
+      response = get_request("/spaces", arguments.params)
+      return response unless block_given?
+      response.each { |el| yield el }
+    end
+
+    # api.spaces.get space: 'breakout'
+    def get(*args)
+      arguments(args, required: [:space])
+      get_request("/spaces/#{arguments.space}", arguments.params)
+    end
+    alias :find :get
+
+    def create(*args)
+      arguments(args) do
+        permit VALID_PARAMS_NAMES
+        assert_required %w[ name ]
+        assert_values VALID_REQUEST_PARAM_VALUES
+      end
+
+      post_request("/spaces", arguments.params)
+    end
+
+    def copy(*args)
+      arguments(args, required: [:space]) do
+        permit VALID_PARAMS_NAMES
+        assert_required %w[ name ]
+        assert_values VALID_REQUEST_PARAM_VALUES
+      end
+
+      post_request("/spaces/#{arguments.space}/copy", arguments.params)
+    end
+
+    # Delete a space
+    #
+    # Deleting a space requires owner access.
+    #
+    # @example
+    #  assembla = Assembla.new oauth_token: '...'
+    #  assembla.repos.delete 'space-name'
+    #
+    # @api public
+    def delete(*args)
+      arguments(args, required: [:space])
+      delete_request("/spaces/#{arguments.space}", arguments.params)
+    end
+    alias :remove :delete
+
+    # Edit a space
+    #
+    # @param [Hash] params
+    # @option params [String] :name
+    #   Required string
+    # @option params [String] :description
+    #   Optional string
+    #
+    # @example
+    #  assembla = Assembla.new
+    #  assembla.spaces.edit 'space-name',
+    #    name: 'hello-world',
+    #    description: 'This is your first space'
+    #
+    def edit(*args)
+      arguments(args,required: [:space]) do
+        permit VALID_PARAMS_NAMES
+        assert_values VALID_REQUEST_PARAM_VALUES
+      end
+
+      put_request("/spaces/#{arguments.space}", arguments.params)
+    end
+  end # Spaces
+end # Assembla

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

@@ -0,0 +1,87 @@
+require "mime/types"
+
+module Assembla
+  class Client::Spaces::Documents < API
+
+    VALID_PARAMS_NAMES = %w[
+      file
+      filename
+      name
+      description
+      position
+      cached_tag_list
+      attachable_type
+      attachable_guid
+      attachable_id
+    ].freeze
+
+    VALID_REQUEST_PARAM_VALUES = {
+      'attachable_type' => /^(Ticket|Flow|Milestone)$/
+    }
+
+    # @example
+    # api.spaces.documents.create 'project1', document: { file: '/path/to/file' }
+    def create(*args)
+      arguments(args, required: [:space]) do
+        permit VALID_PARAMS_NAMES, recursive: true
+        assert_required %w[ file ]
+        assert_values VALID_REQUEST_PARAM_VALUES
+      end
+
+      doc = arguments.params.delete 'document'
+      path = doc['file']
+      name = File.basename(path)
+      mime = MIME::Types.of(name).first
+      file = Faraday::UploadIO.new(path, mime ? mime.content_type : 'application/octet-stream')
+      doc['name'] ||= name
+      doc['file'] = file
+      arguments.params['data'] = { 'document' => doc }
+      arguments.params['options'] = { headers: { content_type: 'multipart/form-data' }}
+
+      post_request("/spaces/#{arguments.space}/documents", arguments.params)
+    end
+
+    # @example
+    # api.spaces.documents.get 'project1', 'guid'
+    def get(*args)
+      arguments(args, required: [:space, :id])
+      get_request("/spaces/#{arguments.space}/documents/#{arguments.id}", arguments.params)
+    end
+
+    # @example
+    # api.spaces.documents.download 'project1', 'guid'
+    def download(*args)
+      arguments(args, required: [:space, :id])
+      arguments.params['raw'] = true
+      get_request("/spaces/#{arguments.space}/documents/#{arguments.id}/download", arguments.params)
+    end
+
+    # @example
+    # api.spaces.documents.edit 'project1', 'guid', document: { description: "Confidential" }
+    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}/documents/#{arguments.id}", arguments.params)
+    end
+
+    # Delete document by ID
+    # @example
+    # api.spaces.documents.delete 'project1', 'guid'
+    def delete(*args)
+      arguments(args, required: [:space, :id])
+      delete_request("/spaces/#{arguments.space}/documents/#{arguments.id}", arguments.params)
+    end
+
+    # @example
+    # api.spaces.documents.list 'project1'
+    def list(*args)
+      arguments(args, required: [:space])
+      response = get_request("/spaces/#{arguments.space}/documents", arguments.params)
+      return response unless block_given?
+      response.each { |el| yield el }
+    end
+  end # documents
+end

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

@@ -0,0 +1,102 @@
+module Assembla
+  class Client::Spaces::Milestones < API
+
+    VALID_PARAMS_NAMES = %w[
+      title
+      user_id
+      is_completed
+      release_level
+      release_notes
+      planner_type
+    ].freeze
+
+    VALID_REQUEST_PARAM_VALUES = {
+      'release_level' => [ 1, 2, 3 ],   # Alpha, Beta, Stable
+      'planner_type' => [ 0, 1, 2 ],    # None, Backlog, Current
+      'is_completed' => [ true, false ],
+    }
+
+    # @example
+    # api.spaces.milestones.create 'project1', milestone: { title: 'Mobile App V2' }
+    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}/milestones", arguments.params)
+    end
+
+    # @example
+    # api.spaces.milestones.get 'project1', 7
+    def get(*args)
+      arguments(args, required: [:space, :id])
+      get_request("/spaces/#{arguments.space}/milestones/#{arguments.id}", arguments.params)
+    end
+
+    # @example
+    # api.spaces.milestones.edit 'project1', 7, milestone: { is_completed: true }
+    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}/milestones/#{arguments.id}", arguments.params)
+    end
+
+    # Delete milestone by ID
+    # @example
+    # api.spaces.milestones.delete 'project1', 7
+    def delete(*args)
+      arguments(args, required: [:space, :id])
+      delete_request("/spaces/#{arguments.space}/milestones/#{arguments.id}", arguments.params)
+    end
+
+    # @example
+    # api.spaces.milestones.list 'project1'
+    def list(*args)
+      arguments(args, required: [:space])
+      response = get_request("/spaces/#{arguments.space}/milestones", arguments.params)
+      return response unless block_given?
+      response.each { |el| yield el }
+    end
+
+    # @example
+    # api.spaces.milestones.all 'project1'
+    def all(*args)
+      arguments(args, required: [:space])
+      response = get_request("/spaces/#{arguments.space}/milestones/all", arguments.params)
+      return response unless block_given?
+      response.each { |el| yield el }
+    end
+
+    # @example
+    # api.spaces.milestones.completed 'project1'
+    def completed(*args)
+      arguments(args, required: [:space])
+      response = get_request("/spaces/#{arguments.space}/milestones/completed", arguments.params)
+      return response unless block_given?
+      response.each { |el| yield el }
+    end
+
+    # @example
+    # api.spaces.milestones.upcoming 'project1'
+    def upcoming(*args)
+      arguments(args, required: [:space])
+      response = get_request("/spaces/#{arguments.space}/milestones/upcoming", arguments.params)
+      return response unless block_given?
+      response.each { |el| yield el }
+    end
+
+    # @example
+    # api.spaces.milestones.release_notes 'project1'
+    def release_notes(*args)
+      arguments(args, required: [:space])
+      response = get_request("/spaces/#{arguments.space}/milestones/release_notes", arguments.params)
+      return response unless block_given?
+      response.each { |el| yield el }
+    end
+  end # milestones
+end

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

@@ -0,0 +1,65 @@
+module Assembla
+  class Client::Spaces::SpaceTools < API
+    require_all 'assembla_api/client/spaces/space_tools',
+      'merge_requests'
+
+    namespace :merge_requests
+
+    VALID_PARAMS_NAMES = %w{
+      team_permissions
+      watcher_permissions
+      public_permissions
+    }
+
+    # @example
+    # api.spaces.space_tools.create 'project1', 21,
+    def create(*args)
+      arguments(args, required: [:space, :tool_id])
+      post_request("/spaces/#{arguments.space}/space_tools/#{arguments.tool_id}/add")
+    end
+
+    # @example
+    # api.spaces.space_tools.edit 'project1', 'tool_guid', space_tool: {watcher_permissions: 1}
+    def edit(*args)
+      arguments(args, required: [:space, :space_tool_id]) do
+        permit VALID_PARAMS_NAMES, recursive: true
+      end
+
+      put_request("/spaces/#{arguments.space}/space_tools/#{arguments.space_tool_id}", arguments.params)
+    end
+
+    # @example
+    # api.spaces.space_tools.get 'project1', 'tool_guid'
+    def get(*args)
+      arguments(args, required: [:space, :space_tool_id])
+      get_request("/spaces/#{arguments.space}/space_tools/#{arguments.space_tool_id}")
+    end
+
+    # @example
+    # api.spaces.space_tools.delete 'project1', 'tool_guid'
+    def delete(*args)
+      arguments(args, required: [:space, :space_tool_id])
+      delete_request("/spaces/#{arguments.space}/space_tools/#{arguments.space_tool_id}")
+    end
+
+    # @example
+    # api.spaces.space_tools.list 'project1'
+    # api.spaces.space_tools.all 'project1'
+    def list(*args)
+      arguments(args, required: [:space])
+      response = get_request("/spaces/#{arguments.space}/space_tools", arguments.params)
+      return response unless block_given?
+      response.each { |el| yield el }
+    end
+    alias :all :list
+
+    # @example
+    # api.spaces.space_tools.repo_list 'project1'
+    def repo_list(*args)
+      arguments(args, required: [:space])
+      response = get_request("/spaces/#{arguments.space}/space_tools/repo", arguments.params)
+      return response unless block_given?
+      response.each { |el| yield el }
+    end
+  end # SpaceTools
+end # Assembla