labclient 0.6.0 → 0.8.0

data/lib/labclient/commits/refs.rb

@@ -38,7 +38,7 @@ module LabClient
       project_id = format_id(project_id)
       commit_id = format_id(commit_id)
 
-      client.request(:get, "projects/#{project_id}/repository/commits/#{commit_id}/refs", nil, { scope: scope })
+      client.request(:get, "projects/#{project_id}/repository/commits/#{commit_id}/refs", body: { scope: scope })
     end
   end
 end

data/lib/labclient/commits/revert.rb

@@ -34,7 +34,7 @@ module LabClient
       commit_id = format_id(commit_id)
       branch_name = format_id(branch_name)
 
-      client.request(:post, "projects/#{project_id}/repository/commits/#{commit_id}/revert", Commit, { branch: branch_name })
+      client.request(:post, "projects/#{project_id}/repository/commits/#{commit_id}/revert", klass: Commit, body: { branch: branch_name })
     end
   end
 end

data/lib/labclient/commits/show.rb

@@ -28,7 +28,7 @@ module LabClient
     def show(project_id, commit_id, query = {})
       project_id = format_id(project_id)
 
-      client.request(:get, "projects/#{project_id}/repository/commits/#{commit_id}", Commit, query)
+      client.request(:get, "projects/#{project_id}/repository/commits/#{commit_id}", klass: Commit, body: query)
     end
   end
 end

data/lib/labclient/commits/status/list.rb

@@ -51,7 +51,7 @@ module LabClient
       project_id = format_id(project_id)
       commit_id = format_id(commit_id)
 
-      client.request(:get, "projects/#{project_id}/repository/commits/#{commit_id}/statuses", CommitStatus, query)
+      client.request(:get, "projects/#{project_id}/repository/commits/#{commit_id}/statuses", klass: CommitStatus, body: query)
     end
   end
 end

data/lib/labclient/commits/status/update.rb

@@ -47,7 +47,7 @@ module LabClient
       project_id = format_id(project_id)
       commit_id = format_id(commit_id)
 
-      client.request(:post, "projects/#{project_id}/statuses/#{commit_id}", CommitStatus, query)
+      client.request(:post, "projects/#{project_id}/statuses/#{commit_id}", klass: CommitStatus, body: query)
     end
   end
 end

data/lib/labclient/common.rb

@@ -83,7 +83,7 @@ module LabClient
       # Valid Integer in String
       return obj_id if /\A\d+\z/.match(obj_id)
 
-      CGI.escape obj_id.to_s
+      ERB::Util.url_encode obj_id.to_s
     end
 
     def format_query_id(key, query)

data/lib/labclient/deploy_keys/add.rb

@@ -40,7 +40,7 @@ module LabClient
     # Add
     def add(project_id, query = {})
       project_id = format_id(project_id)
-      client.request(:post, "projects/#{project_id}/deploy_keys", DeployKey, query)
+      client.request(:post, "projects/#{project_id}/deploy_keys", klass: DeployKey, body: query)
     end
   end
 end

data/lib/labclient/deploy_keys/delete.rb

@@ -40,7 +40,7 @@ module LabClient
     # Delete
     def delete(project_id, deploy_key_id)
       project_id = format_id(project_id)
-      client.request(:delete, "projects/#{project_id}/deploy_keys/#{deploy_key_id}", DeployKey)
+      client.request(:delete, "projects/#{project_id}/deploy_keys/#{deploy_key_id}", klass: DeployKey)
     end
   end
 end

data/lib/labclient/deploy_keys/enable.rb

@@ -32,7 +32,7 @@ module LabClient
     # Enable
     def enable(project_id, deploy_key_id)
       project_id = format_id(project_id)
-      client.request(:post, "projects/#{project_id}/deploy_keys/#{deploy_key_id}/enable", DeployKey)
+      client.request(:post, "projects/#{project_id}/deploy_keys/#{deploy_key_id}/enable", klass: DeployKey)
     end
   end
 end

data/lib/labclient/deploy_keys/list.rb

