labclient 0.1.1 → 0.2.0

data/lib/labclient/projects/snippets/project_snippet.rb

@@ -35,6 +35,14 @@ module LabClient
       client.projects.snippets.delete(project_id, id)
     end
 
+    def notes
+      client.notes.snippets.list(project_id, id)
+    end
+
+    def note_create(query)
+      client.notes.snippets.create(project_id, id, query)
+    end
+
     date_time_attrs %i[updated_at created_at]
 
     user_attrs %i[author]
@@ -45,6 +53,10 @@ module LabClient
       option 'agent_detail', 'Hash of user agent details.'
       option 'delete', 'Delete this deploy key.'
       option 'update', 'Update this this deploy key.'
+
+      # Notes
+      option 'notes', 'List notes/comments. [Hash]'
+      option 'note_create', 'Creates a new note. [Hash]'
     end
   end
 end

data/lib/labclient/protected_branches/protect.rb

@@ -19,11 +19,12 @@ module LabClient
         | allowed_to_unprotect          | array          | no  | **(STARTER)** Array of access levels allowed to unprotect, with each described by a hash |
         | code_owner_approval_required  | boolean        | no  | **(PREMIUM)** Prevent pushes to this branch if it matches an item in the CODEOWNERS file (defaults: false) |
 
-        *Valid access levels*
-        0  => No access, :none
-        30 => Developer access, :developer
-        40 => Maintainer access, :maintainer
-        60 => Admin access, :admin
+        **Valid access levels**
+
+        - 0, :none  => No access
+        - 30, :developer => Developer access
+        - 40, :maintainer => Maintainer access
+        - 60, :admin => Admin access
 
       DOC
     end

data/lib/labclient/protected_environments/list.rb

@@ -0,0 +1,29 @@
+# Top namespace
+module LabClient
+  # Specifics
+  class ProtectedEnvironments < Common
+    doc 'List' do
+      desc 'Gets a list of protected environmentes from a project. [Project ID, String]'
+      example 'client.protected_environments.list(36)'
+      result '[#<ProtectedEnvironment name: prod>]'
+
+      markdown <<~DOC
+        Search: You can use ^term and term$ to find environmentes that begin and end with term respectively.
+      DOC
+    end
+
+    doc 'List' do
+      desc 'via Project'
+      example <<~DOC
+        project = client.projects.show(264)
+        project.protected_environments
+      DOC
+    end
+
+    def list(project_id)
+      project_id = format_id(project_id)
+
+      client.request(:get, "projects/#{project_id}/protected_environments", ProtectedEnvironment)
+    end
+  end
+end

data/lib/labclient/protected_environments/protect.rb

@@ -0,0 +1,53 @@
+# Top namespace
+module LabClient
+  # Specifics
+  class ProtectedEnvironments < Common
+    doc 'Protect' do
+      desc 'Protects a single environment [Project ID, Hash]'
+      example <<~DOC
+        client.protected_environments.protect(36,
+          name: :prod,
+          deploy_access_levels: [
+            { access_level: :developer }
+          ]
+        )
+      DOC
+      result '#<ProtectedEnvironment name: prod>'
+
+      markdown <<~DOC
+        | Attribute            | Type           | Required | Description                                                                                                      |
+        | -------------------- | -------------- | -------- | ---------------------------------------------------------------------------------------------------------------- |
+        | name                 | string         | yes      | The name of the environment.                                                                                     |
+        | deploy_access_levels | array          | yes      | Array of access levels allowed to deploy, with each described by a hash.                                         |
+
+        Elements in the deploy_access_levels array should take the form {user_id: integer}, {group_id: integer} or {access_level: integer}. Each user must have access to the project and each group must have this project shared.
+
+        **Valid access levels**
+
+        | Access Level | Values          |
+        | ------------ | --------------- |
+        | Developer    | 30, :developer  |
+        | Maintainer   | 40, :maintainer |
+        | Admin        | 60, :admin      |
+
+      DOC
+    end
+
+    doc 'Protect' do
+      desc 'via Project'
+      example <<~DOC
+        project = client.projects.show(264)
+        project.protect_environment(name: :other, push_access_level: :admin)
+      DOC
+    end
+
+    def protect(project_id, query)
+      query[:deploy_access_levels].each do |access_level|
+        protected_query_access_level(access_level, :access_level)
+      end
+
+      project_id = format_id(project_id)
+      client.request(:post, "projects/#{project_id}/protected_environments", ProtectedEnvironment, query)
+    end
+  end
+end

data/lib/labclient/protected_environments/protected_environment.rb

@@ -0,0 +1,22 @@
+# Top namespace
+module LabClient
+  # Inspect Helper
+  class ProtectedEnvironment < Klass
+    include ClassHelpers
+    def inspect
+      "#<ProtectedEnvironment name: #{name}>"
+    end
+
+    def unprotect
+      project_id = collect_project_id
+
+      client.protected_environments.unprotect(project_id, name)
+    end
+
+    help do
+      subtitle 'ProjectEnvironment'
+      option 'project', 'Show Project'
+      option 'unprotect', 'Remove protected environment'
+    end
+  end
+end

