gitabu 0.1.0

data/lib/gitabu/api/v3/licenses.rb

@@ -0,0 +1,118 @@
+# frozen_string_literal: true
+
+# INFO ON GENERATED CODE
+#
+# This file is generated.
+# See the contribution guide on how to improve the code.
+#
+# INFO ON GENERATED CODE
+
+# Ruby gem that helps you work with Github API.
+module Gitabu
+  # API module
+  module Api
+    # Github Version 3
+    module V3
+      # Class to display Licenses result
+      class LicensesResult
+        attr_accessor :result, :message
+
+        def initialize(result:, message:)
+          @result = result
+          @message = message
+        end
+      end
+
+      # Class to display error result
+      class LicensesErrorResult
+        attr_accessor :result, :message
+
+        def initialize(result:, message:)
+          @result = result
+          @message = message
+        end
+      end
+
+      # Licenses endpoints.
+      class Licenses
+        def self.get_all_commonly_used_licenses(options: nil)
+          new.get_all_commonly_used_licenses(options)
+        end
+
+        def self.get_a_license(license: nil, options: nil)
+          new.get_a_license(license, options)
+        end
+
+        def self.get_the_license_for_a_repository(owner: nil, repo: nil, options: nil)
+          new.get_the_license_for_a_repository(owner, repo, options)
+        end
+
+        private
+
+        # get all commonly used licenses
+        #
+        # @params options [Hash]
+        #
+        # @return LicensesResult, LicensesErrorResult
+        def get_all_commonly_used_licenses(options)
+          auth    = nil
+          body    = nil
+          headers = { accept: 'application/vnd.github.v3+json' }
+          params  = { featured: options[:featured], per_page: options[:per_page], page: options[:page] }
+          uri     = "#{Gitabu::BASE_URL}/licenses"
+
+          http_call = Gitabu::HttpClient.call(auth: auth, body: body, headers: headers, method: :get, params: params, uri: uri)
+
+          if http_call.successful?
+            LicensesResult.new(result: http_call, message: "Successful call to endpoint. #{http_call.result.message}")
+          else
+            LicensesErrorResult.new(result: http_call, message: "Failure while calling endpoint. #{http_call.result.message}")
+          end
+        end
+
+        # get a license
+        #
+        # @param license [String]
+        #
+        # @return LicensesResult, LicensesErrorResult
+        def get_a_license(license, _options)
+          auth    = nil
+          body    = nil
+          headers = { accept: 'application/vnd.github.v3+json' }
+          params  = nil
+          uri     = "#{Gitabu::BASE_URL}/licenses/#{license}"
+
+          http_call = Gitabu::HttpClient.call(auth: auth, body: body, headers: headers, method: :get, params: params, uri: uri)
+
+          if http_call.successful?
+            LicensesResult.new(result: http_call, message: "Successful call to endpoint. #{http_call.result.message}")
+          else
+            LicensesErrorResult.new(result: http_call, message: "Failure while calling endpoint. #{http_call.result.message}")
+          end
+        end
+
+        # get the license for a repository
+        #
+        # @param owner [String]
+        # @param repo [String]
+        #
+        # @return LicensesResult, LicensesErrorResult
+        def get_the_license_for_a_repository(owner, repo, _options)
+          auth    = nil
+          body    = nil
+          headers = { accept: 'application/vnd.github.v3+json' }
+          params  = nil
+          uri     = "#{Gitabu::BASE_URL}/repos/#{owner}/#{repo}/license"
+
+          http_call = Gitabu::HttpClient.call(auth: auth, body: body, headers: headers, method: :get, params: params, uri: uri)
+
+          if http_call.successful?
+            LicensesResult.new(result: http_call, message: "Successful call to endpoint. #{http_call.result.message}")
+          else
+            LicensesErrorResult.new(result: http_call, message: "Failure while calling endpoint. #{http_call.result.message}")
+          end
+        end
+      end
+    end
+  end
+end

