gerry 0.0.3 → 0.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 702aaae3f3f3ee526dbf3e7e4cc992abe99b7a31
-  data.tar.gz: 80dbe7f9b6e0bb8bfb26fa730cec895024dd4b4a
+  metadata.gz: b7d5a26248ca8569e79405d01127cc7e15a3e985
+  data.tar.gz: 1af2e09f12d470b7effd4ca6349fd926027345a5
 SHA512:
-  metadata.gz: c16e1ffe1e8cc8d9096b5ec7d7413c25e273436aa61203355dc86e48283a8e5cfd0388f08fce1657989c055f721068361aff111b123d21b0605cf62d7a3c58b4
-  data.tar.gz: a721f594ca1c4cc1a09c9854d180b9755e70d48c0d3ae9936308502efb7047def937325fb40c629855e2c87366de9352a9a4bae20a62b7c9f5efa92348fc2ada
+  metadata.gz: 1fa7b2004e3ee74dfb975fab016e168919f3e7192e4701d53d766f1b23def124fac756b8eaf4f8693fe2add30726e25b68980a8e96fd0955260e9a90a538ad6d
+  data.tar.gz: 2d7c4734217f7197607532c0f0d281cbf151c91496bb02f86222a0e5803130fccfe5aff6b1c16b4749fb156244eb46f40c7c3858ad64a98f5061f0a467e87c7f

data/lib/gerry/client/access.rb

@@ -0,0 +1,17 @@
+require 'erb'
+
+module Gerry
+  class Client
+    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/client/groups.rb

@@ -13,9 +13,24 @@ module Gerry
 
       # Get all members for a group
       #
+      # @param [Array] options the query parameters
       # @return [Array] the members
-      def group_members(group_id)
+      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
 

data/lib/gerry/client/projects.rb

@@ -7,8 +7,8 @@ module Gerry
       def projects
         get('/projects/')
       end
-      
-      # Get the projects that start with the specified prefix 
+
+      # Get the projects that start with the specified prefix
       # and accessible by the caller.
       #
       # @param [String] name the project name.
@@ -16,6 +16,28 @@ module Gerry
       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
     end
   end
-end
+end

data/lib/gerry/client/request.rb

@@ -27,14 +27,14 @@ module Gerry
       def put(url, body)
         if @username && @password
           auth = { username: @username, password: @password }
-          response = self.class.put("/a#{url}", 
-            body: body.to_json, 
+          response = self.class.put("/a#{url}",
+            body: body.to_json,
             headers: { 'Content-Type' => 'application/json' },
             digest_auth: auth
           )
           parse(response)
         else
-          response = self.class.put(url, 
+          response = self.class.put(url,
             body: body.to_json,
             headers: { 'Content-Type' => 'application/json' }
           )
@@ -45,14 +45,14 @@ module Gerry
       def post(url, body)
         if @username && @password
           auth = { username: @username, password: @password }
-          response = self.class.post("/a#{url}", 
-            body: body.to_json, 
+          response = self.class.post("/a#{url}",
+            body: body.to_json,
             headers: { 'Content-Type' => 'application/json' },
             digest_auth: auth
           )
           parse(response)
         else
-          response = self.class.post(url, 
+          response = self.class.post(url,
             body: body.to_json,
             headers: { 'Content-Type' => 'application/json' }
           )
@@ -65,21 +65,27 @@ module Gerry
           raise_request_error(response)
         end
         if response.body
-          JSON.parse(remove_magic_prefix(response.body))
+          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
         else
           nil
         end
       end
 
       def raise_request_error(response)
-        body = response.body
-        raise RequestError.new("There was a request error! Response was: #{body}")
+        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.
-        response_body.sub(/^\)\]\}'$/, '')
+        response_body.sub(/^\)\]\}'$/, '').strip!
       end
     end
   end

data/lib/gerry/client.rb

@@ -5,26 +5,28 @@ module Gerry
   class Client
     include HTTParty
     headers 'Accept' => 'application/json'
-    
+
+    require_relative 'client/access'
     require_relative 'client/accounts'
     require_relative 'client/changes'
     require_relative 'client/groups'
     require_relative 'client/projects'
     require_relative 'client/request'
-    
+
+    include Access
     include Accounts
     include Changes
     include Groups
     include Projects
     include Request
-    
+
     def initialize(url, username = nil, password = nil)
       self.class.base_uri(url)
-      
-      if username && password      
+
+      if username && password
         @username = username
         @password = password
       end
     end
   end
-end
+end

data/lib/gerry/version.rb

@@ -1,5 +1,5 @@
 module Gerry
 
-  VERSION = "0.0.3"
+  VERSION = "0.0.4"
 
 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/fixtures/access_rights.json

