blakey 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: e30381a630c4a9e625898e713cd0c04ba77640b59483947b3e7ec1608037d8a4
+  data.tar.gz: 480f0c13b26028d55cc6fb255f560d7e3707e6b24055be8fb1575d1dd0a0d579
+SHA512:
+  metadata.gz: 39d5b9afa0630e4a659936edba8e4b8d2bbb644566cfc5b11062975fc65000b257e00f9c07994d424c24cdbc96a5f23842953674465d19e6f60217d944ffa950
+  data.tar.gz: f539abc194d85b1402de7dac82f7b5a73935cd1ca769b63c8f10390a43a3088c22f5dd7caf954261495ae179954b66de47a1e3347a8f0ab7fd8e9ead78a2745e

data/.gitignore

@@ -0,0 +1,7 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/pkg/
+/spec/reports/
+/tmp/

data/.rspec

@@ -0,0 +1 @@
+--require spec_helper

data/.travis.yml

@@ -0,0 +1,8 @@
+language: ruby
+cache: bundler
+
+rvm:
+  - 2.5.8
+  - 2.6.6
+  - 2.7.1
+  - 2.7.2

data/Gemfile

@@ -0,0 +1,11 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in blakey.gemspec
+gemspec
+
+gem "rake", "~> 12.0"
+
+group :test do
+  gem 'webmock'
+  gem 'vcr'
+end

data/Gemfile.lock