@@ -29,9 +29,9 @@ module LabClient
     # List
     def list(deploy_key_id = nil)
       if deploy_key_id
-        client.request(:get, "projects/#{deploy_key_id}/deploy_keys", DeployKey)
+        client.request(:get, "projects/#{deploy_key_id}/deploy_keys", klass: DeployKey)
       else
-        client.request(:get, 'deploy_keys', DeployKey)
+        client.request(:get, 'deploy_keys', klass: DeployKey)
       end
     end
   end

data/lib/labclient/deploy_keys/show.rb

@@ -24,7 +24,7 @@ module LabClient
     # Show
     def show(project_id, deploy_key_id)
       project_id = format_id(project_id)
-      client.request(:get, "projects/#{project_id}/deploy_keys/#{deploy_key_id}", DeployKey)
+      client.request(:get, "projects/#{project_id}/deploy_keys/#{deploy_key_id}", klass: DeployKey)
     end
   end
 end

data/lib/labclient/deploy_keys/update.rb

@@ -47,7 +47,7 @@ module LabClient
     # Update
     def update(project_id, deploy_key_id, query = {})
       project_id = format_id(project_id)
-      client.request(:put, "projects/#{project_id}/deploy_keys/#{deploy_key_id}", DeployKey, query)
+      client.request(:put, "projects/#{project_id}/deploy_keys/#{deploy_key_id}", klass: DeployKey, body: query)
     end
   end
 end

data/lib/labclient/discussions/commits/create.rb

@@ -26,7 +26,7 @@ module LabClient
 
       query[:created_at] = query[:created_at].to_time.iso8601 if format_time?(query[:created_at])
 
-      client.request(:post, "projects/#{project_id}/commits/#{commit_id}/discussions", Discussion, query)
+      client.request(:post, "projects/#{project_id}/commits/#{commit_id}/discussions", klass: Discussion, body: query)
     end
   end
 end

data/lib/labclient/discussions/commits/list.rb

@@ -16,7 +16,7 @@ module LabClient
       project_id = format_id(project_id)
       commit_id = format_id(commit_id)
 
-      client.request(:get, "projects/#{project_id}/commits/#{commit_id}/discussions", Discussion)
+      client.request(:get, "projects/#{project_id}/commits/#{commit_id}/discussions", klass: Discussion)
     end
   end
 end

data/lib/labclient/discussions/commits/show.rb

@@ -16,7 +16,7 @@ module LabClient
       commit_id = format_id(commit_id)
       discussion_id = format_id(discussion_id)
 
-      client.request(:get, "projects/#{project_id}/commits/#{commit_id}/discussions/#{discussion_id}", Discussion)
+      client.request(:get, "projects/#{project_id}/commits/#{commit_id}/discussions/#{discussion_id}", klass: Discussion)
     end
   end
 end

data/lib/labclient/discussions/commits/update.rb

@@ -26,7 +26,7 @@ module LabClient
       discussion_id = format_id(discussion_id)
       query = { body: body }
 
-      client.request(:put, "projects/#{project_id}/commits/#{commit_id}/discussions/#{discussion_id}", Discussion, query)
+      client.request(:put, "projects/#{project_id}/commits/#{commit_id}/discussions/#{discussion_id}", klass: Discussion, body: query)
     end
   end
 end

data/lib/labclient/discussions/epics/create.rb

@@ -26,7 +26,7 @@ module LabClient
 
       query[:created_at] = query[:created_at].to_time.iso8601 if format_time?(query[:created_at])
 
-      client.request(:post, "projects/#{project_id}/epics/#{epic_id}/discussions", Discussion, query)
+      client.request(:post, "projects/#{project_id}/epics/#{epic_id}/discussions", klass: Discussion, body: query)
     end
   end
 end

data/lib/labclient/discussions/epics/list.rb

@@ -16,7 +16,7 @@ module LabClient
       project_id = format_id(project_id)
       epic_id = format_id(epic_id)
 
-      client.request(:get, "projects/#{project_id}/epics/#{epic_id}/discussions", Discussion)
+      client.request(:get, "projects/#{project_id}/epics/#{epic_id}/discussions", klass: Discussion)
     end
   end
 end

