gitabu 0.1.0

data/lib/gitabu/run.rb

@@ -0,0 +1,237 @@
+# frozen_string_literal: true
+
+require_relative "generator"
+
+# Ruby gem that helps you work with Github API.
+module Gitabu
+  # Run class to introduce generated classes.
+  class Run
+    def self.save
+      new.save
+    end
+
+    def initialize; end
+
+    def save
+      hash.each do |api_module|
+        link    = api_module[:link]
+        name    = api_module[:name]
+        version = api_module[:version]
+
+        Gitabu::Generator.generate(link: link, name: name, version: version)
+      end
+    end
+
+    private
+
+    def hash
+      [
+        {
+          link: 'https://docs.github.com/en/rest/reference/actions',
+          name: 'actions',
+          version: 3
+        },
+        {
+          link: 'https://docs.github.com/en/rest/reference/activity',
+          name: 'activity',
+          version: 3
+        },
+        {
+          link: 'https://docs.github.com/en/rest/reference/apps',
+          name: 'apps',
+          version: 3
+        },
+        {
+          link: 'https://docs.github.com/en/rest/reference/billing',
+          name: 'billing',
+          version: 3
+        },
+        {
+          link: 'https://docs.github.com/en/rest/reference/branches',
+          name: 'branches',
+          version: 3
+        },
+        {
+          link: 'https://docs.github.com/en/rest/reference/checks',
+          name: 'checks',
+          version: 3
+        },
+        {
+          link: 'https://docs.github.com/en/rest/reference/codes-of-conduct',
+          name: 'codes_of_conduct',
+          version: 3
+        },
+        {
+          link: 'https://docs.github.com/en/rest/reference/code-scanning',
+          name: 'code_scanning',
+          version: 3
+        },
+        {
+          link: 'https://docs.github.com/en/rest/reference/codespaces',
+          name: 'codespaces',
+          version: 3
+        },
+        {
+          link: 'https://docs.github.com/en/rest/reference/collaborators',
+          name: 'collaborators',
+          version: 3
+        },
+        {
+          link: 'https://docs.github.com/en/rest/reference/commits',
+          name: 'commits',
+          version: 3
+        },
+        {
+          link: 'https://docs.github.com/en/rest/reference/dependabot',
+          name: 'dependabot',
+          version: 3
+        },
+        {
+          link: 'https://docs.github.com/en/rest/reference/deploy_keys',
+          name: 'deploy_keys',
+          version: 3
+        },
+        {
+          link: 'https://docs.github.com/en/rest/reference/deployments',
+          name: 'deployments',
+          version: 3
+        },
+        {
+          link: 'https://docs.github.com/en/rest/reference/emojis',
+          name: 'emojis',
+          version: 3
+        },
+        {
+          link: 'https://docs.github.com/en/rest/reference/enterprise-admin',
+          name: 'enterprise_admin',
+          version: 3
+        },
+        {
+          link: 'https://docs.github.com/en/rest/reference/gists',
+          name: 'gists',
+          version: 3
+        },
+        {
+          link: 'https://docs.github.com/en/rest/reference/git',
+          name: 'git',
+          version: 3
+        },
+        {
+          link: 'https://docs.github.com/en/rest/reference/gitignore',
+          name: 'gitignore',
+          version: 3
+        },
+        {
+          link: 'https://docs.github.com/en/rest/reference/interactions',
+          name: 'interactions',
+          version: 3
+        },
+        {
+          link: 'https://docs.github.com/en/rest/reference/issues',
+          name: 'issues',
+          version: 3
+        },
+        {
+          link: 'https://docs.github.com/en/rest/reference/licenses',
+          name: 'licenses',
+          version: 3
+        },
+        {
+          link: 'https://docs.github.com/en/rest/reference/markdown',
+          name: 'markdown',
+          version: 3
+        },
+        {
+          link: 'https://docs.github.com/en/rest/reference/meta',
+          name: 'meta',
+          version: 3
+        },
+        {
+          link: 'https://docs.github.com/en/rest/reference/metrics',
+          name: 'metrics',
+          version: 3
+        },
+        {
+          link: 'https://docs.github.com/en/rest/reference/migrations',
+          name: 'migrations',
+          version: 3
+        },
+        {
+          link: 'https://docs.github.com/en/rest/reference/orgs',
+          name: 'orgs',
+          version: 3
+        },
+        {
+          link: 'https://docs.github.com/en/rest/reference/packages',
+          name: 'packages',
+          version: 3
+        },
+        {
+          link: 'https://docs.github.com/en/rest/reference/pages',
+          name: 'pages',
+          version: 3
+        },
+        {
+          link: 'https://docs.github.com/en/rest/reference/projects',
+          name: 'projects',
+          version: 3
+        },
+        {
+          link: 'https://docs.github.com/en/rest/reference/pulls',
+          name: 'pulls',
+          version: 3
+        },
+        {
+          link: 'https://docs.github.com/en/rest/reference/rate-limit',
+          name: 'rate_limit',
+          version: 3
+        },
+        {
+          link: 'https://docs.github.com/en/rest/reference/reactions',
+          name: 'reactions',
+          version: 3
+        },
+        {
+          link: 'https://docs.github.com/en/rest/reference/releases',
+          name: 'releases',
+          version: 3
+        },
+        {
+          link: 'https://docs.github.com/en/rest/reference/repos',
+          name: 'repos',
+          version: 3
+        },
+        {
+          link: 'https://docs.github.com/en/rest/reference/scim',
+          name: 'scim',
+          version: 3
+        },
+        {
+          link: 'https://docs.github.com/en/rest/reference/search',
+          name: 'search',
+          version: 3
+        },
+        {
+          link: 'https://docs.github.com/en/rest/reference/secret-scanning',
+          name: 'secret_scanning',
+          version: 3
+        },
+        {
+          link: 'https://docs.github.com/en/rest/reference/teams',
+          name: 'teams',
+          version: 3
+        },
+        {
+          link: 'https://docs.github.com/en/rest/reference/users',
+          name: 'users',
+          version: 3
+        },
+        {
+          link: 'https://docs.github.com/en/rest/reference/webhooks',
+          name: 'webhooks',
+          version: 3
+        }
+      ]
+    end
+  end
+end