data/lib/gitabu/api/v3/markdown.rb

@@ -0,0 +1,94 @@
+# frozen_string_literal: true
+
+# INFO ON GENERATED CODE
+#
+# This file is generated.
+# See the contribution guide on how to improve the code.
+#
+# INFO ON GENERATED CODE
+
+# Ruby gem that helps you work with Github API.
+module Gitabu
+  # API module
+  module Api
+    # Github Version 3
+    module V3
+      # Class to display Markdown result
+      class MarkdownResult
+        attr_accessor :result, :message
+
+        def initialize(result:, message:)
+          @result = result
+          @message = message
+        end
+      end
+
+      # Class to display error result
+      class MarkdownErrorResult
+        attr_accessor :result, :message
+
+        def initialize(result:, message:)
+          @result = result
+          @message = message
+        end
+      end
+
+      # Markdown endpoints.
+      class Markdown
+        def self.render_a_markdown_document(text: nil, mode: nil, context: nil, options: nil)
+          new.render_a_markdown_document(text, mode, context, options)
+        end
+
+        def self.render_a_markdown_document_in_raw_mode(options: nil)
+          new.render_a_markdown_document_in_raw_mode(options)
+        end
+
+        private
+
+        # render a markdown document
+        #
+        # @param text [String] Required. The Markdown text to render in HTML.
+        # @param mode [String] The rendering mode. Can be either markdown or gfm.Default: markdown
+        # @param context [String] The repository context to use when creating references in gfm mode.  For example, setting context to octo-org/octo-repo will change the text #42 into an HTML link to issue 42 in the octo-org/octo-repo repository.
+        #
+        # @return MarkdownResult, MarkdownErrorResult
+        def render_a_markdown_document(text, mode, context, _options)
+          auth    = nil
+          body    = { text: text, mode: mode, context: context }
+          headers = { accept: 'application/vnd.github.v3+json' }
+          params  = nil
+          uri     = "#{Gitabu::BASE_URL}/markdown"
+
+          http_call = Gitabu::HttpClient.call(auth: auth, body: body, headers: headers, method: :post, params: params, uri: uri)
+
+          if http_call.successful?
+            MarkdownResult.new(result: http_call, message: "Successful call to endpoint. #{http_call.result.message}")
+          else
+            MarkdownErrorResult.new(result: http_call, message: "Failure while calling endpoint. #{http_call.result.message}")
+          end
+        end
+
+        # render a markdown document in raw mode
+        #
+        # @params options [Hash]
+        #
+        # @return MarkdownResult, MarkdownErrorResult
+        def render_a_markdown_document_in_raw_mode(_options)
+          auth    = nil
+          body    = nil
+          headers = { accept: 'application/vnd.github.v3+json' }
+          params  = nil
+          uri     = "#{Gitabu::BASE_URL}/markdown/raw"
+
+          http_call = Gitabu::HttpClient.call(auth: auth, body: body, headers: headers, method: :post, params: params, uri: uri)
+
+          if http_call.successful?
+            MarkdownResult.new(result: http_call, message: "Successful call to endpoint. #{http_call.result.message}")
+          else
+            MarkdownErrorResult.new(result: http_call, message: "Failure while calling endpoint. #{http_call.result.message}")
+          end
+        end
+      end
+    end
+  end
+end

data/lib/gitabu/api/v3/meta.rb