data/lib/labclient/discussions/epics/show.rb

@@ -16,7 +16,7 @@ module LabClient
       epic_id = format_id(epic_id)
       discussion_id = format_id(discussion_id)
 
-      client.request(:get, "projects/#{project_id}/epics/#{epic_id}/discussions/#{discussion_id}", Discussion)
+      client.request(:get, "projects/#{project_id}/epics/#{epic_id}/discussions/#{discussion_id}", klass: Discussion)
     end
   end
 end

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

@@ -26,7 +26,7 @@ module LabClient
       discussion_id = format_id(discussion_id)
       query = { body: body }
 
-      client.request(:put, "projects/#{project_id}/epics/#{epic_id}/discussions/#{discussion_id}", Discussion, query)
+      client.request(:put, "projects/#{project_id}/epics/#{epic_id}/discussions/#{discussion_id}", klass: Discussion, body: query)
     end
   end
 end

data/lib/labclient/discussions/issues/create.rb

@@ -26,7 +26,7 @@ module LabClient
 
       query[:created_at] = query[:created_at].to_time.iso8601 if format_time?(query[:created_at])
 
-      client.request(:post, "projects/#{project_id}/issues/#{issue_id}/discussions", Discussion, query)
+      client.request(:post, "projects/#{project_id}/issues/#{issue_id}/discussions", klass: Discussion, body: query)
     end
   end
 end

data/lib/labclient/discussions/issues/list.rb

@@ -16,7 +16,7 @@ module LabClient
       project_id = format_id(project_id)
       issue_id = format_id(issue_id)
 
-      client.request(:get, "projects/#{project_id}/issues/#{issue_id}/discussions", Discussion)
+      client.request(:get, "projects/#{project_id}/issues/#{issue_id}/discussions", klass: Discussion)
     end
   end
 end

data/lib/labclient/discussions/issues/show.rb

@@ -16,7 +16,7 @@ module LabClient
       issue_id = format_id(issue_id)
       discussion_id = format_id(discussion_id)
 
-      client.request(:get, "projects/#{project_id}/issues/#{issue_id}/discussions/#{discussion_id}", Discussion)
+      client.request(:get, "projects/#{project_id}/issues/#{issue_id}/discussions/#{discussion_id}", klass: Discussion)
     end
   end
 end

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

@@ -26,7 +26,7 @@ module LabClient
       discussion_id = format_id(discussion_id)
       query = { body: body }
 
-      client.request(:put, "projects/#{project_id}/issues/#{issue_id}/discussions/#{discussion_id}", Discussion, query)
+      client.request(:put, "projects/#{project_id}/issues/#{issue_id}/discussions/#{discussion_id}", klass: Discussion, body: query)
     end
   end
 end

data/lib/labclient/discussions/merge_requests/create.rb

@@ -26,7 +26,7 @@ module LabClient
 
       query[:created_at] = query[:created_at].to_time.iso8601 if format_time?(query[:created_at])
 
-      client.request(:post, "projects/#{project_id}/merge_requests/#{merge_request_id}/discussions", Discussion, query)
+      client.request(:post, "projects/#{project_id}/merge_requests/#{merge_request_id}/discussions", klass: Discussion, body: query)
     end
   end
 end

data/lib/labclient/discussions/merge_requests/list.rb

@@ -16,7 +16,7 @@ module LabClient
       project_id = format_id(project_id)
       merge_request_id = format_id(merge_request_id)
 
-      client.request(:get, "projects/#{project_id}/merge_requests/#{merge_request_id}/discussions", Discussion)
+      client.request(:get, "projects/#{project_id}/merge_requests/#{merge_request_id}/discussions", klass: Discussion)
     end
   end
 end

data/lib/labclient/discussions/merge_requests/show.rb

@@ -16,7 +16,7 @@ module LabClient
       merge_request_id = format_id(merge_request_id)
       discussion_id = format_id(discussion_id)
 
