assembla_api 0.1.2

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

@@ -0,0 +1,55 @@
+module Assembla
+  class Client::Spaces::Tickets::Statuses < API
+    VALID_PARAMS_NAMES = %w{name state list_order}
+    VALID_REQUEST_PARAM_VALUES = {
+      'state' => [0, 1]
+    }
+
+    # @example
+    # api.spaces.tickets.statuses.create 'project1', status: { name: 'Review' }
+    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}/tickets/statuses", arguments.params)
+    end
+
+    # @example
+    # api.spaces.tickets.statuses.get 'project1', 34
+    def get(*args)
+      arguments(args, required: [:space, :id])
+      get_request("/spaces/#{arguments.space}/tickets/statuses/#{arguments.id}", arguments.params)
+    end
+
+    # @example
+    # api.spaces.tickets.statuses.edit 'project1', 34, status: {name: 'Review Design'}
+    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/statuses/#{arguments.id}", arguments.params)
+    end
+
+    # Delete ticket status by ID
+    # @example
+    # api.spaces.tickets.statuses.delete 'project1', 34
+    def delete(*args)
+      arguments(args, required: [:space, :id])
+      delete_request("/spaces/#{arguments.space}/tickets/statuses/#{arguments.id}", arguments.params)
+    end
+
+    # @example
+    # api.spaces.tickets.statuses.list 'project1'
+    def list(*args)
+      arguments(args, required: [:space])
+      response = get_request("/spaces/#{arguments.space}/tickets/statuses", arguments.params)
+      return response unless block_given?
+      response.each { |el| yield el }
+    end
+  end
+end

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

@@ -0,0 +1,61 @@
+module Assembla
+  class Client::Spaces::UserRoles < API
+
+    VALID_PARAMS_NAMES = %w[
+      user_id
+      role
+      title
+      message
+    ].freeze
+
+    VALID_REQUEST_PARAM_VALUES = {
+      'role' => %w{watcher member owner},
+    }
+
+    # api.spaces.user_roles.list 'project1'
+    def list(*args)
+      arguments(args, required: [:space])
+      response = get_request("/spaces/#{arguments.space}/user_roles", arguments.params)
+      return response unless block_given?
+      response.each { |el| yield el }
+    end
+
+    # api.spaces.user_roles.get 'project1', 150
+    def get(*args)
+      arguments(args, required: [:space, :user_role_id])
+      get_request("/spaces/#{arguments.space}/user_roles/#{arguments.user_role_id}", arguments.params)
+    end
+
+    alias :find :get
+
+    # api.spaces.user_roles.delete 'project1', 150
+    def delete(*args)
+      arguments(args, required: [:space, :user_role_id])
+      delete_request("/spaces/#{arguments.space}/user_roles/#{arguments.user_role_id}", arguments.params)
+    end
+
+    alias :remove :delete
+
+    # api.spaces.user_roles.edit 'project1', 150, user_role: { role: 'owner', title: 'Designer' }
+    def edit(*args)
+      arguments(args, required: [:space, :user_role_id]) do
+        permit VALID_PARAMS_NAMES, recursive: true
+        assert_required %w[ role ]
+        assert_values VALID_REQUEST_PARAM_VALUES
+      end
+
+      put_request("/spaces/#{arguments.space}/user_roles/#{arguments.user_role_id}", arguments.params)
+    end
+
+    # api.spaces.user_roles.create 'project1', user_role: {user_id: UID, role: 'member'}
+    def create(*args)
+      arguments(args, required: [:space]) do
+        permit VALID_PARAMS_NAMES, recursive: true
+        assert_required %w[ user_id role ]
+        assert_values VALID_REQUEST_PARAM_VALUES
+      end
+
+      post_request("/spaces/#{arguments.space}/user_roles", arguments.params)
+    end
+  end # UserRoles
+end # Assembla

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