@@ -0,0 +1,58 @@
+PATH
+  remote: .
+  specs:
+    blakey (0.1.0)
+      octokit
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    addressable (2.7.0)
+      public_suffix (>= 2.0.2, < 5.0)
+    crack (0.4.4)
+    diff-lcs (1.4.4)
+    faraday (1.1.0)
+      multipart-post (>= 1.2, < 3)
+      ruby2_keywords
+    hashdiff (1.0.1)
+    multipart-post (2.1.1)
+    octokit (4.19.0)
+      faraday (>= 0.9)
+      sawyer (~> 0.8.0, >= 0.5.3)
+    public_suffix (4.0.6)
+    rake (12.3.3)
+    rspec (3.10.0)
+      rspec-core (~> 3.10.0)
+      rspec-expectations (~> 3.10.0)
+      rspec-mocks (~> 3.10.0)
+    rspec-core (3.10.0)
+      rspec-support (~> 3.10.0)
+    rspec-expectations (3.10.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.10.0)
+    rspec-mocks (3.10.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.10.0)
+    rspec-support (3.10.0)
+    ruby2_keywords (0.0.2)
+    sawyer (0.8.2)
+      addressable (>= 2.3.5)
+      faraday (> 0.8, < 2.0)
+    vcr (6.0.0)
+    webmock (3.10.0)
+      addressable (>= 2.3.6)
+      crack (>= 0.3.2)
+      hashdiff (>= 0.4.0, < 2.0.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  blakey!
+  rake (~> 12.0)
+  rspec
+  vcr
+  webmock
+
+BUNDLED WITH
+   2.1.4

data/README.md

@@ -0,0 +1,86 @@
+# Blakey
+
+[![Build Status](https://travis-ci.org/calvinhughes/blakey.svg?branch=main)](https://travis-ci.org/calvinhughes/blakey)
+
+Blakey is a Ruby gem built to take the hassle out of extracting useful information from your projects. It allows you to easily plug in sources of information about your project, which can then be used as a common data-source for reporting purposes.
+
+Easily find out information like..
+
+- What language versions are used?
+- Which dependencies do I have and what are their versions?
+- What is the state of the remote repository? How many issues are open?
+- Are GitHub vulnerability alerts enabled for the project's GitHub repository?
+
+Blakey is built to be extendable out of the box, meaning you can easily add your own custom sources and repository types if they are not supported already.
+
+## Understanding Blakey
+Blakey consists of two main parts:
+
+#### Source
+Where the base data and any files used for inspecting are retrieved from. For example: GitHub, GitLab, manual git repository or local file systems.
+
+Supported sources:
+
+- [GitHub](/doc/sources/GitHub.md)
+
+#### Repository
+The repository/project that is being inspected. Repositories must be of a particular language type (for example: Ruby, JavaScript), and must take a source. This repository then has the specific information related to the repository type itself, such as the specific language versions in use or dependencies that are loaded.
+
+Supported repository types:
+
+- [Ruby](/doc/repositories/Ruby.md)
+
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'blakey'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install blakey
+
+## Usage
+To get started, build a source object:
+```ruby
+# Add a GitHub personal access token for the access_token value
+# This can also be set via BLAKEY_SOURCE_GITHUB_ACCESS_TOKEN environment variable
+
+github_source = Blakey::Source::Github.new(access_token: 'token', repo_path: 'calvinhughes/blakey')
+```
+
+Then build a repository object (for example Ruby):
+```ruby
+repository = Blakey::Repository::Ruby.new(source)
+```
+
+You can then run any of the supported methods on the repository or the source. See the following docs for what repositories and sources are supported and their examples:
+
+- [Sources](/doc/sources)
+- [Repositories](/doc/repositories)
+
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+Some sources using remote APIs in the development environment may require authentication. You can specify credentials for these using the following environment variables:
+
+| Source | Environment variable                     | Description |
+|--------|------------------------------------------|-------------|
+| GitHub | `BLAKEY_TEST_SOURCE_GITHUB_ACCESS_TOKEN` | The test personal access token from GitHub used for requests in the test environment. Default value: `fake_github_access_token` |
+
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/calvinhughes/blakey.
+

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "blakey"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/blakey.gemspec

@@ -0,0 +1,30 @@
+require_relative 'lib/blakey/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "blakey"
+  spec.version       = Blakey::VERSION
+  spec.authors       = ["Calvin Hughes"]
+  spec.email         = ["calvin@veeqo.com"]
+
+  spec.summary       = "Blakey makes extracting basic statistics from your projects much easier"
+  spec.description   = "Blakey is a Ruby gem built to make extract basic statistics and information from your repositories/projects much easier"
+  spec.homepage      = "https://github.com/calvinhughes/blakey"
+  spec.required_ruby_version = Gem::Requirement.new(">= 2.3.0")
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = "https://github.com/calvinhughes/blakey"
+  spec.metadata["changelog_uri"] = "https://github.com/calvinhughes/blakey/CHANGELOG.md"
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency 'octokit'
+
+  spec.add_development_dependency 'rspec'
+end

data/doc/repositories/Ruby.md

@@ -0,0 +1,38 @@
+# Ruby
+A repository type that is used for Ruby programs and applications. This repository allows you to fetch information such as the Ruby version, the gems in use along with their versions.
+
+## Configuration options
+
+|Configuration option|Description |
+|----------------------|-------------|
+|source|The source for the data. See [Sources](/doc/sources) for more information|
+|gemfile_lock_path|Custom path to the Gemfile.lock in the source. Default: `Gemfile.lock`|
+
+## Example usage
+
+#### Build repository object
+```ruby
+example_source = Blakey::Source::GitHub.new(access_token: 'personal_access_token', repo_path: 'calvinhughes/blakey')
+
+repository = Blakey::Repository::Ruby.new(source, gemfile_lock_path: 'custom_gemfile_lock_path.lock')
+```
+
+#### Retrieve Ruby version
+Uses `Gemfile.lock` as the source of the Ruby version, falling back to `.ruby-version`
+
+```ruby
+repository.ruby_version
+# => "2.7.1"
+```
+
+#### Retrieve list of gem dependencies and their version
+```ruby
+repository.gem_dependencies
+# => {"rails" => "6.0.1", "blakey" => "0.1.0"}
+```
+
+#### Retrieve version for a specific gem dependency
+```ruby
+repository.gem_dependency_version('rails')
+# => "6.0.1"
+```

data/doc/sources/GitHub.md

@@ -0,0 +1,40 @@
+# GitHub
+Fetches files and repository statistics via the GitHub API using the [`octokit.rb`](https://github.com/octokit/octokit.rb) library.
+
+## Configuration options
+
+|Configuration option|Description|
+|----------------------|-------------|
+|access_token|Personal access token from your GitHub account that can be generated [here](https://github.com/settings/tokens). Can also be specified by setting the `BLAKEY_SOURCE_GITHUB_ACCESS_TOKEN` environment variable|
+|repo_path|The full path to the repository on GitHub that you want to query. Example: `calvinhughes/blakey`|
+
+## Example usage
+
+#### Build source object
+```ruby
+github_source = Blakey::Source::GitHub.new(access_token: 'personal_access_token', repo_path: 'calvinhughes/blakey')
+```
+
+#### Read a file from the repository
+This fetches a file via the GitHub API and returns the contents. In the case of a non-existant file, `Blakey::Source::FileNotFound` will be raised.
+
+```ruby
+github_source.read_file('doc/some_doc.md')
+# => "a file!"
+```
+
+#### Fetch repository overview
+Returns a hash with useful repository data from the GitHub API.
+
+```ruby
+github_source.repository_overview
+# => {
+#   :open_issues_count=>143, # count of open issues
+#   :language=>"Ruby", # configured language of the repo
+#   :visibility=>"private", # visibility of the repo
+#   :url=>"https://github.com/calvinhughes/blakey", # url of the repo
+#   :updated_at=>2020-11-20 13:43:54 UTC, # when it was last updated
+#   :created_at=>2012-03-16 09:14:34 UTC, # when it was created
+#   :last_pushed_at=>2020-11-20 14:01:40 UTC, # when it was last pushed to
+# }
+```

data/lib/blakey.rb

@@ -0,0 +1,12 @@
+require 'blakey/repository/base'
+require 'blakey/repository/ruby'
+require 'blakey/repository/ruby/gemfile_lock_parser'
+require 'blakey/repository/ruby/ruby_version_fetcher'
+
+require 'blakey/source/errors'
+
+require 'blakey/source/base'
+require 'blakey/source/github'
+
+module Blakey
+end

data/lib/blakey/repository/base.rb

@@ -0,0 +1,24 @@
+module Blakey
+  module Repository
+    class Base
+      class SourceRequired < StandardError; end
+
+      def initialize(source = nil, options = {})
+        @source  = source
+        @options = options
+
+        raise SourceRequired, "Please pass a valid source" unless source
+      end
+
+      attr_reader :options
+
+      def source_overview
+        source.repository_overview
+      end
+
+      private
+
+      attr_reader :source
+    end
+  end
+end

data/lib/blakey/repository/ruby.rb

@@ -0,0 +1,35 @@
+module Blakey
+  module Repository
+    class Ruby < Base
+      def gem_dependency_version(gem_name)
+        gem_dependencies.fetch(gem_name, nil)
+      end
+
+      def gem_dependencies
+        gemfile_lock_parser.dependencies
+      end
+
+      def ruby_version
+        ruby_version_fetcher.version
+      end
+
+      private
+
+      attr_reader :source
+
+      def ruby_version_fetcher
+        @ruby_version_fetcher ||= RubyVersionFetcher.new(
+          gemfile_lock_parser: gemfile_lock_parser,
+          source: source
+        )
+      end
+
+      def gemfile_lock_parser
+        @gemfile_lock_parser ||= GemfileLockParser.new(
+          gemfile_lock_path: options[:gemfile_lock_path],
+          source: source
+        )
+      end
+    end
+  end
+end

data/lib/blakey/repository/ruby/gemfile_lock_parser.rb

@@ -0,0 +1,36 @@
+require 'bundler'
+
+module Blakey
+  module Repository
+    class Ruby::GemfileLockParser
+      DEFAULT_GEMFILE_LOCK_PATH = 'Gemfile.lock'
+
+      def initialize(gemfile_lock_path: nil, source:)
+        @gemfile_lock_path = (gemfile_lock_path || DEFAULT_GEMFILE_LOCK_PATH)
+        @source            =  source
+      end
+
+      attr_reader :gemfile_lock_path
+
+      def dependencies
+        parsed_gemfile_lock.specs.map { |spec| [spec.name, spec.version.to_s] }.to_h
+      end
+
+      def ruby_version
+        parsed_gemfile_lock.ruby_version
+      end
+
+      private
+
+      attr_reader :source
+
+      def parsed_gemfile_lock
+        @parsed_gemfile_lock ||= Bundler::LockfileParser.new(gemfile_lock_contents)
+      end
+
+      def gemfile_lock_contents
+        source.read_file(gemfile_lock_path)
+      end
+    end
+  end
+end

data/lib/blakey/repository/ruby/ruby_version_fetcher.rb

@@ -0,0 +1,25 @@
+require 'bundler'
+
+module Blakey
+  module Repository
+    class Ruby::RubyVersionFetcher
+
+      def initialize(gemfile_lock_parser:, source:)
+        @gemfile_lock_parser = gemfile_lock_parser
+        @source              = source
+      end
+
+      def version
+        gemfile_lock_parser.ruby_version || fetch_version_from_ruby_version_file
+      end
+
+      private
+
+      attr_reader :gemfile_lock_parser, :source
+
+      def fetch_version_from_ruby_version_file
+        source.read_file('.ruby-version')
+      end
+    end
+  end
+end

data/lib/blakey/source/base.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module Blakey
+  module Source
+    class Base
+      def read_file(file_path)
+        raise 'To be implemented'
+      end
+
+      def repository_overview
+        raise 'To be implemented'
+      end
+    end
+  end
+end

data/lib/blakey/source/errors.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+module Blakey
+  module Source
+    class FileNotFound < StandardError; end
+
+  end
+end

data/lib/blakey/source/github.rb

@@ -0,0 +1,46 @@
+require 'base64'
+require 'octokit'
+
+module Blakey
+  module Source
+    class Github < Base
+      def initialize(access_token: nil, repo_path: nil)
+        @access_token = (access_token || ENV['BLAKEY_SOURCE_GITHUB_ACCESS_TOKEN'])
+        @octokit_client ||= ::Octokit::Client.new(access_token: @access_token)
+        @repo_path = repo_path
+      end
+
+      attr_reader :repo_path
+
+      def read_file(file_path)
+        begin
+          encoded_file_content = octokit_client.contents(repo_path, path: file_path).content
+        rescue Octokit::NotFound => e
+          raise FileNotFound.new(e)
+        end
+
+        Base64.decode64(encoded_file_content).chomp
+      end
+
+      def repository_overview
+        {
+          open_issues_count: repository.open_issues_count,
+          language: repository.language,
+          visibility: repository.private? ? 'private' : 'public',
+          url: repository.html_url,
+          updated_at: repository.updated_at,
+          created_at: repository.created_at,
+          last_pushed_at: repository.pushed_at
+        }
+      end
+
+      private
+
+      def repository
+        @repository ||= octokit_client.repo(repo_path)
+      end
+
+      attr_reader :octokit_client
+    end
+  end
+end

data/lib/blakey/version.rb

@@ -0,0 +1,3 @@
+module Blakey
+  VERSION = "0.1.0"
+end

data/license.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2020 Calvin Hughes
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

metadata

@@ -0,0 +1,96 @@
+--- !ruby/object:Gem::Specification
+name: blakey
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Calvin Hughes
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2020-11-28 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: octokit
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  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: Blakey is a Ruby gem built to make extract basic statistics and information
+  from your repositories/projects much easier
+email:
+- calvin@veeqo.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- Gemfile.lock
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- blakey.gemspec
+- doc/repositories/Ruby.md
+- doc/sources/GitHub.md
+- lib/blakey.rb
+- lib/blakey/repository/base.rb
+- lib/blakey/repository/ruby.rb
+- lib/blakey/repository/ruby/gemfile_lock_parser.rb
+- lib/blakey/repository/ruby/ruby_version_fetcher.rb
+- lib/blakey/source/base.rb
+- lib/blakey/source/errors.rb
+- lib/blakey/source/github.rb
+- lib/blakey/version.rb
+- license.txt
+homepage: https://github.com/calvinhughes/blakey
+licenses: []
+metadata:
+  homepage_uri: https://github.com/calvinhughes/blakey
+  source_code_uri: https://github.com/calvinhughes/blakey
+  changelog_uri: https://github.com/calvinhughes/blakey/CHANGELOG.md
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.3.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.3
+signing_key:
+specification_version: 4
+summary: Blakey makes extracting basic statistics from your projects much easier
+test_files: []