========================

RhodeCode documentation!

========================

## available vars:

## scheme - http/https

## user - current user

## pass - password 

## netloc - network location

## path - usually repo_name

#clone_uri = {scheme}://{user}{pass}{netloc}{path}

## issue tracking mapping for commits messages

## uncomment url_pat, issue_server, issue_prefix to enable

## pattern to get the issues from commit messages

## default one used here is #1234

#url_pat = (?:^#|\s#)(\w+)

## server url to the issue, each {id} will be replaced with id

## fetched from the regex

#issue_server = https://myissueserver.com/issue/{id}

## prefix to add to link to indicate it's an url

## #314 will be replaced by <issue_prefix><id>

#issue_prefix = #

API ACCESS FOR WEB VIEWS

++++++++++++++++++++++++

API ACCESS

++++++++++

                "repo_name" : "<reponame>"

    result : "Pulled from <reponame>"

get_user

--------

Get's an user by username, Returns empty result if user is not found.

This command can be executed only using api_key belonging to user with admin 

rights.

INPUT::

    api_key : "<api_key>"

    method :  "get_user"

    args :    { 

                "username" : "<username>"

              }

OUTPUT::

    result: None if user does not exist or 

            {

                "id" :       "<id>",

                "username" : "<username>",

                "firstname": "<firstname>",

                "lastname" : "<lastname>",

                "email" :    "<email>",

                "active" :   "<bool>",

                "admin" :    "<bool>",

                "ldap" :     "<ldap_dn>"

            }

    error:  null

              "id" : "<new_user_id>",

               "id" :         "<id>",

               "group_name" : "<groupname>",

               "active":      "<bool>",

                              { "id" :       "<userid>",

                                "username" : "<username>",

                                "firstname": "<firstname>",

                                "lastname" : "<lastname>",

                                "email" :    "<email>",

                                "active" :   "<bool>",

                                "admin" :    "<bool>",

                                "ldap" :     "<ldap_dn>"

                              },

                              …

                            ]

get_users_groups

----------------

Lists all existing users groups. This command can be executed only using 

api_key belonging to user with admin rights.

INPUT::

    api_key : "<api_key>"

    method :  "get_users_groups"

    args :    { }

OUTPUT::

    result : [

               {

                 "id" :         "<id>",

                 "group_name" : "<groupname>",

                 "active":      "<bool>",

                 "members" :  [

	    	                    {

	    	                      "id" :       "<userid>",

	                              "username" : "<username>",

	                              "firstname": "<firstname>",

	                              "lastname" : "<lastname>",

	                              "email" :    "<email>",

	                              "active" :   "<bool>",

	                              "admin" :    "<bool>",

	                              "ldap" :     "<ldap_dn>"

	                            },

	    	                    …

	                          ]

	            }

              ]

    error : null

                "group_name":  "<groupname>",

              "msg": "created new users group <groupname>"

get_repo

--------

Gets an existing repository. This command can be executed only using api_key

belonging to user with admin rights

INPUT::

    api_key : "<api_key>"

    method :  "get_repo"

    args:     {

                "repo_name" : "<reponame>"

              }

OUTPUT::

    result: None if repository does not exist or

            {

                "id" :          "<id>",

                "repo_name" :   "<reponame>"

                "type" :        "<type>",

                "description" : "<description>",

                "members" :     [

                                  { "id" :         "<userid>",

                                    "username" :   "<username>",

                                    "firstname":   "<firstname>",

                                    "lastname" :   "<lastname>",

                                    "email" :      "<email>",

                                    "active" :     "<bool>",

                                    "admin" :      "<bool>",

                                    "ldap" :       "<ldap_dn>",

                                    "permission" : "repository.(read|write|admin)"

                                  },

                                  …

                                  {

                                    "id" :       "<usersgroupid>",

                                    "name" :     "<usersgroupname>",

                                    "active":    "<bool>",

                                    "permission" : "repository.(read|write|admin)"

                                  },

                                  …

                                ]

            }

    error:  null

                "repo_name" :   "<reponame>"

at given revision. It's possible to specify ret_type to show only `files` or 

`dirs`. This command can be executed only using api_key belonging to user 

                "repo_name" : "<reponame>",

                "repo_name" :   "<reponame>",

    result: {

                "id": "<newrepoid>",

                "msg": "Created new repository <reponame>",

            }

                "username" :   "<username>",

    result: {

                "msg" : "Added perm: <perm> for <username> in repo: <reponame>"

            }

                "group_name" : "<groupname>",

              }