@@ -0,0 +1,11 @@
+module Assembla
+  class Client::Spaces::Users < API
+    # api.spaces.users.list space: 'project1'
+    def list(*args)
+      arguments(args, required: [:space])
+      response = get_request("/spaces/#{arguments.space}/users", arguments.params)
+      return response unless block_given?
+      response.each { |el| yield el }
+    end
+  end
+end

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

@@ -0,0 +1,63 @@
+module Assembla
+  class Client::Spaces::Webhooks < API
+
+    VALID_PARAMS_NAMES = %w[
+      title
+      enabled
+      authentication_type
+      app_api_key
+      app_secret
+      app_request_token_url
+      app_access_token_url
+      app_authorize_url
+      app_authorize_query
+      access_token
+      access_token_secret
+      external_url
+      http_method
+      content_type
+      content
+      filter
+    ].freeze
+
+    BASIC_AUTH = 1
+
+    VALID_REQUEST_PARAM_VALUES = {
+      'enabled' => [true, false],
+      'authentication_type' => [1, 2],
+      'http_method' => [0, 1]
+    }
+
+    # @example
+    # api.spaces.webhooks.create 'project1', webhook: { title: 'Mobile App V2', external_url: 'http://example.com/notify' }
+    def create(*args)
+      arguments(args, required: [:space]) do
+        permit VALID_PARAMS_NAMES, recursive: true
+        assert_required %w[ external_url ]
+        assert_values VALID_REQUEST_PARAM_VALUES
+      end
+
+      arguments.params['webhook']['authentication_type'] ||= BASIC_AUTH
+      post_request("/spaces/#{arguments.space}/webhooks", arguments.params)
+    end
+
+    # @example
+    # api.spaces.webhooks.edit 'project1', 699, webhook: { enabled: false }
+    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}/webhooks/#{arguments.id}", arguments.params)
+    end
+
+    # Delete webhook by ID
+    # @example
+    # api.spaces.webhooks.delete 'project1', 699
+    def delete(*args)
+      arguments(args, required: [:space, :id])
+      delete_request("/spaces/#{arguments.space}/webhooks/#{arguments.id}", arguments.params)
+    end
+  end # webhooks
+end

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

@@ -0,0 +1,78 @@
+module Assembla
+  class Client::Spaces::WikiPages < API
+    require_all 'assembla_api/client/spaces/wiki_pages',
+      'versions'
+
+    VALID_PARAMS_NAMES = %w[
+      page_name
+      contents
+      parent_id
+      position
+      status
+      wiki_format
+      change_comment
+    ].freeze
+
+    VALID_REQUEST_PARAM_VALUES = {
+      'status' => [0, 1, 2],
+      'wiki_format' => [0, 1, 2, 3, 4, 5]
+    }
+
+    # @example
+    # api.spaces.wiki_pages.create 'project1', wiki_page: { page_name: 'Mobile App V2' }
+    def create(*args)
+      arguments(args, required: [:space]) do
+        permit VALID_PARAMS_NAMES, recursive: true
+        assert_required %w[ page_name ]
+        assert_values VALID_REQUEST_PARAM_VALUES
+      end
+
+      post_request("/spaces/#{arguments.space}/wiki_pages", arguments.params)
+    end
+
+    # @example
+    # api.spaces.wiki_pages.get 'project1', 'guid'
+    def get(*args)
+      arguments(args, required: [:space, :id])
+      get_request("/spaces/#{arguments.space}/wiki_pages/#{arguments.id}", arguments.params)
+    end
+
+    # @example
+    # api.spaces.wiki_pages.edit 'project1', 'guid', wiki_page: { position: 1 }
+    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}/wiki_pages/#{arguments.id}", arguments.params)
+    end
+
+    # Deletes wiki page by ID and all its children
+    #
+    # @example
+    # api.spaces.wiki_pages.delete 'project1', 'guid'
+    def delete(*args)
+      arguments(args, required: [:space, :id])
+      delete_request("/spaces/#{arguments.space}/wiki_pages/#{arguments.id}/all", arguments.params)
+    end
+
+    # Deletes wiki page by ID and moves all children with one level up
+    #
+    # @example
+    # api.spaces.wiki_pages.delete_parent 'project1', 'guid'
+    def delete_parent(*args)
+      arguments(args, required: [:space, :id])
+      delete_request("/spaces/#{arguments.space}/wiki_pages/#{arguments.id}/container", arguments.params)
+    end
+
+    # @example
+    # api.spaces.wiki_pages.list 'project1'
+    def list(*args)
+      arguments(args, required: [:space])
+      response = get_request("/spaces/#{arguments.space}/wiki_pages", arguments.params)
+      return response unless block_given?
+      response.each { |el| yield el }
+    end
+  end # wiki_pages
+end

