audc-gerry 0.1.6

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 8a1b763d810800ab1dcb57c97e7df8ba54e09d207e549b5e3270b5d09b16aadf
+  data.tar.gz: 194d9b4dda05ca8cc5b1bf70ef454c706331bb8a32e3f48c3f84f4754675fa18
+SHA512:
+  metadata.gz: eca9ab70813663d3b95aa85aeaec1918743246d611b19c9690fc388dd6266149e8af2ec10ad1d55d859c92ddebd389bdb6337b490ef2c26f00e64dfd8fab57f9
+  data.tar.gz: 30bde14c9bc657860cf403d3482b14f2ef13c7f76d65f6ad449b050208e22aeb46c754d2501c7547769a080dd445380e98896b3ab43a1dc30e2a25574a4adefe

data/README.md

@@ -0,0 +1,62 @@
+# gerry[![Build Status](https://travis-ci.org/trumant/gerry.svg)][travis]
+
+Base Gerrit Version V2.14.6
+
+Simple Ruby wrapper for the Gerrit Code Review REST-API.
+
+![Gary from spongebob square pants](http://en.spongepedia.org/images/3/37/Garry.jpg)
+
+[travis]: https://travis-ci.org/trumant/gerry
+
+## Documentation
+[http://rdoc.info/github/trumant/gerry][documentation]
+
+[documentation]: http://rdoc.info/github/trumant/gerry
+
+## Install
+```
+bundle
+bundle exec rake install
+```
+
+## Examples
+### Get the global capabilities
+```ruby
+client = Gerry.new('https://review')
+client.account_capabilities
+=> {"queryLimit"=>{"min"=>0, "max"=>250}}
+```
+
+### List projects
+```ruby
+client = Gerry.new('https://review')
+client.projects
+=> { "awesome"=>{ "description"=>"Awesome project"}}
+```
+
+### List open changes
+```ruby
+client = Gerry.new('https://review')
+client.changes(['q=is:open'])
+=> [{"project"=>"awesome", "branch"=>"master", "id"=>"Ibfedd978...."}]
+```
+
+### Authentication type
+Since 2.14, Gerrit no longer supports digest authentication.
+Gerry uses basic authentication against gerrit.
+
+## Licence
+The MIT Licence
+
+Copyright (c) Fabian Mettler, Andrew Erickson, Travis Truman, Sebastian Schuberth, Orgad Shaneh
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+
+## References
+https://www.gerritcodereview.com/
+
+https://gerrit-review.googlesource.com/Documentation/rest-api.html

data/Rakefile

@@ -0,0 +1,7 @@
+require 'rspec/core/rake_task'
+require 'bundler/gem_tasks'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec
+

data/lib/gerry/api/access.rb

@@ -0,0 +1,17 @@
+require 'erb'
+
+module Gerry
+  module Api
+    module Access
+      # Get access rights for the specified project
+      #
+      # @param [VarArgs] projects the project names
+      # @return [Hash] the list of access rights
+      def access(*projects)
+        projects = projects.flatten.map { |name| ERB::Util.url_encode(name) }
+        url = "/access/?project=#{projects.join('&project=')}"
+        get(url)
+      end
+    end
+  end
+end

data/lib/gerry/api/accounts.rb

@@ -0,0 +1,38 @@
+module Gerry
+  module Api
+    module Accounts
+      # Get the account info for the specified account ID.
+      #
+      # @param [String] account_id the account.
+      # @return [Hash] the account info.
+      def account_info(account_id)
+        url = "/accounts/#{account_id}"
+        get(url)
+      end
+
+      # Get the global capabilities that are enabled for the calling user.
+      #
+      # @param [Array] options the query parameters.
+      # @return [Hash] the account capabilities.
+      def account_capabilities(options = [])
+        url = '/accounts/self/capabilities'
+
+        if options.empty?
+          return get(url)
+        end
+
+        options = map_options(options)
+        get("#{url}?#{options}")
+      end
+
+      # Get all groups that contain the specified account as a member
+      #
+      # @param [String] account_id the account
+      # @return [Enumberable] the groups
+      def groups_for_account(account_id)
+        url = "/accounts/#{account_id}/groups/"
+        get(url)
+      end
+    end
+  end
+end

data/lib/gerry/api/branches.rb

@@ -0,0 +1,45 @@
+# frozen_string_literal: true
+
+module Gerry
+  module Api
+    module Branches
+      ##
+      # Get the branches of project
+      #
+      def branches(project_name)
+        get("/projects/#{project_name}/branches")
+      end
+
+      # Get the projects that start with the specified prefix
+      # and accessible by the caller.
+      #
+      # @param [String] name the project name.
+      # @return [Hash] the projects.
+      def branch(project_name, branch_name)
+        get("/projects/#{project_name}/branches/#{branch_name}")
+      end
+
+      ##
+      # create branch that derived from branch name or revision
+      #
+      #  example: create_branch('foo', 'master', 'stable')
+      #           create_branch('foo', 'revision', 'stable')
+      #
+      def create_branch(project_name, source, branch)
+        # try source as ref
+        body = { ref: source }
+        put("/projects/#{project_name}/branches/#{branch}", body)
+      rescue Gerry::Api::Request::RequestError
+        # try source as revision
+        body = { revision: source }
+        put("/projects/#{project_name}/branches/#{branch}", body)
+      end
+
+      ##
+      # Gets the reflog of a certain branch.
+      def branch_reflog(project_name, branch, number)
+        get("/projects/#{project_name}/branches/#{branch}/reflog?n=#{number}")
+      end
+    end
+  end
+end

data/lib/gerry/api/changes.rb

@@ -0,0 +1,38 @@
+require 'cgi'
+
+module Gerry
+  module Api
+    module Changes
+      # Get changes visible to the caller.
+      #
+      # @param [Array] options the query parameters.
+      # @return [Hash] the changes.
+      def changes(options = [])
+        endpoint = '/changes/'
+        url = endpoint
+
+        if !options.empty?
+          url += '?' + map_options(options)
+        end
+
+        response = get(url)
+        return response if response.empty? || !response.last.delete('_more_changes')
+
+        # Get the original start parameter, if any, else start from 0.
+        query = URI.parse(url).query
+        query = query ? CGI.parse(query) : { 'S' => ['0'] }
+        start = query['S'].join.to_i
+
+        # Keep getting data until there are no more changes.
+        loop do
+          # Replace the start parameter, using the original start as an offset.
+          query['S'] = ["#{start + response.size}"]
+          url = endpoint + '?' + map_options(query)
+
+          response.concat(get(url))
+          return response if response.empty? || !response.last.delete('_more_changes')
+        end
+      end
+    end
+  end
+end

data/lib/gerry/api/groups.rb

@@ -0,0 +1,72 @@
+require 'json'
+
+module Gerry
+  module Api
+    module Groups
+      # Get all groups
+      #
+      # @return [Hash] the groups
+      def groups
+        url = '/groups/'
+        get(url)
+      end
+
+      # Get all members for a group
+      #
+      # @param [Array] options the query parameters
+      # @return [Array] the members
+      def group_members(group_id, options = [])
+        url = "/groups/#{group_id}/members/"
+
+        if options.empty?
+          return get(url)
+        end
+
+        options = map_options(options)
+        get("#{url}?#{options}")
+      end
+
+      # Get the directly included groups of a group
+      #
+      # @return [Array] the included groups
+      def included_groups(group_id)
+        url = "/groups/#{group_id}/groups/"
+        get(url)
+      end
+
+      # Create a new group
+      #
+      # @return [Hash] the group details
+      def create_group(name, description, visible, owner_id=nil)
+        url = "/groups/#{name}"
+        body = {
+          description: description,
+          visible_to_all: visible,
+        }
+        body[:owner_id] = owner_id unless owner_id.nil? || owner_id.empty?
+        put(url, body)
+      end
+
+      # Adds one or more users to a group
+      #
+      # @param [String] group_id the group id
+      # @param [Enumberable] users the list of users identified by email address
+      # @return [Hash] the account info details for each user added
+      def add_to_group(group_id, users)
+        url = "/groups/#{group_id}/members"
+        body = {
+          members: users
+        }
+        post(url, body)
+      end
+
+      def remove_from_group(group_id, users)
+        url = "/groups/#{group_id}/members.delete"
+        body = {
+          members: users
+        }
+        post(url, body)
+      end
+    end
+  end
+end

data/lib/gerry/api/projects.rb

@@ -0,0 +1,73 @@
+module Gerry
+  module Api
+    module Projects
+      # Get the projects accessible by the caller.
+      #
+      # @return [Hash] the projects.
+      def projects
+        get('/projects/')
+      end
+
+      # Get the projects that start with the specified prefix
+      # and accessible by the caller.
+      #
+      # @param [String] name the project name.
+      # @return [Hash] the projects.
+      def find_project(name)
+        get("/projects/#{name}")
+      end
+
+      # Get the symbolic HEAD ref for the specified project.
+      #
+      # @param [String] project the project name.
+      # @return [String] the current ref to which HEAD points to.
+      def get_head(project)
+        get("/projects/#{project}/HEAD")
+      end
+
+      # Set the symbolic HEAD ref for the specified project to
+      # point to the specified branch.
+      #
+      # @param [String] project the project name.
+      # @param [String] branch the branch to point to.
+      # @return [String] the new ref to which HEAD points to.
+      def set_head(project, branch)
+        url = "/projects/#{project}/HEAD"
+        body = {
+          ref: 'refs/heads/' + branch
+        }
+        put(url, body)
+      end
+
+      ##
+      # lists the access rights for signle project
+      def project_access(project)
+        get("/projects/#{project}/access")
+      end
+
+      def create_project_access(project, permissions)
+        access = {
+          'add' => permissions
+        }
+        post("/projects/#{project}/access", access)
+      end
+
+      def remove_project_access(project, permissions)
+        access = {
+          'remove' => permissions
+        }
+        post("/projects/#{project}/access", access)
+      end
+
+      ##
+      # Retrieves a commit of a project.
+      def project_commit(project, commit_id)
+        get("/projects/#{project}/commits/#{commit_id}")
+      end
+
+      def project_file(project, commit_id, file_id)
+        get("/projects/#{project}/commits/#{commit_id}/files/#{file_id}/content")
+      end
+    end
+  end
+end

data/lib/gerry/api/request.rb

@@ -0,0 +1,86 @@
+# frozen_string_literal: true
+
+module Gerry
+  module Api
+    module Request # :nodoc:
+      class RequestError < StandardError
+      end
+
+      # Get the mapped options.
+      #
+      # @param [Array] or [Hash] options the query parameters.
+      # @return [String] the mapped options.
+      def map_options(options)
+        if options.is_a?(Array)
+          options.map { |v| "#{v}" }.join('&')
+        elsif options.is_a?(Hash)
+          options.map { |k,v| "#{k}=#{v.join(',')}" }.join('&')
+        end
+      end
+
+      def options(body = nil, is_json = true)
+        return {} unless body
+        default_options = {
+          headers: {
+            'Content-Type' => is_json ? 'application/json' : 'text/plain'
+          }
+        }
+        default_options[:body] = is_json ? body.to_json : body
+        default_options
+      end
+
+      def get(url)
+        response = self.class.get(auth_url(url))
+        parse(response)
+      end
+
+      def auth_url(url)
+        self.class.default_options[:basic_auth] ? "/a#{url}" : url
+      end
+
+      def put(url, body = nil, is_json = true)
+        response = self.class.put(auth_url(url), options(body, is_json))
+        parse(response)
+      end
+
+      def post(url, body, is_json = true)
+        response = self.class.post(auth_url(url), options(body, is_json))
+        parse(response)
+      end
+
+      def delete(url)
+        response = self.class.delete(auth_url(url))
+        parse(response)
+      end
+
+      private
+
+      def parse(response)
+        unless /2[0-9][0-9]/.match(response.code.to_s)
+          raise_request_error(response)
+        end
+        return nil if !response.body || response.body.size.zero?
+
+        source = remove_magic_prefix(response.body)
+        if source.lines.count == 1 && !source.start_with?('{') && !source.start_with?('[')
+          # Work around the JSON gem not being able to parse top-level values, see
+          # https://github.com/flori/json/issues/206.
+          source.gsub!(/^"|"$/, '')
+        else
+          JSON.parse(source)
+        end
+      end
+
+      def raise_request_error(response)
+        raise RequestError.new("There was a request error! Response was: #{response.message}")
+      end
+
+      def remove_magic_prefix(response_body)
+        # We need to strip the magic prefix from the first line of the response, see
+        # https://gerrit-review.googlesource.com/Documentation/rest-api.html#output.
+        # magic prefix: )]}
+        response_body[4..-1].strip!
+      end
+    end
+  end
+end

data/lib/gerry/client.rb

@@ -0,0 +1,58 @@
+# frozen_string_literal: true
+
+require 'httparty'
+require 'json'
+
+require_relative 'api/access'
+require_relative 'api/accounts'
+require_relative 'api/changes'
+require_relative 'api/groups'
+require_relative 'api/projects'
+require_relative 'api/request'
+require_relative 'api/branches'
+
+
+module Gerry
+  ##
+  # Client for gerrit request api
+  #
+  # - for anonymout user
+  #  client = Gerry::Client.new('http://gerrit.example.com')
+  # - for user/password
+  #  client = Gerry::Client.new('http://gerrit.example.com', 'username', 'password')
+  #  
+  #   
+  
+  class Client
+    include HTTParty
+    headers 'Accept' => 'application/json'
+
+    include Api::Access
+    include Api::Accounts
+    include Api::Changes
+    include Api::Groups
+    include Api::Projects
+    include Api::Branches
+    include Api::Request
+
+    def set_auth_type(auth_type)
+      warn 'set_auth_type is deprecated. digest auth is no longer supported'
+    end
+
+    def initialize(url, username = nil, password = nil)
+      self.class.base_uri(url)
+
+      if username && password
+        @username = username
+        @password = password
+      else
+        require 'netrc'
+        @username, @password = Netrc.read[URI.parse(url).host]
+      end
+      if @username && @password
+        self.class.basic_auth(@username, @password)
+      end
+    end
+  end
+end
+

data/lib/gerry/version.rb

@@ -0,0 +1,5 @@
+module Gerry
+
+  VERSION = "0.1.6"
+
+end

data/lib/gerry.rb

@@ -0,0 +1,12 @@
+require_relative 'gerry/client'
+
+module Gerry
+  class << self  
+    # Alias for Gerry::Client.new
+    #
+    # @return [Gerry::Client]
+    def new(url, username = nil, password = nil)
+      Gerry::Client.new(url, username, password)
+    end
+  end
+end

data/spec/access_spec.rb

@@ -0,0 +1,15 @@
+require 'spec_helper'
+
+describe '.list_access_rights' do
+  it 'lists the access rights for projects' do
+    projects = ['All-Projects', 'MyProject']
+    stub = stub_get("/access/?project=#{projects.join('&project=')}", 'access_rights.json')
+
+    client = MockGerry.new
+    access_rights = client.access(projects)
+    expect(stub).to have_been_requested
+
+    expect(access_rights['All-Projects']['revision']).to eq('edd453d18e08640e67a8c9a150cec998ed0ac9aa')
+    expect(access_rights['MyProject']['revision']).to eq('61157ed63e14d261b6dca40650472a9b0bd88474')
+  end
+end

data/spec/accounts_spec.rb

@@ -0,0 +1,36 @@
+require 'spec_helper'
+
+describe '.account_capabilities' do
+  it 'should fetch all account capabilities' do
+    stub = stub_get('/accounts/self/capabilities', 'capabilities.json')
+
+    client = MockGerry.new
+    capabilities = client.account_capabilities
+
+    expect(capabilities['queryLimit']['min']).to eq(0)
+    expect(capabilities['queryLimit']['max']).to eq(500)
+  end
+
+  it 'should fetch some account capabilities' do
+    stub = stub_get('/accounts/self/capabilities?q=createAccount&q=createGroup', 'query_capabilities.json')
+
+    client = MockGerry.new
+    capabilities = client.account_capabilities(['q=createAccount', 'q=createGroup'])
+    expect(stub).to have_been_requested
+
+    expect(capabilities['createAccount']).to eq(true)
+    expect(capabilities['createGroup']).to eq(true)
+  end
+end
+
+describe '.groups_for_account' do
+  it "fetches all groups for which the account is a member" do
+    user = "jane.roe@example.com"
+
+    stub = stub_get("/accounts/#{user}/groups/", "account_groups.json")
+
+    client = MockGerry.new
+    new_group = client.groups_for_account(user)
+    expect(stub).to have_been_requested
+  end
+end

data/spec/branches_spec.rb

@@ -0,0 +1,36 @@
+require 'spec_helper'
+
+describe 'branches' do
+  before(:all) do
+    @client = MockGerry.new
+  end
+
+  it 'fetchs all branches' do
+    stub = stub_get('/projects/foo/branches', 'project_branches.json')
+
+    groups = @client.branches('foo')
+    expect(stub).to have_been_requested
+
+    expect(groups.size).to eq(3)
+    expect(groups.first.fetch('ref')).to eq('master')
+  end
+
+  it 'create branch' do
+    body = {
+      ref: 'master'
+    }
+    response = %Q<)]}'
+{
+  "ref": "/refs/heads/stable",
+  "revision": "b43",
+  "can_delete": true
+}
+>
+    stub = stub_put('/projects/foo/branches/stable', body, response)
+    branch = @client.create_branch('foo', 'master', 'stable')
+
+    expect(stub).to have_been_requested
+
+    expect(branch.fetch('ref')).to eql('/refs/heads/stable')
+  end
+end

