labclient 0.3.0 → 0.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a747d261d131d7f0a228cb02753e21798c951393941247d0d4252a9c253c5650
-  data.tar.gz: 228a9181e7345f607e8d4ab6617d729f9b4b44ab7e1fdcd295db4ed3332a257d
+  metadata.gz: 0c77fa948bc39c9ec7d677340949a7bc52ed03999c4cb5286d125154edb06f9b
+  data.tar.gz: fa96ed5df9a9ddf7eea56cd7eb7a34832b4a9509d982159fd8069c5ae49de241
 SHA512:
-  metadata.gz: 2d66d602d12ccd265ae6b1e5aa28c0cdeabbbcc0ee678c5be80a30c42ef342e7b9308acf0a075da04cd4bbb76c744ce32d52122e0f4b87c36c9a9faf09b7834a
-  data.tar.gz: c3eaf2cb6c83effec491f071bf0e5de9f2638f68d0af5656ae146915245eb00b091d7a566ef6c28c88db562a9b71cf8b773798fd7890693b098fbc66bdfd9adb
+  metadata.gz: 2148330fb1c533956e2f51085729c7c8e96b8fc27e21b43bbbac2b492906047bc52d964b203fe42ac86fc2f041310ab6c6b4e7f90ae5935efcedaf11674a4363
+  data.tar.gz: 004cbd92b60fd45996a4ecd9ae38039b3bae703a22f4d804e34390a56662a0f0859992295a83bf0d53f7e4e6191e2c9f416fcc4b7618e54e1b944c73aa4478fc

data/lib/labclient.rb

@@ -857,6 +857,12 @@ require 'labclient/resource_labels/merge_requests/client'
 require 'labclient/resource_labels/merge_requests/list'
 require 'labclient/resource_labels/merge_requests/show'
 
+# Feature Flags
+require 'labclient/feature_flags/create'
+require 'labclient/feature_flags/delete'
+require 'labclient/feature_flags/list'
+require 'labclient/feature_flags/feature_flag'
+
 require 'labclient/resource_labels/resource_label'
 
 # Generators

data/lib/labclient/client.rb

@@ -37,8 +37,8 @@ module LabClient
       discussions: Discussions,
       epics: Epics,
       events: Events,
+      feature_flags: FeatureFlags,
       files: Files,
-      wizard: Generator::Wizard,
       groups: Groups,
       impersonation_tokens: ImpersonationTokens,
       issues: Issues,
@@ -69,7 +69,8 @@ module LabClient
       todos: Todos,
       users: Users,
       version: Version,
-      wikis: Wikis
+      wikis: Wikis,
+      wizard: Generator::Wizard
     }
 
     @subclasses.each do |name, obj|
@@ -116,6 +117,10 @@ module LabClient
       self.http = HTTP.new(@settings)
     end
 
+    def base_url
+      "#{settings[:url]}/api/v4/"
+    end
+
     def prompt_for_url
       print 'Enter GitLab URL (e.g. https://gitlab.com): '
       @settings[:url] = $stdin.gets.chomp

data/lib/labclient/feature_flags/create.rb

@@ -0,0 +1,48 @@
+# Top namespace
+module LabClient
+  # Specifics
+  class FeatureFlags < Common
+    doc 'Create' do
+      title 'Set or create a feature'
+      example 'client.feature_flags.create(:create_eks_clusters, value: true)'
+      result <<~DOC
+        => #<FeatureFlag name: create_eks_clusters, state: on
+      DOC
+    end
+
+    doc 'Attributes' do
+      desc 'Register a new Application'
+      markdown <<~DOC
+        | Attribute | Type | Required | Description |
+        | --------- | ---- | -------- | ----------- |
+        | name | string | yes | Name of the feature to create or update |
+        | value | integer/string | yes | `true` or `false` to enable/disable, or an integer for percentage of time |
+        | feature_group | string | no | A Feature group name |
+        | user | string | no | A GitLab username |
+        | group | string | no | A GitLab group's path, for example gitlab-org |
+        | project | string | no | A projects path, for example gitlab-org/gitlab-foss |
+
+         Note that you can enable or disable a feature for a `feature_group`, a `user`,
+         a `group`, and a `project` in a single API call.
+      DOC
+    end
+
+    doc 'Create' do
+      example <<~DOC
+        client.applications.create(
+          name: "Grafana",
+          redirect_uri: "https://gitlab.com/-/grafana/login/gitlab",
+          scopes: "email"
+        )
+      DOC
+      result <<~DOC
+        #<Application id: 11, Grafana>
+      DOC
+    end
+
+    # Create
+    def create(name, query = {})
+      client.request(:post, "features/#{name}", FeatureFlag, query)
+    end
+  end
+end

data/lib/labclient/feature_flags/delete.rb

@@ -0,0 +1,23 @@
+# Top namespace
+module LabClient
+  # Specifics
+  class FeatureFlags < Common
+    doc 'Delete' do
+      title 'Delete a feature'
+      example 'client.feature_flags.delete(:name)'
+    end
+
+    doc 'Delete' do
+      desc 'Delete via FeatureFlag'
+      example <<~DOC
+        feature = client.feature_flags.list.first
+        feature.delete
+      DOC
+    end
+
+    # Delete
+    def delete(name)
+      client.request(:delete, "features/#{name}")
+    end
+  end
+end