data/lib/assembla_api/client/spaces/wiki_pages/versions.rb

@@ -0,0 +1,20 @@
+module Assembla
+  class Client::Spaces::WikiPages::Versions < API
+
+    # @example
+    # api.spaces.wiki_pages.versions.get 'project1', 'wiki-guid', 369
+    def get(*args)
+      arguments(args, required: [:space, :wiki_guid, :id])
+      get_request("/spaces/#{arguments.space}/wiki_pages/#{arguments.wiki_guid}/versions/#{arguments.id}", arguments.params)
+    end
+
+    # @example
+    # api.spaces.wiki_pages.versions.list 'project1', 'wiki-guid'
+    def list(*args)
+      arguments(args, required: [:space, :wiki_guid])
+      response = get_request("/spaces/#{arguments.space}/wiki_pages/#{arguments.wiki_guid}/versions", arguments.params)
+      return response unless block_given?
+      response.each { |el| yield el }
+    end
+  end # versions
+end

data/lib/assembla_api/client/tasks.rb

@@ -0,0 +1,72 @@
+module Assembla
+  class Client::Tasks < API
+    VALID_PARAMS_NAMES = %w{
+      description
+      job_agreement_id
+      space_id
+      ticket_id
+      url
+      hours
+      begin_at
+      end_at
+    }
+
+    # @example
+    # api.tasks.get 963
+    def get(*args)
+      arguments(args, required: [:id])
+      get_request("/tasks/#{arguments.id}", arguments.params)
+    end
+    alias :find :get
+
+    def create(*args)
+      arguments(args) do
+        permit VALID_PARAMS_NAMES, recursive: true
+        assert_required %w[ description space_id ]
+      end
+
+      task = arguments.params['user_task'] = arguments.params.delete 'task'
+      task['begin_at'] ||= Time.now.utc.strftime '%FT%TZ'
+      task['hours'] ||= 1
+
+      post_request("/tasks", arguments.params)
+    end
+
+    def delete(*args)
+      arguments(args, required: [:id])
+      delete_request("/tasks/#{arguments.id}", arguments.params)
+    end
+    alias :remove :delete
+
+    # Edit a task
+    #
+    # @param [Hash] params
+    # @option params [String] :description
+    #   Optional string
+    #
+    # @example
+    #  api = Assembla.new
+    #  api.tasks.edit 963, task: {
+    #    url: 'http://google.com',
+    #    description: 'Search using new engine'
+    #  }
+    def edit(*args)
+      arguments(args, required: [:id]) do
+        permit VALID_PARAMS_NAMES, recursive: true
+      end
+
+      arguments.params['user_task'] = arguments.params.delete 'task'
+
+      put_request("/tasks/#{arguments.id}", arguments.params)
+    end
+
+    # @example
+    # api.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/users.rb

