labclient 0.3.1 → 0.4.0

data/lib/labclient/client/meta.rb

@@ -0,0 +1,81 @@
+# Top Namespace
+module LabClient
+  # Variables / Meta
+  class Client
+    # include HTTParty
+    attr_accessor :settings, :resp, :klass, :link, :http, :delay, :retries, :path
+
+    def inspect
+      "#<LabClient::Client url: \"#{@settings[:url]}\">"
+    end
+
+    # Helper to make subclasses directly accessible
+    def subclasses
+      self.class.instance_variable_get(:@subclasses)
+    end
+
+    # ----------
+    # Alias List
+    # approvals == merge_request_approvals
+    # repo == repository
+    # ----------
+    @subclasses = {
+      appearance: Appearances,
+      application_settings: ApplicationSettings,
+      application_statistics: ApplicationStatistics,
+      applications: Applications,
+      approvals: Approvals,
+      audit_events: AuditEvents,
+      avatar: Avatars,
+      awards: Awards,
+      branches: Branches,
+      broadcast_messages: BroadcastMessages,
+      ci_lint: CiLint,
+      commits: Commits,
+      deploy_keys: DeployKeys,
+      discussions: Discussions,
+      epics: Epics,
+      events: Events,
+      feature_flags: FeatureFlags,
+      files: Files,
+      groups: Groups,
+      impersonation_tokens: ImpersonationTokens,
+      issues: Issues,
+      jobs: Jobs,
+      keys: Keys,
+      license: Licenses,
+      markdown: Markdown,
+      members: Members,
+      merge_request_approvals: Approvals,
+      merge_requests: MergeRequests,
+      namespaces: Namespaces,
+      notes: Notes,
+      notifications: Notifications,
+      pipelines: Pipelines,
+      project_runners: ProjectRunners,
+      projects: Projects,
+      protected_branches: ProtectedBranches,
+      protected_environments: ProtectedEnvironments,
+      protected_tags: ProtectedTags,
+      registry: Registry,
+      repo: Repositories,
+      repository: Repositories,
+      resource_labels: ResourceLabels,
+      runners: Runners,
+      snippets: Snippets,
+      system_hooks: SystemHooks,
+      tags: Tags,
+      todos: Todos,
+      users: Users,
+      version: Version,
+      wikis: Wikis,
+      wizard: Generator::Wizard
+    }
+
+    @subclasses.each do |name, obj|
+      define_method(name) do
+        obj.new(self)
+      end
+    end
+  end
+end

data/lib/labclient/client/setup.rb

@@ -0,0 +1,52 @@
+# Top Namespace
+module LabClient
+  # Methods for Initialization
+  module ClientSetup
+    # Load default profile
+    def fill_configuration
+      if File.exist? home_file
+        Oj.load_file(home_file, { symbol_keys: true })
+      else
+        {
+          url: ENV['LABCLIENT_URL'],
+          token: ENV['LABCLIENT_TOKEN']
+        }
+      end
+    end
+
+    # If nothing entered Prompt for Input
+    def prompt_for_url
+      print 'Enter GitLab URL (e.g. https://gitlab.com): '
+      @settings[:url] = $stdin.gets.chomp
+      raise 'LabClient Error - Missing URL!' if @settings[:url].blank?
+    end
+
+    # Check for Token
+    def prompt_for_token
+      print 'Enter Personal Access Token: '
+      @settings[:token] = $stdin.gets.chomp
+    end
+
+    # Fill Defaults
+    def unspecified_defaults
+      @settings[:paginate] = true if @settings[:paginate].nil?
+      @settings[:ssl_verify] = true if @settings[:ssl_verify].nil?
+      @settings[:quiet] = false if @settings[:quiet].nil?
+      @settings[:debug] = false if @settings[:quiet].nil?
+      @settings[:debug] = false if @settings[:debug].nil?
+      @settings[:token_type] = 'Private-Token' if @settings[:token_type].nil?
+      @settings[:retry] = { max: 5, delay_factor: 1, count: 0 } if @settings[:retry].nil?
+    end
+
+    # Support for Named Profiles
+    def setup_profile
+      return false unless File.exist? home_file
+
+      config = Oj.load_file(home_file, { symbol_keys: true })
+      return false unless config.key? profile
+
+      self.settings ||= {}
+      settings.merge! config[profile]
+    end
+  end
+end

data/lib/labclient/common.rb

@@ -47,8 +47,13 @@ module LabClient
     end
 
     # Category and Primary Key for docs
+    # If/Else for Instance Variable Warnings
     def group_name