@@ -0,0 +1,142 @@
+# frozen_string_literal: true
+
+# INFO ON GENERATED CODE
+#
+# This file is generated.
+# See the contribution guide on how to improve the code.
+#
+# INFO ON GENERATED CODE
+
+# Ruby gem that helps you work with Github API.
+module Gitabu
+  # API module
+  module Api
+    # Github Version 3
+    module V3
+      # Class to display Meta result
+      class MetaResult
+        attr_accessor :result, :message
+
+        def initialize(result:, message:)
+          @result = result
+          @message = message
+        end
+      end
+
+      # Class to display error result
+      class MetaErrorResult
+        attr_accessor :result, :message
+
+        def initialize(result:, message:)
+          @result = result
+          @message = message
+        end
+      end
+
+      # Meta endpoints.
+      class Meta
+        def self.github_api_root(options: nil)
+          new.github_api_root(options)
+        end
+
+        def self.get_github_meta_information(options: nil)
+          new.get_github_meta_information(options)
+        end
+
+        def self.get_octocat(options: nil)
+          new.get_octocat(options)
+        end
+
+        def self.get_the_zen_of_github(options: nil)
+          new.get_the_zen_of_github(options)
+        end
+
+        private
+
+        # github api root
+        #
+        # @params options [Hash]
+        #
+        # @return MetaResult, MetaErrorResult
+        def github_api_root(_options)
+          auth    = nil
+          body    = nil
+          headers = { accept: 'application/vnd.github.v3+json' }
+          params  = nil
+          uri     = "#{Gitabu::BASE_URL}/"
+
+          http_call = Gitabu::HttpClient.call(auth: auth, body: body, headers: headers, method: :get, params: params, uri: uri)
+
+          if http_call.successful?
+            MetaResult.new(result: http_call, message: "Successful call to endpoint. #{http_call.result.message}")
+          else
+            MetaErrorResult.new(result: http_call, message: "Failure while calling endpoint. #{http_call.result.message}")
+          end
+        end
+
+        # get github meta information
+        #
+        # @params options [Hash]
+        #
+        # @return MetaResult, MetaErrorResult
+        def get_github_meta_information(_options)
+          auth    = nil
+          body    = nil
+          headers = { accept: 'application/vnd.github.v3+json' }
+          params  = nil
+          uri     = "#{Gitabu::BASE_URL}/meta"
+
+          http_call = Gitabu::HttpClient.call(auth: auth, body: body, headers: headers, method: :get, params: params, uri: uri)
+
+          if http_call.successful?
+            MetaResult.new(result: http_call, message: "Successful call to endpoint. #{http_call.result.message}")
+          else
+            MetaErrorResult.new(result: http_call, message: "Failure while calling endpoint. #{http_call.result.message}")
+          end
+        end
+
+        # get octocat
+        #
+        # @params options [Hash]
+        #
+        # @return MetaResult, MetaErrorResult
+        def get_octocat(options)
+          auth    = nil
+          body    = nil
+          headers = { accept: 'application/vnd.github.v3+json' }
+          params  = { s: options[:s] }
+          uri     = "#{Gitabu::BASE_URL}/octocat"
+
+          http_call = Gitabu::HttpClient.call(auth: auth, body: body, headers: headers, method: :get, params: params, uri: uri)
+
+          if http_call.successful?
+            MetaResult.new(result: http_call, message: "Successful call to endpoint. #{http_call.result.message}")
+          else
+            MetaErrorResult.new(result: http_call, message: "Failure while calling endpoint. #{http_call.result.message}")
+          end
+        end
+
+        # get the zen of github
+        #
+        # @params options [Hash]
+        #
+        # @return MetaResult, MetaErrorResult
+        def get_the_zen_of_github(_options)
+          auth    = nil
+          body    = nil
+          headers = { accept: 'application/vnd.github.v3+json' }
+          params  = nil
+          uri     = "#{Gitabu::BASE_URL}/zen"
+
+          http_call = Gitabu::HttpClient.call(auth: auth, body: body, headers: headers, method: :get, params: params, uri: uri)
+
+          if http_call.successful?
+            MetaResult.new(result: http_call, message: "Successful call to endpoint. #{http_call.result.message}")
+          else
+            MetaErrorResult.new(result: http_call, message: "Failure while calling endpoint. #{http_call.result.message}")
+          end
+        end
+      end
+    end
+  end
+end