data/lib/gitabu/scraper.rb

@@ -0,0 +1,86 @@
+# frozen_string_literal: true
+
+require "fileutils"
+require "json"
+require "nokogiri"
+require "ostruct"
+
+require_relative "http_client"
+
+# Ruby gem that helps you work with Github API.
+module Gitabu
+  # Scraper that gets link to Github API and returns endpoints as variables.
+  class Scraper
+    attr_accessor :link, :name, :version
+
+    def self.scrape(link:, name:, version:)
+      new(link, name, version).scrape
+    end
+
+    def initialize(link, name, version)
+      @link    = link
+      @name    = name
+      @version = version
+    end
+
+    def scrape
+      hash = { result: list }
+
+      FileUtils.mkdir_p("lib/gitabu/public/api/v#{version}")
+      FileUtils.touch("lib/gitabu/public/api/v#{version}/#{name}.json")
+      File.open("lib/gitabu/public/api/v#{version}/#{name}.json", "w") do |f|
+        f.write(JSON.pretty_generate(hash))
+      end
+    end
+
+    private
+
+    def list
+      page = download_link_page
+      document = parse(page)
+
+      table_list(document)
+    end
+
+    def download_link_page
+      Gitabu::HttpClient.call(method: :get, uri: link, expect: :html).result
+    end
+
+    def parse(page)
+      Nokogiri::HTML(page)
+    end
+
+    def table_list(document)
+      list = []
+      namespace = "/html/body/div/div/div[2]/main/div/div[4]/div"
+      namespace_count = document.xpath(namespace).size
+      namespace_count.times do |namespace_index|
+        block_count = document.xpath("#{namespace}[#{namespace_index + 1}]/div").size
+        block_count.times do |block_index|
+          next if block_index.zero?
+
+          table = {}
+          table["namespace_description"] = document.xpath("#{namespace}[#{namespace_index + 1}]/div[#{block_index + 1}]/h3/text()")
+          table["method"] = document.xpath("#{namespace}[#{namespace_index + 1}]/div[#{block_index + 1}]/div/pre/code/span/text()")
+          endpoint = document.xpath("#{namespace}[#{namespace_index + 1}]/div[#{block_index + 1}]/div/pre/code")[0]&.text
+          table["endpoint"] = endpoint.gsub("#{table["method"]} ", "")
+          row_count = document.xpath("#{namespace}[#{namespace_index + 1}]/div[#{block_index + 1}]/table[1]/tbody/tr").size
+          row_count.times do |row_index|
+            col = document.xpath("#{namespace}[#{namespace_index + 1}]/div[#{block_index + 1}]/table[1]/tbody/tr[#{row_index + 1}]/td")
+            row_name = "field_#{row_index}"
+            table[row_name] = fill_column(col)
+          end
+          list << table
+        end
+      end
+      list
+    end
+
+    def fill_column(col)
+      {
+        field_type: col[2]&.content,
+        fields: { name: col[0]&.content, type: col[1]&.content, in: col[2]&.content, description: col[3]&.content }
+      }
+    end
+  end
+end

data/lib/gitabu/templates/template.rb.erb