OUTPUT::

    result: {

                "msg" : Added perm: <perm> for <groupname> in repo: <reponame>"

            }

.. _indexapi:

.. automodule:: rhodecode.model.comment

   :members:

.. automodule:: rhodecode.model.notification

   :members:   

.. automodule:: rhodecode.model.repo_permission

   :members:      

.. automodule:: rhodecode.model.repos_group

   :members:

.. automodule:: rhodecode.model.users_group

   :members:   

- #73 added linking issues in commit messages to choosen issue tracker url

  based on user defined regular expression

Users Guide

-----------

   :maxdepth: 1

Integration with Issue trackers

-------------------------------

RhodeCode provides a simple integration with issue trackers. It's possible

to define a regular expression that will fetch issue id stored in commit

messages and replace that with an url to this issue. To enable this simply

uncomment following variables in the ini file::

    url_pat = (?:^#|\s#)(\w+)

    issue_server = https://myissueserver.com/issue/{id}

    issue_prefix = #

`url_pat` is the regular expression that will match issues, default given regex

will match issues in format of #<number> eg. #300. 

Matched issues will be replace with the `issue_server` url replacing {id} with

id fetched from regex. Since the # is striped `issue_prefix` is added as a 

prefix to url. `issue_prefix` can be something different than # if you pass 

ISSUE- as issue prefix this will generate an url in format 

`<a href="https://myissueserver.com/issue/300">ISSUE-300</a>`  

## available vars:

## scheme - http/https

## user - current user

## pass - password 

## netloc - network location

## path - usually repo_name

#clone_uri = {scheme}://{user}{pass}{netloc}{path}

## issue tracking mapping for commits messages

## uncomment url_pat, issue_server, issue_prefix to enable

## pattern to get the issues from commit messages

## default one used here is #1234

#url_pat = (?:^#|\s#)(\w+)

## server url to the issue, each {id} will be replaced with id

## fetched from the regex

#issue_server = https://myissueserver.com/issue/{id}

## prefix to add to link to indicate it's an url

## #314 will be replaced by <issue_prefix><id>

#issue_prefix = #

## available vars:

## scheme - http/https

## user - current user

## pass - password 

## netloc - network location

## path - usually repo_name

## issue tracking mapping for commits messages

## uncomment url_pat, issue_server, issue_prefix to enable

## pattern to get the issues from commit messages

## default one used here is #1234

#url_pat = (?:^#|\s#)(\w+)

## server url to the issue, each {id} will be replaced with id

## fetched from the regex

#issue_server = https://myissueserver.com/issue/{id}

## prefix to add to link to indicate it's an url

## #314 will be replaced by <issue_prefix><id>

#issue_prefix = #

    def pull(self, apiuser, repo_name):

        :param repo_name:

        if Repository.is_valid(repo_name) is False:

            raise JSONRPCError('Unknown repo "%s"' % repo_name)

            ScmModel().pull_changes(repo_name, self.rhodecode_user.username)

            return 'Pulled from %s' % repo_name

            raise JSONRPCError('Unable to pull changes from "%s"' % repo_name)

            usr = UserModel().create_or_update(

                username, password, email, firstname,

                lastname, active, admin, ldap_dn

            )

            return dict(

                id=usr.user_id,

                msg='created new user %s' % username

            )

                    group_name=users_group.users_group_name,

                                group_name=users_group.users_group_name,

    def create_users_group(self, apiuser, group_name, active=True):

        :param group_name:

        if self.get_users_group(apiuser, group_name):

            raise JSONRPCError("users group %s already exist" % group_name)

            ug = UsersGroupModel().create(name=group_name, active=active)

                        msg='created new users group %s' % group_name)

            raise JSONRPCError('failed to create group %s' % group_name)

            repo_name=repo.repo_name,

                    repo_name=repository.repo_name,

    def create_repo(self, apiuser, repo_name, owner_name, description='',

        :param repo_name:

            if Repository.get_by_repo_name(repo_name):

                raise JSONRPCError("repo %s already exist" % repo_name)

            groups = repo_name.split('/')

            repo = RepoModel().create(

                    repo_name_full=repo_name,

            return dict(

                id=repo.repo_id,

                msg="Created new repository %s" % repo.repo_name

            )

            raise JSONRPCError('failed to create repository %s' % repo_name)