data/spec/changes_spec.rb

@@ -0,0 +1,55 @@
+require 'spec_helper'
+
+describe '.changes' do
+  it 'should fetch all changes' do
+    stub = stub_get('/changes/', 'changes.json')
+
+    client = MockGerry.new
+    changes = client.changes
+
+    expect(stub).to have_been_requested
+
+    expect(changes[0]['project']).to eq('awesome')
+    expect(changes[0]['branch']).to eq('master')
+
+    expect(changes[1]['project']).to eq('clean')
+    expect(changes[1]['subject']).to eq('Refactor code')
+    expect(changes[1]['owner']['name']).to eq('Batman')
+  end
+
+  it 'should fetch all changes in batches' do
+    stub_batch_0 = stub_get('/changes/', 'changes_batch_0.json')
+    stub_batch_1 = stub_get('/changes/?S=1', 'changes_batch_1.json')
+    stub_batch_2 = stub_get('/changes/?S=2', 'changes_batch_2.json')
+
+    client = MockGerry.new
+    changes = client.changes
+
+    expect(stub_batch_0).to have_been_requested
+    expect(stub_batch_1).to have_been_requested
+
+    expect(changes[0]['project']).to eq('awesome')
+    expect(changes[0]['branch']).to eq('master')
+    expect(changes[0]['owner']['name']).to eq('The Duke')
+
+    expect(changes[1]['project']).to eq('clean')
+    expect(changes[1]['subject']).to eq('Refactor code')
+    expect(changes[1]['owner']['name']).to eq('Batman')
+
+    expect(changes[2]['project']).to eq('X')
+    expect(changes[2]['subject']).to eq('Remove unused imports')
+    expect(changes[2]['owner']['name']).to eq('Bill')
+  end
+
+  it 'should fetch all open changes' do
+    stub = stub_get('/changes/?q=is:open+owner:self', 'open_changes.json')
+
+    client = MockGerry.new
+    changes = client.changes(['q=is:open+owner:self'])
+
+    expect(stub).to have_been_requested
+
+    expect(changes[0]['status']).to eq('OPEN')
+    expect(changes[0]['owner']['name']).to eq('The Duke')
+  end
+end

data/spec/fixtures/README.md.json

@@ -0,0 +1,2 @@
+)]}'
+"Hello World!"