@@ -0,0 +1,70 @@
+# 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 <%= @version %>
+    module V<%= @version %>
+      # Class to display <%= @class_name %> result
+      class <%= @class_name %>Result
+        attr_accessor :result, :message
+
+        def initialize(result:, message:)
+          @result = result
+          @message = message
+        end
+      end
+
+      # Class to display error result
+      class <%= @class_name %>ErrorResult
+        attr_accessor :result, :message
+
+        def initialize(result:, message:)
+          @result = result
+          @message = message
+        end
+      end
+
+      # <%= @class_name %> endpoints.
+      class <%= @class_name %>
+      <% for item in @items %>
+        def self.<%= item['method_name'] %><%= item['params_key_value'] %>
+          new.<%= item['method_name'] %><%= item['path_params_flat'] %>
+        end
+      <% end %>
+
+        private
+      <% for item in @items %>
+        # <%= item['description'] %>
+        #
+        <%= item['documentation'] %>
+        #
+        # @return <%= @class_name %>Result, <%= @class_name %>ErrorResult
+        def <%= item['method_name'] %><%= item['path_params_flat'] %>
+          auth    = <%= item['auth'] %>
+          body    = <%= item['body'] %>
+          headers = <%= item['headers'] %>
+          params  = <%= item['params'] %>
+          uri     = "#{Gitabu::BASE_URL}<%= item['endpoint'] %>"
+
+          http_call = Gitabu::HttpClient.call(auth: auth, body: body, headers: headers, method: :<%= item['http_method'] %>, params: params, uri: uri)
+
+          if http_call.successful?
+            <%= @class_name %>Result.new(result: http_call, message: "Successful call to endpoint. #{http_call.result.message}")
+          else
+            <%= @class_name %>ErrorResult.new(result: http_call, message: "Failure while calling endpoint. #{http_call.result.message}")
+          end
+        end
+      <% end %>
+      end
+    end
+  end
+end

data/lib/gitabu/version.rb

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+# Ruby gem that helps you work with Github API.
+module Gitabu
+  VERSION = "0.1.0"
+end

data/lib/gitabu.rb

@@ -0,0 +1,57 @@
+# frozen_string_literal: true
+
+require "ostruct"
+
+require_relative "gitabu/builder"
+require_relative "gitabu/client"
+require_relative "gitabu/generator"
+require_relative "gitabu/http_client"
+require_relative "gitabu/items"
+require_relative "gitabu/run"
+require_relative "gitabu/scraper"
+require_relative "gitabu/version"
+
+# Ruby gem that helps you work with Github API.
+module Gitabu
+  class Error < StandardError; end
+
+  BASE_URL = "https://api.github.com/"
+
+  def self.configuration
+    @configuration ||= OpenStruct.new(
+      version: nil
+    )
+  end
+
+  def self.configure
+    yield(configuration)
+  end
+
+  def self.to_ostruct(input)
+    result = {}
+
+    if input.is_a?(Hash)
+      result["result_type"] = input.class
+      result["result_keys"] = input.keys
+
+      input.each do |key, value|
+        result[key] = hash_or_array(value) ? to_ostruct(value) : OpenStruct.new(value: value, result_type: value.class)
+      end
+    end
+
+    if input.is_a?(Array)
+      result["result_type"] = input.class
+      result["result_array_size"] = input.size
+
+      input.each.with_index do |value, index|
+        result["value_at_#{index}"] = hash_or_array(value) ? to_ostruct(value) : OpenStruct.new(value: value, result_type: value.class)
+      end
+    end
+
+    OpenStruct.new(result)
+  end
+
+  def self.hash_or_array(val)
+    val.is_a?(Hash) || val.is_a?(Array)
+  end
+end

data/sig/gitabu.rbs

@@ -0,0 +1,4 @@
+module Gitabu
+  VERSION: String
+  # See the writing guide of rbs: https://github.com/ruby/rbs#guides
+end

metadata