data/lib/labclient/protected_environments/show.rb

@@ -0,0 +1,24 @@
+# Top namespace
+module LabClient
+  # Specifics
+  class ProtectedEnvironments < Common
+    doc 'Show' do
+      desc 'Gets a single protected environment [Project ID, ProtectedEnvironment]'
+      example 'client.protected_environments.show(36, :prod)'
+      result '#<ProtectedEnvironment name: prod>'
+    end
+
+    doc 'Show' do
+      desc 'via Project'
+      example <<~DOC
+        project = client.projects.show(264)
+        project.protected_environment(:master)
+      DOC
+    end
+
+    def show(project_id, environment_id)
+      project_id = format_id(project_id)
+      client.request(:get, "projects/#{project_id}/protected_environments/#{environment_id}", ProtectedEnvironment)
+    end
+  end
+end

data/lib/labclient/protected_environments/unprotect.rb

@@ -0,0 +1,31 @@
+# Top namespace
+module LabClient
+  # Specifics
+  class ProtectedEnvironments < Common
+    doc 'Unprotect' do
+      desc 'Unprotects the given protected environment [Project ID, ProtectedEnvironment]'
+      example 'client.protected_environments.unprotect(264, :prod)'
+    end
+
+    doc 'Unprotect' do
+      desc 'via Project'
+      example <<~DOC
+        project = client.projects.show(264)
+        project.unprotect_environment(:other)
+      DOC
+    end
+
+    doc 'Unprotect' do
+      desc 'via ProtectedEnvironment'
+      example <<~DOC
+        protected_env = client.protected_environments.show(36, :prod)
+        protected_env.unprotect
+      DOC
+    end
+
+    def unprotect(project_id, environment_id)
+      project_id = format_id(project_id)
+      client.request(:delete, "projects/#{project_id}/protected_environments/#{environment_id}")
+    end
+  end
+end

data/lib/labclient/snippets/snippet.rb

@@ -32,8 +32,8 @@ module LabClient
       subtitle 'Snippet'
       option 'raw', 'Retrieves the raw snippet content.'
       option 'agent_detail', 'Hash of user agent details.'
-      option 'delete', 'Delete this deploy key.'
-      option 'update', 'Update this this deploy key.'
+      option 'delete', 'Delete this snippet.'
+      option 'update', 'Update this this snippet.'
     end
   end
 end

data/lib/labclient/users/membership.rb

@@ -0,0 +1,62 @@
+# Top namespace
+module LabClient
+  # Inspect Helper
+  class Membership < Klass
+    include ClassHelpers
+    include AccessLevel
+
+    def inspect
+      "#<Membership name: #{source_name}, access: #{level}>"
+    end
+
+    def parent
+      case source_type
+      when 'Project'
+        client.projects.show(source_id)
+      when 'Namespace'
+        client.groups.show(source_id)
+      end
+    end
+
+    def level
+      human_access_level(access_level)
+    end
+
+    def guest?
+      level == :guest
+    end
+
+    def reporter?
+      level == :reporter
+    end
+
+    def developer?
+      level == :developer
+    end
+
+    def maintainer?
+      level == :maintainer
+    end
+
+    def owner?
+      level == :owner
+    end
+
+    def greater_than(leveler)
+      case leveler
+      when Symbol
+        access_level > machine_access_level(leveler)
+      when Integer
+        access_level > leveler
+      end
+    end
+
+    help do
+      subtitle 'Membership'
+      option 'level', 'Humanized symbol of access level. e.g. :developer'
+      option 'parent', 'Collect project/namespace for this membership'
+      option '<permission>?', 'True/False evaluation each guest?, developer? etc'
+      option 'greater_than', 'True/False if user has greater than [Permission Name]'
+    end
+  end
+end

data/lib/labclient/users/memberships.rb

@@ -7,7 +7,9 @@ module LabClient
       desc 'Lists all projects and groups a user is a member of. [User ID, Type]'
 
       markdown <<~DOC
-        Filter memberships by type. Can be either Project or Namespace
+        | Attribute | Type   | Required | Description                                                    |
+        | --------- | ------ | -------- | -------------------------------------------------------------- |
+        | type      | string | no       | Filter memberships by type. Can be either Project or Namespace |
       DOC
 
       example 'client.users.memberships(1)'
@@ -26,9 +28,12 @@ module LabClient
       DOC
     end
 
-    def memberships(user_id, type = 'Project')
+    def memberships(user_id, type = nil)
       user_id = format_id(user_id)
-      client.request(:get, "users/#{user_id}/memberships", nil, { from: type })
+
+      query = nil
+      query = { type: type } if type
+      client.request(:get, "users/#{user_id}/memberships", Membership, query)
     end
   end
 end

data/lib/labclient/users/user.rb

@@ -101,10 +101,20 @@ module LabClient
       client.impersonation_tokens.show(id, token_id)
     end
 
-    def memberships(type = 'Project')
+    def memberships(type = nil)
       client.users.memberships(id, type)
     end
 