data/lib/labclient/feature_flags/feature_flag.rb

@@ -0,0 +1,35 @@
+# Top namespace
+module LabClient
+  # Inspect Helper
+  class FeatureFlag < Klass
+    include ClassHelpers
+    def inspect
+      "#<FeatureFlag name: #{name}, state: #{state}>"
+    end
+
+    def delete
+      client.feature_flags.delete name
+    end
+
+    def update(query)
+      update_self client.feature_flags.create(name, query)
+    end
+
+    def toggle
+      if state == 'off'
+        update(value: true)
+      else
+        update(value: false)
+      end
+    end
+
+    date_time_attrs %i[created_at]
+
+    help do
+      subtitle 'Feature Flag'
+      option 'delete', 'Delete this specific feature flag'
+      option 'toggle', 'Disable / Turn on feature'
+      option 'update', 'Create flag / Update with values [Hash]'
+    end
+  end
+end

data/lib/labclient/feature_flags/list.rb

@@ -0,0 +1,49 @@
+# Top namespace
+module LabClient
+  # Specifics
+  class FeatureFlags < Common
+    doc 'List' do
+      title 'List all features'
+      desc 'Get a list of all persisted features, with its gate values.'
+      example 'client.feature_flags.list'
+      result <<~DOC
+        =>  [#<Feature name: create_eks_clusters, state: on>]
+      DOC
+    end
+
+    doc 'List' do
+      title 'View detail of features'
+      desc 'Retrieve detailed information of feature flags'
+      example 'client.feature_flags.list.each(&:verbose)'
+      result <<~DOC
+        LabClient::Feature {
+                            :name => "create_eks_clusters",
+                            :state => "on",
+                            :gates => [
+                              [0] OpenStruct {
+                                    :key => "boolean",
+                                    :value => true
+                              }
+                            ]
+        }
+        => [#<Feature name: create_eks_clusters, state: on>]
+      DOC
+    end
+
+    doc 'List' do
+      title 'Toggle all features on or off'
+      example <<~DOC
+        client.feature_flags.list.each(&:toggle)
+      DOC
+      result <<~DOC
+        [#<Feature name: create_eks_clusters, state: off>,
+         #<Feature name: merge_train1, state: off>,
+         #<Feature name: merge_train2, state: off>]
+      DOC
+    end
+
+    def list
+      client.request(:get, 'features', FeatureFlag)
+    end
+  end
+end

data/lib/labclient/generator/generator.rb

@@ -26,6 +26,16 @@ module LabClient
         example 'gem install faker'
       end
 
+      doc 'Wizard' do
+        title 'Quickstart'
+        desc 'To run, create the client/wizard and run!'
+        example <<~DOC
+          require 'labclient'
+          client = LabClient::Client.new(url: 'https://labclient', token: 'super_secret')
+          client.wizard.run!
+        DOC
+      end
+
       doc 'Wizard' do
         title 'Client'
         desc <<-DOC

data/lib/labclient/klass.rb

@@ -61,7 +61,12 @@ module LabClient
 
     # TODO: Combine all of these?
     def collect_project_id(position = 1)
-      response.path.split('/')[position]
+      # Check if Path / Pagination will be blank
+      if response.path.nil?
+        response.request.base_url.split(@client.base_url, 2)[position]
+      else
+        response.path.split('/')[position]
+      end
     end
 
     alias collect_group_id collect_project_id

data/lib/labclient/overview.rb

@@ -8,11 +8,20 @@ module LabClient
     doc 'Overview' do
       title 'About'
       markdown <<~DOC
-        Labclient is another Gitlab API Gem. A focus on ease of use and helpers and snippets.
+        LabClient is a Gitlab API Gem. Focusing on ease of use, documentation, helpers, and snippets.
 
-        <a href="https://github.com/NARKOZ/gitlab">Gitlab</a> is an excellent gem, and is nearly complete in its implementation. While this is still a work in progress and you are looking for general use you should use it.
+        - Objects for resources (User, Project)
+        - Method Chaining ( project.branch(:master).pipelines ) 
+        
+        Lots of Helpers
+        
+        - Pagination
+        - IRB/Pry
+        - Setup: credentials file, profiles, and prompt
+        - Permission Levels
+        - Curl generator
 
-        Here's a quick whirlwind example of some of the features:
+        Here is a quick whirlwind example of some of the features:
       DOC
 
       demo '350689'

data/lib/labclient/version.rb

@@ -1,3 +1,3 @@
 module LabClient
-  VERSION = '0.3.0'.freeze
+  VERSION = '0.3.1'.freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: labclient
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.3.1
 platform: ruby
 authors:
 - Davin Walker
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-09-17 00:00:00.000000000 Z
+date: 2020-10-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -398,6 +398,10 @@ files:
 - lib/labclient/events/list.rb
 - lib/labclient/events/project.rb
 - lib/labclient/events/user.rb
+- lib/labclient/feature_flags/create.rb
+- lib/labclient/feature_flags/delete.rb
+- lib/labclient/feature_flags/feature_flag.rb
+- lib/labclient/feature_flags/list.rb
 - lib/labclient/files/create.rb
 - lib/labclient/files/delete.rb
 - lib/labclient/files/show.rb
@@ -909,7 +913,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
+rubygems_version: 3.1.4
 signing_key:
 specification_version: 4
 summary: Gitlab API Client