-      client.request(:get, "projects/#{project_id}/merge_requests/#{merge_request_id}/discussions/#{discussion_id}", Discussion)
+      client.request(:get, "projects/#{project_id}/merge_requests/#{merge_request_id}/discussions/#{discussion_id}", klass: Discussion)
     end
   end
 end

data/lib/labclient/discussions/merge_requests/update.rb

@@ -26,7 +26,7 @@ module LabClient
       discussion_id = format_id(discussion_id)
       query = { body: body }
 
-      client.request(:put, "projects/#{project_id}/merge_requests/#{merge_request_id}/discussions/#{discussion_id}", Discussion, query)
+      client.request(:put, "projects/#{project_id}/merge_requests/#{merge_request_id}/discussions/#{discussion_id}", klass: Discussion, body: query)
     end
   end
 end

data/lib/labclient/discussions/snippets/create.rb

@@ -26,7 +26,7 @@ module LabClient
 
       query[:created_at] = query[:created_at].to_time.iso8601 if format_time?(query[:created_at])
 
-      client.request(:post, "projects/#{project_id}/snippets/#{snippet_id}/discussions", Discussion, query)
+      client.request(:post, "projects/#{project_id}/snippets/#{snippet_id}/discussions", klass: Discussion, body: query)
     end
   end
 end

data/lib/labclient/discussions/snippets/list.rb

@@ -16,7 +16,7 @@ module LabClient
       project_id = format_id(project_id)
       snippet_id = format_id(snippet_id)
 
-      client.request(:get, "projects/#{project_id}/snippets/#{snippet_id}/discussions", Discussion)
+      client.request(:get, "projects/#{project_id}/snippets/#{snippet_id}/discussions", klass: Discussion)
     end
   end
 end

data/lib/labclient/discussions/snippets/show.rb

@@ -16,7 +16,7 @@ module LabClient
       snippet_id = format_id(snippet_id)
       discussion_id = format_id(discussion_id)
 
-      client.request(:get, "projects/#{project_id}/snippets/#{snippet_id}/discussions/#{discussion_id}", Discussion)
+      client.request(:get, "projects/#{project_id}/snippets/#{snippet_id}/discussions/#{discussion_id}", klass: Discussion)
     end
   end
 end

data/lib/labclient/discussions/snippets/update.rb

@@ -26,7 +26,7 @@ module LabClient
       discussion_id = format_id(discussion_id)
       query = { body: body }
 
-      client.request(:put, "projects/#{project_id}/snippets/#{snippet_id}/discussions/#{discussion_id}", Discussion, query)
+      client.request(:put, "projects/#{project_id}/snippets/#{snippet_id}/discussions/#{discussion_id}", klass: Discussion, body: query)
     end
   end
 end

data/lib/labclient/docs.rb

@@ -25,6 +25,8 @@ module LabClient
     # end
     # ---------------------------------
 
+    # Replacing with Docusaurus, Using vanilla markdown
+    # This isn't used in the CLI/Pry at all either
     # Klass Helper
     def help(&block)
       # require 'active_support/inflector'
@@ -45,8 +47,11 @@ module LabClient
     end
 
     def markdown(value)
-      require 'kramdown' unless defined? Kramdown
-      @result[:markdown] = Kramdown::Document.new(value).to_html
+      # require 'kramdown' unless defined? Kramdown
+      # @result[:markdown] = Kramdown::Document.new(value).to_html
+
+      # Use Vanilla Markdown
+      @result[:markdown] = value
     end
 
     def desc(value)
@@ -59,13 +64,16 @@ module LabClient
     end
 
     def example(value)
-      @result[:example] = value
+      # Ensure there is a new line for the markdown and no extras
+      @result[:example] = value.ends_with?("\n") ? value : "#{value}\n"
     end
 
     def result(value)
-      @result[:result] = value
+      # Ensure Markdown Ends with a new line
+      @result[:result] = value.ends_with?("\n") ? value : "#{value}\n"
     end
 
+    # Deprecate
     def option(name, text)
       @result[:options] ||= []
       @result[:options].push(name: name, text: text)

data/lib/labclient/epics/create.rb

@@ -36,7 +36,7 @@ module LabClient
     def create(group_id, query)
       group_id = format_id(group_id)
 