data/lib/gitabu/api/v3/metrics.rb

@@ -0,0 +1,302 @@
+# frozen_string_literal: true
+
+# INFO ON GENERATED CODE
+#
+# This file is generated.
+# See the contribution guide on how to improve the code.
+#
+# INFO ON GENERATED CODE
+
+# Ruby gem that helps you work with Github API.
+module Gitabu
+  # API module
+  module Api
+    # Github Version 3
+    module V3
+      # Class to display Metrics result
+      class MetricsResult
+        attr_accessor :result, :message
+
+        def initialize(result:, message:)
+          @result = result
+          @message = message
+        end
+      end
+
+      # Class to display error result
+      class MetricsErrorResult
+        attr_accessor :result, :message
+
+        def initialize(result:, message:)
+          @result = result
+          @message = message
+        end
+      end
+
+      # Metrics endpoints.
+      class Metrics
+        def self.get_community_profile_metrics(owner: nil, repo: nil, options: nil)
+          new.get_community_profile_metrics(owner, repo, options)
+        end
+
+        def self.get_the_weekly_commit_activity(owner: nil, repo: nil, options: nil)
+          new.get_the_weekly_commit_activity(owner, repo, options)
+        end
+
+        def self.get_the_last_year_of_commit_activity(owner: nil, repo: nil, options: nil)
+          new.get_the_last_year_of_commit_activity(owner, repo, options)
+        end
+
+        def self.get_all_contributor_commit_activity(owner: nil, repo: nil, options: nil)
+          new.get_all_contributor_commit_activity(owner, repo, options)
+        end
+
+        def self.get_the_weekly_commit_count(owner: nil, repo: nil, options: nil)
+          new.get_the_weekly_commit_count(owner, repo, options)
+        end
+
+        def self.get_the_hourly_commit_count_for_each_day(owner: nil, repo: nil, options: nil)
+          new.get_the_hourly_commit_count_for_each_day(owner, repo, options)
+        end
+
+        def self.get_repository_clones(owner: nil, repo: nil, options: nil)
+          new.get_repository_clones(owner, repo, options)
+        end
+
+        def self.get_top_referral_paths(owner: nil, repo: nil, options: nil)
+          new.get_top_referral_paths(owner, repo, options)
+        end
+
+        def self.get_top_referral_sources(owner: nil, repo: nil, options: nil)
+          new.get_top_referral_sources(owner, repo, options)
+        end
+
+        def self.get_page_views(owner: nil, repo: nil, options: nil)
+          new.get_page_views(owner, repo, options)
+        end
+
+        private
+
+        # get community profile metrics
+        #
+        # @param owner [String]
+        # @param repo [String]
+        #
+        # @return MetricsResult, MetricsErrorResult
+        def get_community_profile_metrics(owner, repo, _options)
+          auth    = nil
+          body    = nil
+          headers = { accept: 'application/vnd.github.v3+json' }
+          params  = nil
+          uri     = "#{Gitabu::BASE_URL}/repos/#{owner}/#{repo}/community/profile"
+
+          http_call = Gitabu::HttpClient.call(auth: auth, body: body, headers: headers, method: :get, params: params, uri: uri)
+
+          if http_call.successful?
+            MetricsResult.new(result: http_call, message: "Successful call to endpoint. #{http_call.result.message}")
+          else
+            MetricsErrorResult.new(result: http_call, message: "Failure while calling endpoint. #{http_call.result.message}")
+          end
+        end
+
+        # get the weekly commit activity
+        #
+        # @param owner [String]
+        # @param repo [String]
+        #
+        # @return MetricsResult, MetricsErrorResult
+        def get_the_weekly_commit_activity(owner, repo, _options)
+          auth    = nil
+          body    = nil
+          headers = { accept: 'application/vnd.github.v3+json' }
+          params  = nil
+          uri     = "#{Gitabu::BASE_URL}/repos/#{owner}/#{repo}/stats/code_frequency"
+
+          http_call = Gitabu::HttpClient.call(auth: auth, body: body, headers: headers, method: :get, params: params, uri: uri)
+
+          if http_call.successful?
+            MetricsResult.new(result: http_call, message: "Successful call to endpoint. #{http_call.result.message}")
+          else
+            MetricsErrorResult.new(result: http_call, message: "Failure while calling endpoint. #{http_call.result.message}")
+          end
+        end
+
+        # get the last year of commit activity
+        #
+        # @param owner [String]
+        # @param repo [String]
+        #
+        # @return MetricsResult, MetricsErrorResult
+        def get_the_last_year_of_commit_activity(owner, repo, _options)
+          auth    = nil
+          body    = nil
+          headers = { accept: 'application/vnd.github.v3+json' }
+          params  = nil
+          uri     = "#{Gitabu::BASE_URL}/repos/#{owner}/#{repo}/stats/commit_activity"
+
+          http_call = Gitabu::HttpClient.call(auth: auth, body: body, headers: headers, method: :get, params: params, uri: uri)
+
+          if http_call.successful?
+            MetricsResult.new(result: http_call, message: "Successful call to endpoint. #{http_call.result.message}")
+          else
+            MetricsErrorResult.new(result: http_call, message: "Failure while calling endpoint. #{http_call.result.message}")
+          end
+        end
+
+        # get all contributor commit activity
+        #
+        # @param owner [String]
+        # @param repo [String]
+        #
+        # @return MetricsResult, MetricsErrorResult
+        def get_all_contributor_commit_activity(owner, repo, _options)
+          auth    = nil
+          body    = nil
+          headers = { accept: 'application/vnd.github.v3+json' }
+          params  = nil
+          uri     = "#{Gitabu::BASE_URL}/repos/#{owner}/#{repo}/stats/contributors"
+
+          http_call = Gitabu::HttpClient.call(auth: auth, body: body, headers: headers, method: :get, params: params, uri: uri)
+
+          if http_call.successful?
+            MetricsResult.new(result: http_call, message: "Successful call to endpoint. #{http_call.result.message}")
+          else
+            MetricsErrorResult.new(result: http_call, message: "Failure while calling endpoint. #{http_call.result.message}")
+          end
+        end
+
+        # get the weekly commit count
+        #
+        # @param owner [String]
+        # @param repo [String]
+        #
+        # @return MetricsResult, MetricsErrorResult
+        def get_the_weekly_commit_count(owner, repo, _options)
+          auth    = nil
+          body    = nil
+          headers = { accept: 'application/vnd.github.v3+json' }
+          params  = nil
+          uri     = "#{Gitabu::BASE_URL}/repos/#{owner}/#{repo}/stats/participation"
+
+          http_call = Gitabu::HttpClient.call(auth: auth, body: body, headers: headers, method: :get, params: params, uri: uri)
+
+          if http_call.successful?
+            MetricsResult.new(result: http_call, message: "Successful call to endpoint. #{http_call.result.message}")
+          else
+            MetricsErrorResult.new(result: http_call, message: "Failure while calling endpoint. #{http_call.result.message}")
+          end
+        end
+
+        # get the hourly commit count for each day
+        #
+        # @param owner [String]
+        # @param repo [String]
+        #
+        # @return MetricsResult, MetricsErrorResult
+        def get_the_hourly_commit_count_for_each_day(owner, repo, _options)
+          auth    = nil
+          body    = nil
+          headers = { accept: 'application/vnd.github.v3+json' }
+          params  = nil
+          uri     = "#{Gitabu::BASE_URL}/repos/#{owner}/#{repo}/stats/punch_card"
+
+          http_call = Gitabu::HttpClient.call(auth: auth, body: body, headers: headers, method: :get, params: params, uri: uri)
+
+          if http_call.successful?
+            MetricsResult.new(result: http_call, message: "Successful call to endpoint. #{http_call.result.message}")
+          else
+            MetricsErrorResult.new(result: http_call, message: "Failure while calling endpoint. #{http_call.result.message}")
+          end
+        end
+
+        # get repository clones
+        #
+        # @param owner [String]
+        # @param repo [String]
+        #
+        # @return MetricsResult, MetricsErrorResult
+        def get_repository_clones(owner, repo, options)
+          auth    = nil
+          body    = nil
+          headers = { accept: 'application/vnd.github.v3+json' }
+          params  = { per: options[:per] }
+          uri     = "#{Gitabu::BASE_URL}/repos/#{owner}/#{repo}/traffic/clones"
+
+          http_call = Gitabu::HttpClient.call(auth: auth, body: body, headers: headers, method: :get, params: params, uri: uri)
+
+          if http_call.successful?
+            MetricsResult.new(result: http_call, message: "Successful call to endpoint. #{http_call.result.message}")
+          else
+            MetricsErrorResult.new(result: http_call, message: "Failure while calling endpoint. #{http_call.result.message}")
+          end
+        end
+
+        # get top referral paths
+        #
+        # @param owner [String]
+        # @param repo [String]
+        #
+        # @return MetricsResult, MetricsErrorResult
+        def get_top_referral_paths(owner, repo, _options)
+          auth    = nil
+          body    = nil
+          headers = { accept: 'application/vnd.github.v3+json' }
+          params  = nil
+          uri     = "#{Gitabu::BASE_URL}/repos/#{owner}/#{repo}/traffic/popular/paths"
+
+          http_call = Gitabu::HttpClient.call(auth: auth, body: body, headers: headers, method: :get, params: params, uri: uri)
+
+          if http_call.successful?
+            MetricsResult.new(result: http_call, message: "Successful call to endpoint. #{http_call.result.message}")
+          else
+            MetricsErrorResult.new(result: http_call, message: "Failure while calling endpoint. #{http_call.result.message}")
+          end
+        end
+
+        # get top referral sources
+        #
+        # @param owner [String]
+        # @param repo [String]
+        #
+        # @return MetricsResult, MetricsErrorResult
+        def get_top_referral_sources(owner, repo, _options)
+          auth    = nil
+          body    = nil
+          headers = { accept: 'application/vnd.github.v3+json' }
+          params  = nil
+          uri     = "#{Gitabu::BASE_URL}/repos/#{owner}/#{repo}/traffic/popular/referrers"
+
+          http_call = Gitabu::HttpClient.call(auth: auth, body: body, headers: headers, method: :get, params: params, uri: uri)
+
+          if http_call.successful?
+            MetricsResult.new(result: http_call, message: "Successful call to endpoint. #{http_call.result.message}")
+          else
+            MetricsErrorResult.new(result: http_call, message: "Failure while calling endpoint. #{http_call.result.message}")
+          end
+        end
+
+        # get page views
+        #
+        # @param owner [String]
+        # @param repo [String]
+        #
+        # @return MetricsResult, MetricsErrorResult
+        def get_page_views(owner, repo, options)
+          auth    = nil
+          body    = nil
+          headers = { accept: 'application/vnd.github.v3+json' }
+          params  = { per: options[:per] }
+          uri     = "#{Gitabu::BASE_URL}/repos/#{owner}/#{repo}/traffic/views"
+
+          http_call = Gitabu::HttpClient.call(auth: auth, body: body, headers: headers, method: :get, params: params, uri: uri)
+
+          if http_call.successful?
+            MetricsResult.new(result: http_call, message: "Successful call to endpoint. #{http_call.result.message}")
+          else
+            MetricsErrorResult.new(result: http_call, message: "Failure while calling endpoint. #{http_call.result.message}")
+          end
+        end
+      end
+    end
+  end
+end