@@ -0,0 +1,250 @@
+)]}'
+{
+  "All-Projects": {
+    "revision": "edd453d18e08640e67a8c9a150cec998ed0ac9aa",
+    "local": {
+      "GLOBAL_CAPABILITIES": {
+        "permissions": {
+          "priority": {
+            "rules": {
+              "15bfcd8a6de1a69c50b30cedcdcc951c15703152": {
+                "action": "BATCH"
+              }
+            }
+          },
+          "streamEvents": {
+            "rules": {
+              "15bfcd8a6de1a69c50b30cedcdcc951c15703152": {
+                "action": "ALLOW"
+              }
+            }
+          },
+          "administrateServer": {
+            "rules": {
+              "53a4f647a89ea57992571187d8025f830625192a": {
+                "action": "ALLOW"
+              }
+            }
+          }
+        }
+      },
+      "refs/meta/config": {
+        "permissions": {
+          "submit": {
+            "rules": {
+              "53a4f647a89ea57992571187d8025f830625192a": {
+                "action": "ALLOW"
+              },
+              "global:Project-Owners": {
+                "action": "ALLOW"
+              }
+            }
+          },
+          "label-Code-Review": {
+            "label": "Code-Review",
+            "rules": {
+              "53a4f647a89ea57992571187d8025f830625192a": {
+                "action": "ALLOW",
+                "min": -2,
+                "max": 2
+              },
+              "global:Project-Owners": {
+                "action": "ALLOW",
+                "min": -2,
+                "max": 2
+              }
+            }
+          },
+          "read": {
+            "exclusive": true,
+            "rules": {
+              "53a4f647a89ea57992571187d8025f830625192a": {
+                "action": "ALLOW"
+              },
+              "global:Project-Owners": {
+                "action": "ALLOW"
+              }
+            }
+          },
+          "push": {
+            "rules": {
+              "53a4f647a89ea57992571187d8025f830625192a": {
+                "action": "ALLOW"
+              },
+              "global:Project-Owners": {
+                "action": "ALLOW"
+              }
+            }
+          }
+        }
+      },
+      "refs/for/refs/*": {
+        "permissions": {
+          "pushMerge": {
+            "rules": {
+              "global:Registered-Users": {
+                "action": "ALLOW"
+              }
+            }
+          },
+          "push": {
+            "rules": {
+              "global:Registered-Users": {
+                "action": "ALLOW"
+              }
+            }
+          }
+        }
+      },
+      "refs/tags/*": {
+        "permissions": {
+          "pushSignedTag": {
+            "rules": {
+              "53a4f647a89ea57992571187d8025f830625192a": {
+                "action": "ALLOW"
+              },
+              "global:Project-Owners": {
+                "action": "ALLOW"
+              }
+            }
+          },
+          "pushTag": {
+            "rules": {
+              "53a4f647a89ea57992571187d8025f830625192a": {
+                "action": "ALLOW"
+              },
+              "global:Project-Owners": {
+                "action": "ALLOW"
+              }
+            }
+          }
+        }
+      },
+      "refs/heads/*": {
+        "permissions": {
+          "forgeCommitter": {
+            "rules": {
+              "53a4f647a89ea57992571187d8025f830625192a": {
+                "action": "ALLOW"
+              },
+              "global:Project-Owners": {
+                "action": "ALLOW"
+              }
+            }
+          },
+          "forgeAuthor": {
+            "rules": {
+              "global:Registered-Users": {
+                "action": "ALLOW"
+              }
+            }
+          },
+          "submit": {
+            "rules": {
+              "53a4f647a89ea57992571187d8025f830625192a": {
+                "action": "ALLOW"
+              },
+              "global:Project-Owners": {
+                "action": "ALLOW"
+              }
+            }
+          },
+          "editTopicName": {
+            "rules": {
+              "53a4f647a89ea57992571187d8025f830625192a": {
+                "action": "ALLOW",
+                "force": true
+              },
+              "global:Project-Owners": {
+                "action": "ALLOW",
+                "force": true
+              }
+            }
+          },
+          "label-Code-Review": {
+            "label": "Code-Review",
+            "rules": {
+              "global:Registered-Users": {
+                "action": "ALLOW",
+                "min": -1,
+                "max": 1
+              },
+              "53a4f647a89ea57992571187d8025f830625192a": {
+                "action": "ALLOW",
+                "min": -2,
+                "max": 2
+              },
+              "global:Project-Owners": {
+                "action": "ALLOW",
+                "min": -2,
+                "max": 2
+              }
+            }
+          },
+          "create": {
+            "rules": {
+              "53a4f647a89ea57992571187d8025f830625192a": {
+                "action": "ALLOW"
+              },
+              "global:Project-Owners": {
+                "action": "ALLOW"
+              }
+            }
+          },
+          "push": {
+            "rules": {
+              "53a4f647a89ea57992571187d8025f830625192a": {
+                "action": "ALLOW"
+              },
+              "global:Project-Owners": {
+                "action": "ALLOW"
+              }
+            }
+          }
+        }
+      },
+      "refs/*": {
+        "permissions": {
+          "read": {
+            "rules": {
+              "global:Anonymous-Users": {
+                "action": "ALLOW"
+              },
+              "53a4f647a89ea57992571187d8025f830625192a": {
+                "action": "ALLOW"
+              }
+            }
+          }
+        }
+      }
+    },
+    "is_owner": true,
+    "owner_of": [
+      "GLOBAL_CAPABILITIES",
+      "refs/meta/config",
+      "refs/for/refs/*",
+      "refs/tags/*",
+      "refs/heads/*",
+      "refs/*"
+    ],
+    "can_upload": true,
+    "can_add": true,
+    "config_visible": true
+  },
+  "MyProject": {
+    "revision": "61157ed63e14d261b6dca40650472a9b0bd88474",
+    "inherits_from": {
+      "id": "All-Projects",
+      "name": "All-Projects",
+      "description": "Access inherited by all other projects."
+    },
+    "local": {},
+    "is_owner": true,
+    "owner_of": [
+      "refs/*"
+    ],
+    "can_upload": true,
+    "can_add": true,
+    "config_visible": true
+  }
+}