-      client.request(:post, "groups/#{group_id}/epics", Epic, query)
+      client.request(:post, "groups/#{group_id}/epics", klass: Epic, body: query)
     end
   end
 end

data/lib/labclient/epics/epic.rb

@@ -3,6 +3,7 @@ module LabClient
   # Inspect Helper
   class Epic < Klass
     include ClassHelpers
+
     def inspect
       "#<Epic iid: #{iid}, title: #{title}>"
     end
@@ -15,7 +16,7 @@ module LabClient
     end
 
     def update(query)
-      update_self client.epics.update(group_id, iid, query)
+      update_self client.epics.update(group_id, iid, body: query)
     end
 
     def delete
@@ -57,7 +58,7 @@ module LabClient
     end
 
     def note_create(query)
-      client.notes.epics.create(group_id, iid, query)
+      client.notes.epics.create(group_id, iid, body: query)
     end
 
     date_time_attrs %i[created_at closed_at updated_at]

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

@@ -32,7 +32,7 @@ module LabClient
       group_id = format_id(group_id)
       epic_id = format_id(epic_id)
 
-      client.request(:get, "groups/#{group_id}/epics/#{epic_id}/issues", Issue)
+      client.request(:get, "groups/#{group_id}/epics/#{epic_id}/issues", klass: Issue)
     end
   end
 end

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

@@ -38,7 +38,7 @@ module LabClient
       # 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.instance_of?(Issue)
 
-      client.request(:put, "groups/#{group_id}/epics/#{epic_id}/issues/#{epic_issue_id}", nil, query)
+      client.request(:put, "groups/#{group_id}/epics/#{epic_id}/issues/#{epic_issue_id}", body: query)
     end
   end
 end

data/lib/labclient/epics/list.rb

@@ -47,7 +47,7 @@ module LabClient
       query[:updated_after] = query[:updated_after].to_time.iso8601 if format_time?(query[:updated_after])
       query[:updated_before] = query[:updated_before].to_time.iso8601 if format_time?(query[:updated_before])
 
-      client.request(:get, "groups/#{group_id}/epics", Epic, query)
+      client.request(:get, "groups/#{group_id}/epics", klass: Epic, body: query)
     end
     # rubocop:enable Metrics/AbcSize
   end

data/lib/labclient/epics/show.rb

@@ -23,7 +23,7 @@ module LabClient
       group_id = format_id(group_id)
       epic_id = format_id(epic_id)
 
-      client.request(:get, "groups/#{group_id}/epics/#{epic_id}", Epic)
+      client.request(:get, "groups/#{group_id}/epics/#{epic_id}", klass: Epic)
     end
   end
 end

data/lib/labclient/epics/todo.rb

@@ -21,7 +21,7 @@ module LabClient
       group_id = format_id(group_id)
       epic_id = format_id(epic_id)
 
-      client.request(:post, "groups/#{group_id}/epics/#{epic_id}/todo", Todo)
+      client.request(:post, "groups/#{group_id}/epics/#{epic_id}/todo", klass: Todo)
     end
   end
 end

data/lib/labclient/epics/update.rb

@@ -46,7 +46,7 @@ module LabClient
       group_id = format_id(group_id)
       epic_id = format_id(epic_id)
 
-      client.request(:put, "groups/#{group_id}/epics/#{epic_id}", Epic, query)
+      client.request(:put, "groups/#{group_id}/epics/#{epic_id}", klass: Epic, body: query)
     end
   end
 end

data/lib/labclient/events/event.rb

@@ -3,6 +3,7 @@ module LabClient
   # Inspect Helper
   class Event < Klass
     include ClassHelpers
+
     def inspect
       "#<Event type: #{action_name}>"
     end

data/lib/labclient/events/list.rb

@@ -61,7 +61,7 @@ module LabClient
       query[:before] = query[:before].to_time.iso8601 if format_time?(query[:before])
       query[:after] = query[:after].to_time.iso8601 if format_time?(query[:after])
 
-      client.request(:get, 'events', Event, query)
+      client.request(:get, 'events', klass: Event, body: query)
     end
   end
 end