+    # Events
+    def events(query = {})
+      client.events.user(id, query)
+    end
+
+    # Reload Helper
+    def reload
+      update_self client.users.show(id)
+    end
+
     help do
       # @group_name = 'Users'
       subtitle 'User'
@@ -128,11 +138,13 @@ module LabClient
       option 'emails', 'List user emails'
       option 'email_create', 'Create email for user [Email Address]'
       option 'email_delete', 'Delete email for user [Email ID]'
+      option 'events', 'List user events [Hash]'
       option 'impersonation_tokens', 'List impersonation tokesn for user [Filter(Optional)]'
       option 'impersonation_token_create', 'Create impersonation tokesn [Hash]'
       option 'impersonation_token_revoke', 'Revoke impersonation tokesn [Token ID]'
       option 'impersonation_token', 'Show impersonation tokesn [Token ID]'
       option 'memberships', 'Lists all projects and groups a user is a member of [String/Type]'
+      option 'reload', 'Reload this object (New API Call)'
     end
   end
 end

data/lib/labclient/version.rb

@@ -1,3 +1,3 @@
 module LabClient
-  VERSION = '0.1.1'.freeze
+  VERSION = '0.2.0'.freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: labclient
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.2.0
 platform: ruby
 authors:
 - Davin Walker
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-06-04 00:00:00.000000000 Z
+date: 2020-08-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -25,19 +25,19 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '6.0'
 - !ruby/object:Gem::Dependency
-  name: awesome_print
+  name: amazing_print
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '1.8'
+        version: '1.2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '1.8'
+        version: '1.2'
 - !ruby/object:Gem::Dependency
   name: gitlab_chronic_duration
   requirement: !ruby/object:Gem::Requirement
@@ -108,6 +108,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '1.16'
+- !ruby/object:Gem::Dependency
+  name: faker
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.12'
 - !ruby/object:Gem::Dependency
   name: minitest
   requirement: !ruby/object:Gem::Requirement
@@ -295,6 +309,7 @@ files:
 - lib/labclient/awards/snippets/list.rb
 - lib/labclient/awards/snippets/show.rb
 - lib/labclient/branches/branch.rb
+- lib/labclient/branches/create.rb
 - lib/labclient/branches/delete.rb
 - lib/labclient/branches/delete_merged.rb
 - lib/labclient/branches/list.rb
@@ -387,6 +402,13 @@ files:
 - lib/labclient/files/delete.rb
 - lib/labclient/files/show.rb
 - lib/labclient/files/update.rb
+- lib/labclient/generator/generator.rb
+- lib/labclient/generator/names.rb
+- lib/labclient/generator/template_helper.rb
+- lib/labclient/generator/templates/environments.rb
+- lib/labclient/generator/templates/pages.rb
+- lib/labclient/generator/templates/pipeline_trigger.rb
+- lib/labclient/generator/wizard.rb
 - lib/labclient/groups/access_requests/access_request.rb
 - lib/labclient/groups/access_requests/approve.rb
 - lib/labclient/groups/access_requests/client.rb
@@ -490,6 +512,7 @@ files:
 - lib/labclient/keys/show.rb
 - lib/labclient/keys/user.rb
 - lib/labclient/klass.rb
+- lib/labclient/lab_struct.rb
 - lib/labclient/license/add.rb
 - lib/labclient/license/delete.rb
 - lib/labclient/license/license.rb
@@ -560,7 +583,6 @@ files:
 - lib/labclient/notes/snippets/update.rb
 - lib/labclient/notifications/list.rb
 - lib/labclient/notifications/update.rb
-- lib/labclient/open_struct.rb
 - lib/labclient/overview.rb
 - lib/labclient/paginated_response.rb
 - lib/labclient/pipelines/cancel.rb
@@ -744,6 +766,11 @@ files:
 - lib/labclient/protected_branches/protect.rb
 - lib/labclient/protected_branches/show.rb
 - lib/labclient/protected_branches/unprotect.rb
+- lib/labclient/protected_environments/list.rb
+- lib/labclient/protected_environments/protect.rb
+- lib/labclient/protected_environments/protected_environment.rb
+- lib/labclient/protected_environments/show.rb
+- lib/labclient/protected_environments/unprotect.rb
 - lib/labclient/protected_tags/list.rb
 - lib/labclient/protected_tags/protect.rb
 - lib/labclient/protected_tags/show.rb
@@ -838,6 +865,7 @@ files:
 - lib/labclient/users/keys/list.rb
 - lib/labclient/users/keys/show.rb
 - lib/labclient/users/list.rb
+- lib/labclient/users/membership.rb
 - lib/labclient/users/memberships.rb
 - lib/labclient/users/search.rb
 - lib/labclient/users/show.rb
@@ -859,7 +887,7 @@ homepage: https://gitlab.com/labclient/labclient
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -875,7 +903,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubygems_version: 3.0.3
-signing_key: 
+signing_key:
 specification_version: 4
 summary: Gitlab API Client
 test_files: []