-      self.class.instance_variable_get('@group_name') || klass
+      if self.class.instance_variable_defined? '@group_name'
+        self.class.instance_variable_get('@group_name')
+      else
+        klass
+      end
     end
 
     def inspect
@@ -70,7 +75,7 @@ module LabClient
       return nil if obj_id.nil?
 
       # Already a Integer
-      return obj_id if obj_id.class == Integer
+      return obj_id if obj_id.instance_of?(Integer)
 
       # If LabClient Object, send ID
       return obj_id.id if obj_id.class.module_parent_name == 'LabClient'
@@ -107,7 +112,7 @@ module LabClient
     # :developer => 30
     # :owner => 50
     def query_access_level(query, key = :group_access)
-      query[key] = machine_access_level query[key] if query.key?(key) && query[key].class == Symbol
+      query[key] = machine_access_level query[key] if query.key?(key) && query[key].instance_of?(Symbol)
     end
 
     # TODO: See if these are even needed
@@ -118,7 +123,7 @@ module LabClient
     # 40 => Maintainer access
     # 60 => Admin access
     def protected_query_access_level(query, key = :push_access_level)
-      query[key] = machine_protected_access_level query[key] if query.key?(key) && query[key].class == Symbol
+      query[key] = machine_protected_access_level query[key] if query.key?(key) && query[key].instance_of?(Symbol)
     end
   end
 end

data/lib/labclient/docs.rb

@@ -72,8 +72,13 @@ module LabClient
     end
 
     # Allow for Custom Group Name Overrides
+    # Ruby warning of uninitialized variables
     def group_name
-      @group_name || name.split('::', 2).last.split(/(?=[A-Z])/).join(' ')
+      if defined? @group_name
+        @group_name
+      else
+        name.split('::', 2).last.split(/(?=[A-Z])/).join(' ')
+      end
     end
 
     # Helper to Make navigation rendered out once rather than evaluated on Ember

data/lib/labclient/epics/issues/remove.rb

@@ -29,7 +29,7 @@ module LabClient
       epic_id = format_id(epic_id)
 
       # This is horrible, but has to be the epic_issue_id, not the issue's id or iid
-      epic_issue_id = epic_issue_id.epic_issue_id if epic_issue_id.class == Issue
+      epic_issue_id = epic_issue_id.epic_issue_id if epic_issue_id.instance_of?(Issue)
 
       client.request(:delete, "groups/#{group_id}/epics/#{epic_id}/issues/#{epic_issue_id}")
     end

data/lib/labclient/epics/issues/update.rb

@@ -36,7 +36,7 @@ module LabClient
       epic_id = format_id(epic_id)
 
       # This is horrible, but has to be the epic_issue_id, not the issue's id or iid
-      epic_issue_id = epic_issue_id.epic_issue_id if epic_issue_id.class == Issue
+      epic_issue_id = epic_issue_id.epic_issue_id if epic_issue_id.instance_of?(Issue)
 
       client.request(:put, "groups/#{group_id}/epics/#{epic_id}/issues/#{epic_issue_id}", nil, query)
     end

data/lib/labclient/error.rb

@@ -8,5 +8,14 @@ module LabClient
       super
       @resp = resp
     end
+
+    # Helper for Raising Exceptions
+    def error_details
+      { code: resp.code, message: resp.find_friendly_error }
+    end
+  end
+
+  # Class Shim
+  class Retry < StandardError
   end
 end

data/lib/labclient/files/delete.rb

@@ -37,6 +37,9 @@ module LabClient
     def delete(project_id, file_path, query)
       project_id = format_id(project_id)
 
+      # Path Name Encoding
+      file_path = CGI.escape(file_path)
+
       client.request(:delete, "projects/#{project_id}/repository/files/#{file_path}", nil, query)
     end
   end

data/lib/labclient/files/show.rb

@@ -42,6 +42,9 @@ module LabClient
 
       project_id = format_id(project_id)
 
+      # Path Name Encoding
+      file_path = CGI.escape(file_path)
+
       client.request(:get, "projects/#{project_id}/repository/files/#{file_path}#{kind}", nil, ref: ref)
     end
   end

data/lib/labclient/files/update.rb

@@ -43,6 +43,9 @@ module LabClient
     def update(project_id, file_path, query)
       project_id = format_id(project_id)
 
+      # Path Name Encoding
+      file_path = CGI.escape(file_path)
+
       client.request(:put, "projects/#{project_id}/repository/files/#{file_path}", nil, query)
     end
   end