data/lib/labclient/events/project.rb

@@ -61,7 +61,7 @@ module LabClient
       query[:before] = query[:before].to_time.iso8601 if format_time?(query[:before])
       query[:after] = query[:after].to_time.iso8601 if format_time?(query[:after])
 
-      client.request(:get, "projects/#{project_id}/events", Event, query)
+      client.request(:get, "projects/#{project_id}/events", klass: Event, body: query)
     end
   end
 end

data/lib/labclient/events/user.rb

@@ -60,7 +60,7 @@ module LabClient
       query[:before] = query[:before].to_time.iso8601 if format_time?(query[:before])
       query[:after] = query[:after].to_time.iso8601 if format_time?(query[:after])
 
-      client.request(:get, "users/#{user_id}/events", Event, query)
+      client.request(:get, "users/#{user_id}/events", klass: Event, body: query)
     end
   end
 end

data/lib/labclient/feature_flags/create.rb

@@ -42,7 +42,7 @@ module LabClient
 
     # Create
     def create(name, query = {})
-      client.request(:post, "features/#{name}", FeatureFlag, query)
+      client.request(:post, "features/#{name}", klass: FeatureFlag, body: query)
     end
   end
 end

data/lib/labclient/feature_flags/feature_flag.rb

@@ -3,6 +3,7 @@ module LabClient
   # Inspect Helper
   class FeatureFlag < Klass
     include ClassHelpers
+
     def inspect
       "#<FeatureFlag name: #{name}, state: #{state}>"
     end
@@ -12,7 +13,7 @@ module LabClient
     end
 
     def update(query)
-      update_self client.feature_flags.create(name, query)
+      update_self client.feature_flags.create(name, body: query)
     end
 
     def toggle

data/lib/labclient/feature_flags/list.rb

@@ -43,7 +43,7 @@ module LabClient
     end
 
     def list
-      client.request(:get, 'features', FeatureFlag)
+      client.request(:get, 'features', klass: FeatureFlag)
     end
   end
 end

data/lib/labclient/files/create.rb

@@ -47,9 +47,9 @@ module LabClient
       project_id = format_id(project_id)
 
       # Path Name Encoding
-      file_path = CGI.escape(file_path)
+      file_path = ERB::Util.url_encode(file_path)
 
-      client.request(:post, "projects/#{project_id}/repository/files/#{file_path}", nil, query)
+      client.request(:post, "projects/#{project_id}/repository/files/#{file_path}", body: query)
     end
   end
 end

data/lib/labclient/files/delete.rb

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

data/lib/labclient/files/show.rb

@@ -27,25 +27,27 @@ module LabClient
       desc 'via Project'
       example <<~DOC
         project = client.projects.show(264)
-        project.file('a3c86df3f')
+        project.file('README.md')
       DOC
     end
 
     def show(project_id, file_path, ref = :main, kind = nil)
+      # LabStruct vs LabFile
+      return_kind = kind == :raw ? LabFile : nil
+
       kind = case kind
              when :raw
                '/raw'
              when :blame
                '/blame'
              end
-      # GET /projects/:id/repository/files/:file_path
 
       project_id = format_id(project_id)
 
       # Path Name Encoding
-      file_path = CGI.escape(file_path)
+      file_path = ERB::Util.url_encode(file_path)
 
-      client.request(:get, "projects/#{project_id}/repository/files/#{file_path}#{kind}", LabFile, ref: ref)
+      client.request(:get, "projects/#{project_id}/repository/files/#{file_path}#{kind}", klass: return_kind, body: { ref: ref })
     end
   end
 end

data/lib/labclient/files/update.rb

@@ -44,9 +44,9 @@ module LabClient
       project_id = format_id(project_id)
 
       # Path Name Encoding
-      file_path = CGI.escape(file_path)
+      file_path = ERB::Util.url_encode(file_path)
 
-      client.request(:put, "projects/#{project_id}/repository/files/#{file_path}", nil, query)
+      client.request(:put, "projects/#{project_id}/repository/files/#{file_path}", body: query)
     end
   end
 end