@@ -0,0 +1,49 @@
+# encoding: utf-8
+
+module Assembla
+  class Client::Users < API
+    # Load all the modules after initializing Repos to avoid superclass mismatch
+    require_all 'assembla_api/client/users',
+      'keys'
+
+    VALID_USER_PARAMS_NAMES = %w[
+    ].freeze
+
+    # Access to Users::Keys API
+    namespace :keys
+
+    # Get a single user
+    #
+    # @example
+    #  assembla = Assembla.new oauth_token: '...'
+    #  assembla.users.get user: 'user-name'
+    #
+    # Get the authenticated user
+    #
+    # @example
+    #  assembla = Assembla.new oauth_token: '...'
+    #  assembla.users.me
+    #
+    # @api public
+    def get(*args)
+      params = arguments(args).params
+
+      if user_name = params.delete('user')
+        get_request("/users/#{user_name}", params)
+      else
+        get_request("/user")
+      end
+    end
+
+    alias :find :get
+    alias :me :get
+
+    # @example
+    #  api.users.picture 'mike'
+    def picture(*args)
+      arguments(args, required: [ :user ])
+      arguments.params['raw'] = true
+      get_request("/users/#{arguments.user}/picture", arguments.params)
+    end
+  end # Users
+end # Assembla

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

@@ -0,0 +1,97 @@
+# encoding: utf-8
+
+module Assembla
+  class Client::Users::Keys < API
+
+    VALID_KEY_PARAM_NAMES = %w[ title key read_only ].freeze
+    VALID_REQUEST_PARAM_VALUES = {
+      'read_only' => [ true, false ],
+    }
+
+    # List public keys for the authenticated user
+    #
+    # @example
+    #  assembla = Assembla.new oauth_token: '...'
+    #  assembla.users.keys.list
+    #  assembla.users.keys.list { |key| ... }
+    #
+    # @return [Hash]
+    #
+    # @api public
+    def list(*args)
+      params = arguments(args).params
+      response = get_request("/user/ssh_keys", params)
+      return response unless block_given?
+      response.each { |el| yield el }
+    end
+    alias :all :list
+
+    # Get a single pulic key for the authenticated user
+    #
+    # @example
+    #  assembla = Assembla.new oauth_token: '...'
+    #  assembla.users.keys.get 571
+    #
+    # @api public
+    def get(*args)
+      arguments(args, required: [:id])
+      get_request("/user/ssh_keys/#{arguments.id}", arguments.params)
+    end
+    alias :find :get
+
+    # Create a public key for the authenticated user
+    #
+    # @param [Hash] params
+    # @option [String] :title
+    #   Required string
+    # @option [String] :key
+    #   Required string. sha key
+    #
+    # @example
+    #  assembla = Assembla.new oauth_token: '...'
+    #  assembla.users.keys.create ssh_key: {title: "buildbot@mac", key: "ssh-rsa AAA..."}
+    #
+    # @api public
+    def create(*args)
+      arguments(args) do
+        permit VALID_KEY_PARAM_NAMES, recursive: true
+        assert_values VALID_REQUEST_PARAM_VALUES
+      end
+      post_request("/user/ssh_keys", arguments.params)
+    end
+
+    # Update a public key for the authenticated user
+    #
+    # @param [Hash] params
+    # @option [String] :title
+    #   Required string
+    # @option [String] :key
+    #   Required string. sha key
+    #
+    # @example
+    #  assembla = Assembla.new oauth_token: '...'
+    #  assembla.users.keys.update 571, "title": "buildbot@mac",
+    #    "key": "ssh-rsa AAA..."
+    #
+    # @api public
+    def edit(*args)
+      arguments(args, required: [:id]) do
+        permit VALID_KEY_PARAM_NAMES, recursive: true
+        assert_values VALID_REQUEST_PARAM_VALUES
+      end
+      put_request("/user/ssh_keys/#{arguments.id}", arguments.params)
+    end
+
+    # Delete a public key for the authenticated user
+    #
+    # @example
+    #  assembla = Assembla.new oauth_token: '...'
+    #  assembla.users.keys.delete 571
+    #
+    # @api public
+    def delete(*args)
+      arguments(args, required: [:id])
+      delete_request("/user/ssh_keys/#{arguments.id}", arguments.params)
+    end
+  end # Users::Keys
+end # Assembla