@@ -0,0 +1,177 @@
+--- !ruby/object:Gem::Specification
+name: gitabu
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- sylvance_theone
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2022-04-03 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: nokogiri
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Ruby gem that helps you work with Github API.
+email:
+- 9350722+Sylvance@users.noreply.github.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rspec"
+- ".rubocop.yml"
+- CHANGELOG.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- gitabu.gemspec
+- lib/gitabu.rb
+- lib/gitabu/api/v3/actions.rb
+- lib/gitabu/api/v3/activity.rb
+- lib/gitabu/api/v3/apps.rb
+- lib/gitabu/api/v3/billing.rb
+- lib/gitabu/api/v3/branches.rb
+- lib/gitabu/api/v3/checks.rb
+- lib/gitabu/api/v3/code_scanning.rb
+- lib/gitabu/api/v3/codes_of_conduct.rb
+- lib/gitabu/api/v3/codespaces.rb
+- lib/gitabu/api/v3/collaborators.rb
+- lib/gitabu/api/v3/commits.rb
+- lib/gitabu/api/v3/dependabot.rb
+- lib/gitabu/api/v3/deploy_keys.rb
+- lib/gitabu/api/v3/deployments.rb
+- lib/gitabu/api/v3/emojis.rb
+- lib/gitabu/api/v3/enterprise_admin.rb
+- lib/gitabu/api/v3/gists.rb
+- lib/gitabu/api/v3/git.rb
+- lib/gitabu/api/v3/gitignore.rb
+- lib/gitabu/api/v3/interactions.rb
+- lib/gitabu/api/v3/issues.rb
+- lib/gitabu/api/v3/licenses.rb
+- lib/gitabu/api/v3/markdown.rb
+- lib/gitabu/api/v3/meta.rb
+- lib/gitabu/api/v3/metrics.rb
+- lib/gitabu/api/v3/migrations.rb
+- lib/gitabu/api/v3/orgs.rb
+- lib/gitabu/api/v3/packages.rb
+- lib/gitabu/api/v3/pages.rb
+- lib/gitabu/api/v3/projects.rb
+- lib/gitabu/api/v3/pulls.rb
+- lib/gitabu/api/v3/rate_limit.rb
+- lib/gitabu/api/v3/reactions.rb
+- lib/gitabu/api/v3/releases.rb
+- lib/gitabu/api/v3/repos.rb
+- lib/gitabu/api/v3/scim.rb
+- lib/gitabu/api/v3/search.rb
+- lib/gitabu/api/v3/secret_scanning.rb
+- lib/gitabu/api/v3/teams.rb
+- lib/gitabu/api/v3/users.rb
+- lib/gitabu/api/v3/webhooks.rb
+- lib/gitabu/builder.rb
+- lib/gitabu/client.rb
+- lib/gitabu/generator.rb
+- lib/gitabu/http_client.rb
+- lib/gitabu/items.rb
+- lib/gitabu/public/api/v3/actions.json
+- lib/gitabu/public/api/v3/activity.json
+- lib/gitabu/public/api/v3/apps.json
+- lib/gitabu/public/api/v3/billing.json
+- lib/gitabu/public/api/v3/branches.json
+- lib/gitabu/public/api/v3/checks.json
+- lib/gitabu/public/api/v3/code_scanning.json
+- lib/gitabu/public/api/v3/codes_of_conduct.json
+- lib/gitabu/public/api/v3/codespaces.json
+- lib/gitabu/public/api/v3/collaborators.json
+- lib/gitabu/public/api/v3/commits.json
+- lib/gitabu/public/api/v3/dependabot.json
+- lib/gitabu/public/api/v3/deploy_keys.json
+- lib/gitabu/public/api/v3/deployments.json
+- lib/gitabu/public/api/v3/emojis.json
+- lib/gitabu/public/api/v3/enterprise_admin.json
+- lib/gitabu/public/api/v3/gists.json
+- lib/gitabu/public/api/v3/git.json
+- lib/gitabu/public/api/v3/gitignore.json
+- lib/gitabu/public/api/v3/interactions.json
+- lib/gitabu/public/api/v3/issues.json
+- lib/gitabu/public/api/v3/licenses.json
+- lib/gitabu/public/api/v3/markdown.json
+- lib/gitabu/public/api/v3/meta.json
+- lib/gitabu/public/api/v3/metrics.json
+- lib/gitabu/public/api/v3/migrations.json
+- lib/gitabu/public/api/v3/orgs.json
+- lib/gitabu/public/api/v3/packages.json
+- lib/gitabu/public/api/v3/pages.json
+- lib/gitabu/public/api/v3/projects.json
+- lib/gitabu/public/api/v3/pulls.json
+- lib/gitabu/public/api/v3/rate_limit.json
+- lib/gitabu/public/api/v3/reactions.json
+- lib/gitabu/public/api/v3/releases.json
+- lib/gitabu/public/api/v3/repos.json
+- lib/gitabu/public/api/v3/scim.json
+- lib/gitabu/public/api/v3/search.json
+- lib/gitabu/public/api/v3/secret_scanning.json
+- lib/gitabu/public/api/v3/teams.json
+- lib/gitabu/public/api/v3/users.json
+- lib/gitabu/public/api/v3/webhooks.json
+- lib/gitabu/run.rb
+- lib/gitabu/scraper.rb
+- lib/gitabu/templates/template.rb.erb
+- lib/gitabu/version.rb
+- sig/gitabu.rbs
+homepage: https://github.com/Sylvance/gitabu
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+  homepage_uri: https://github.com/Sylvance/gitabu
+  source_code_uri: https://github.com/Sylvance/gitabu
+  changelog_uri: https://github.com/Sylvance/gitabu/blob/main/CHANGELOG.md
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.6.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.2.22
+signing_key:
+specification_version: 4
+summary: Ruby gem that helps you work with Github API.
+test_files: []