data/spec/fixtures/project_head.json

@@ -0,0 +1,2 @@
+)]}'
+"refs/heads/stable"

data/spec/fixtures/projects.json

@@ -1,9 +1,9 @@
 )]}'
 {
   "awesome": {
-  	 "description": "Awesome project"
+    "description": "Awesome project"
   },
   "clean": {
-  	 "description": "Clean code!"
+    "description": "Clean code!"
   }
 }

data/spec/projects_spec.rb

@@ -1,26 +1,54 @@
 require 'spec_helper'
 
-describe '.projects' do    
+describe '.projects' do
   it 'should fetch all projects' do
-    stub = stub_get('/projects/', 'projects.json')                     
-    
+    stub = stub_get('/projects/', 'projects.json')
+
     client = MockGerry.new
     projects = client.projects
-    
+
     expect(stub).to have_been_requested
-    
+
     expect(projects['awesome']['description']).to eq('Awesome project')
     expect(projects['clean']['description']).to eq('Clean code!')
   end
-  
+
   it 'should fetch a project' do
-    stub = stub_get('/projects/awesome', 'projects.json')                     
-    
+    stub = stub_get('/projects/awesome', 'projects.json')
+
     client = MockGerry.new
     projects = client.find_project('awesome')
-    
+
     expect(stub).to have_been_requested
-    
+
     expect(projects['awesome']['description']).to eq('Awesome project')
   end
-end
+
+  it 'should resolve the symbolic HEAD ref of a project' do
+    project = 'awesome'
+    stub = stub_get("/projects/#{project}/HEAD", 'project_head.json')
+
+    client = MockGerry.new
+    branch = client.get_head(project)
+
+    expect(stub).to have_been_requested
+
+    expect(branch).to eq('refs/heads/stable')
+  end
+
+  it 'should define the symbolic HEAD ref of a project' do
+    project = 'awesome'
+    branch = 'stable'
+    input = {
+      ref: 'refs/heads/' + branch
+    }
+    stub = stub_put("/projects/#{project}/HEAD", input.to_json, get_fixture('project_head.json'))
+
+    client = MockGerry.new
+    new_branch = client.set_head(project, branch)
+
+    expect(stub).to have_been_requested
+
+    expect(new_branch).to eq('refs/heads/' + branch)
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: gerry
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.0.4
 platform: ruby
 authors:
 - Fabian Mettler
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-06-12 00:00:00.000000000 Z
+date: 2015-08-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httparty
@@ -135,20 +135,24 @@ files:
 - Rakefile
 - lib/gerry.rb
 - lib/gerry/client.rb
+- lib/gerry/client/access.rb
 - lib/gerry/client/accounts.rb
 - lib/gerry/client/changes.rb
 - lib/gerry/client/groups.rb
 - lib/gerry/client/projects.rb
 - lib/gerry/client/request.rb
 - lib/gerry/version.rb
+- spec/access_spec.rb
 - spec/accounts_spec.rb
 - spec/changes_spec.rb
+- spec/fixtures/access_rights.json
 - spec/fixtures/account_groups.json
 - spec/fixtures/capabilities.json
 - spec/fixtures/changes.json
 - spec/fixtures/group_members.json
 - spec/fixtures/groups.json
 - spec/fixtures/open_changes.json
+- spec/fixtures/project_head.json
 - spec/fixtures/projects.json
 - spec/fixtures/query_capabilities.json
 - spec/groups_spec.rb
@@ -179,14 +183,17 @@ signing_key:
 specification_version: 4
 summary: Simple Ruby wrapper for the Gerrit Code Review REST-API.
 test_files:
+- spec/access_spec.rb
 - spec/accounts_spec.rb
 - spec/changes_spec.rb
+- spec/fixtures/access_rights.json
 - spec/fixtures/account_groups.json
 - spec/fixtures/capabilities.json
 - spec/fixtures/changes.json
 - spec/fixtures/group_members.json
 - spec/fixtures/groups.json
 - spec/fixtures/open_changes.json
+- spec/fixtures/project_head.json
 - spec/fixtures/projects.json
 - spec/fixtures/query_capabilities.json
 - spec/groups_spec.rb