fasterer-github 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 9d1a9f24f4c238ba17781de42c94b0300db7bc09
+  data.tar.gz: 1ebeb537bcc1ed6da53d3acb59fce7ff5b42cf20
+SHA512:
+  metadata.gz: d7f737960b42f0f28d7c2eb773a92922474c8a9cb683566ff7abe409b907633508d52816a33a6d92e8a0bcba049aeebcbf4647dc2bfdb421c4ff870fdcd7a5f8
+  data.tar.gz: 43d12d5e509ff27100b15e50c7210ace9ddf188d5ace7891ef87b6d6d0412b75b7d1373bf04fdc5a61ab696e33e5c8c59ac5b527e0101350b7c54781eac0ffeb

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,10 @@
+language: ruby
+rvm:
+  - 2.0.0
+  - 2.1.5
+  - 2.2.2
+before_install: gem install bundler -v 1.10.5
+addons:
+  code_climate:
+    repo_token:
+      secure: 3c0a38daec04e8d951665de52bba00cf631baa154bd9a19394dcfe1fb9e85ff1

data/Gemfile

@@ -0,0 +1,5 @@
+source 'https://rubygems.org'
+
+gemspec
+
+gem "codeclimate-test-reporter", group: :test, require: nil

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Kacper Goliński
+
+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.

data/README.md

@@ -0,0 +1,103 @@
+[![Code Climate](https://codeclimate.com/github/caspg/fasterer-github/badges/gpa.svg)](https://codeclimate.com/github/caspg/fasterer-github)
+[![Test Coverage](https://codeclimate.com/github/caspg/fasterer-github/badges/coverage.svg)](https://codeclimate.com/github/caspg/fasterer-github/coverage)
+
+# fasterer-github
+
+This is a [fasterer](https://github.com/DamirSvrtan/fasterer) extension which allows to scan GitHub repo using GitHub API.
+
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'fasterer-github'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install fasterer-github
+
+## Request Rate Limit - Github Api
+
+Github api rate limit for unauthenticated requests is 60 request per hour. Fortunately, authenticated requests get a higher rate limit, which allows to make up to 5,000 requests per hour.
+
+## Configuration
+
+You can use configure block to provide `access_token`:
+```ruby
+Fasterer::Github.configure do |config|
+  config.access_token = 'YOUR_GITHUB_ACCESS_TOKEN'
+end
+```
+
+Instead of `access_token`, you can also add `client_id` and `client_secret`:
+
+```ruby
+Fasterer::Github.configure do |config|
+  config.client_id = 'YOUR_GITHUB_CLIENT_ID'
+  config.client_secret = 'YOUR_GITHUB_CLIENT_SECRET'
+end
+```
+
+## Usage
+
+To scan whole repo, run:
+```ruby
+Fasterer::Github.scan('owner', 'repo')
+```
+
+You can also scan specific file:
+```ruby
+Fasterer::Github.scan('owner', 'repo', 'lib/fasterer-github.rb')
+```
+
+## Example output
+
+```ruby
+$ Fasterer::Github.scan('owner', 'repo', 'path/to/file.rb')
+
+{
+  :repo_owner => 'owner',
+  :repo_name => 'repo',
+  :fasterer_offences => {
+    :hash_merge_bang_vs_hash_brackets => [
+      {
+        :path => "https://api.github.com/repos/owner/repo/contents/path/to/file.rb?ref=master",
+        :lines => [10, 17, 19]
+      }
+    ]
+  },
+  :errors => [],
+  :api_errors => []
+}
+```
+
+Example output when parser encounters some error and api returns error code:
+```ruby
+{
+  :repo_owner => 'owner',
+  :repo_name => 'repo',
+  :fasterer_offences => {},
+  :errors => [
+    { path: 'path/to/file.rb' }
+  ],
+  :api_errors => [
+    { code: 404, msg_body: 'some message from github api', path: 'path/to/file.rb' }
+  ]
+}
+```
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/caspg/fasterer-github.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/fasterer-github.gemspec

@@ -0,0 +1,30 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'fasterer/github/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'fasterer-github'
+  spec.version       = Fasterer::Github::VERSION
+  spec.authors       = ['Kacper Goliński']
+  spec.email         = ['kacper.golinski@gmail.co']
+
+  spec.summary       = 'Fasterer extension which allows to scan github repo. '
+  spec.homepage      = 'https://github.com/caspg/fasterer-github'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_development_dependency 'bundler', '~> 1.10'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec'
+  spec.add_development_dependency 'pry'
+  spec.add_development_dependency 'webmock'
+  spec.add_development_dependency 'vcr'
+
+  spec.add_runtime_dependency 'fasterer', '0.1.11'
+  spec.add_runtime_dependency 'httparty'
+end

data/lib/fasterer/github/analyzer_extension.rb

@@ -0,0 +1,37 @@
+require 'fasterer'
+require 'base64'
+
+module Fasterer
+  module Github
+    class AnalyzerExtension < Fasterer::Analyzer
+      def initialize(content64)
+        @content64 = content64
+        @file_content = decoded_content
+      end
+
+      def scan
+        super
+      end
+
+      def errors
+        super
+      end
+
+      def offences
+        offences = {}
+        errors.group_by(&:name).each do |k, v|
+          offences[k] = v.map(&:line_number)
+        end
+        offences
+      end
+
+      private
+
+      attr_reader :content64
+
+      def decoded_content
+        Base64.decode64(content64)
+      end
+    end
+  end
+end

data/lib/fasterer/github/api_wrapper.rb

@@ -0,0 +1,41 @@
+require 'httparty'
+
+module Fasterer
+  module Github
+    class ApiWrapper
+      BASE_URL = 'https://api.github.com'
+
+      def initialize(owner, repo)
+        @owner = owner
+        @repo = repo
+        @access_token = Fasterer::Github.configuration.access_token.to_s
+        @client_id = Fasterer::Github.configuration.client_id.to_s
+        @client_secret = Fasterer::Github.configuration.client_secret.to_s
+      end
+
+      def contents(path)
+        url = build_url(path)
+        HTTParty.get(url)
+      end
+
+      private
+
+      attr_reader :owner, :repo, :path, :client_id, :client_secret, :access_token
+
+      def build_url(path)
+        url = BASE_URL + "/repos/#{owner}/#{repo}/contents/#{path}"
+        return add_access_token(url) if access_token != ''
+        return add_client_id_and_secret(url) if client_id != '' && client_secret != ''
+        url
+      end
+
+      def add_access_token(url)
+        url + "?access_token=#{access_token}"
+      end
+
+      def add_client_id_and_secret(url)
+        url + "?client_id=#{client_id}&client_secret=#{client_secret}"
+      end
+    end
+  end
+end

data/lib/fasterer/github/configuration.rb

@@ -0,0 +1,30 @@
+module Fasterer
+  module Github
+    class << self
+      attr_accessor :configuration
+    end
+
+    def self.configure
+      yield(configuration)
+    end
+
+    def self.configuration
+      @configuration ||= Configuration.new
+    end
+
+    def self.reset_configuration
+      Fasterer::Github.configuration = nil
+      Fasterer::Github.configure {}
+    end
+
+    class Configuration
+      attr_accessor :client_id, :client_secret, :access_token
+
+      def initialize
+        @client_id = nil
+        @client_secret = nil
+        @access_token = nil
+      end
+    end
+  end
+end

data/lib/fasterer/github/gh_traverser.rb

@@ -0,0 +1,65 @@
+require_relative 'api_wrapper'
+
+module Fasterer
+  module Github
+    class GhTraverser
+      def initialize(owner, repo, path)
+        @owner = owner
+        @repo = repo
+        @path = path.to_s
+      end
+
+      def traverse
+        catch(:rate_limit) { collect_data(path) }
+      end
+
+      def collected_data
+        @collected_data ||= []
+      end
+
+      def api_errors
+        @api_errors ||= []
+      end
+
+      private
+
+      attr_reader :owner, :repo, :path
+
+      def wrapper
+        @wrapper ||= Fasterer::Github::ApiWrapper.new(owner, repo)
+      end
+
+      def collect_data(path)
+        response = wrapper.contents(path)
+        return store_api_error(response, path) unless response.code < 400
+        parsed_response = response.parsed_response
+
+        if parsed_response.is_a?(Hash)
+          return unless match_regex?(parsed_response['path'])
+          store_data(parsed_response)
+        else
+          parsed_response.each { |item| collect_data(item['path']) }
+        end
+      end
+
+      def store_api_error(response, path)
+        response_code = response.code
+        api_errors << { code: response_code, msg_body: response.body, path: path }
+        throw(:rate_limit) if rate_limit_error?(response)
+      end
+
+      def rate_limit_error?(response)
+        response.code == 403 && response.body =~ /rate limit exceeded/i
+      end
+
+      def store_data(response)
+        file_data = { path: response['path'], content64: response['content'] }
+        collected_data << file_data
+      end
+
+      def match_regex?(file_name)
+        file_name =~ /(.rb)$/
+      end
+    end
+  end
+end

data/lib/fasterer/github/output_composer.rb

@@ -0,0 +1,51 @@
+module Fasterer
+  module Github
+    class OutputComposer
+      def initialize(owner, repo)
+        @repo_owner = owner
+        @repo_name = repo
+      end
+
+      def add_offences(offences, path)
+        offences.each do |offence_name, lines|
+          details = { path: path, lines: lines }
+          (fasterer_offences[offence_name] ||= []) << details
+        end
+      end
+
+      def add_errors(path)
+        errors << { path: path }
+      end
+
+      def add_api_errors(new_api_errors)
+        new_api_errors.each { |e| api_errors << e }
+      end
+
+      def result
+        {
+          repo_owner: repo_owner,
+          repo_name: repo_name,
+          fasterer_offences: fasterer_offences,
+          errors: errors,
+          api_errors: api_errors
+        }
+      end
+
+      private
+
+      attr_accessor :repo_owner, :repo_name
+
+      def fasterer_offences
+        @fasterer_offenses ||= {}
+      end
+
+      def errors
+        @errors ||= []
+      end
+
+      def api_errors
+        @api_errors ||= []
+      end
+    end
+  end
+end

data/lib/fasterer/github/scanner.rb

@@ -0,0 +1,51 @@
+require 'fasterer/github/gh_traverser'
+require 'fasterer/github/output_composer'
+require 'fasterer/github/analyzer_extension'
+
+module Fasterer
+  module Github
+    class Scanner
+      def initialize(owner, repo, path)
+        @owner = owner
+        @repo = repo
+        @path = path
+      end
+
+      def run
+        data = traverse_and_collect_data
+        data.each { |d| analyze_code(d) }
+      end
+
+      def results
+        output_composer.result
+      end
+
+      private
+
+      attr_reader :owner, :repo, :path
+
+      def traverser
+        @traverser ||= Fasterer::Github::GhTraverser.new(owner, repo, path)
+      end
+
+      def output_composer
+        @output_composer ||= Fasterer::Github::OutputComposer.new(owner, repo)
+      end
+
+      def traverse_and_collect_data
+        traverser.traverse
+        output_composer.add_api_errors(traverser.api_errors) if traverser.api_errors.any?
+        traverser.collected_data
+      end
+
+      def analyze_code(data)
+        analyzer = Fasterer::Github::AnalyzerExtension.new(data[:content64])
+        analyzer.scan
+      rescue RubyParser::SyntaxError, Racc::ParseError, Timeout::Error
+        output_composer.add_errors(data[:path])
+      else
+        output_composer.add_offences(analyzer.offences, data[:path])
+      end
+    end
+  end
+end

data/lib/fasterer/github/version.rb

@@ -0,0 +1,5 @@
+module Fasterer
+  module Github
+    VERSION = '0.1.0'
+  end
+end

data/lib/fasterer/github.rb

@@ -0,0 +1,13 @@
+require 'fasterer/github/version'
+require 'fasterer/github/scanner'
+require 'fasterer/github/configuration'
+
+module Fasterer
+  module Github
+    def self.scan(owner, repo, path = nil)
+      scanner = Fasterer::Github::Scanner.new(owner, repo, path)
+      scanner.run
+      scanner.results
+    end
+  end
+end

metadata

@@ -0,0 +1,173 @@
+--- !ruby/object:Gem::Specification
+name: fasterer-github
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Kacper Goliński
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2015-10-20 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.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'
+- !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'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  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: vcr
+  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: fasterer
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.1.11
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.1.11
+- !ruby/object:Gem::Dependency
+  name: httparty
+  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'
+description: 
+email:
+- kacper.golinski@gmail.co
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- fasterer-github.gemspec
+- lib/fasterer/github.rb
+- lib/fasterer/github/analyzer_extension.rb
+- lib/fasterer/github/api_wrapper.rb
+- lib/fasterer/github/configuration.rb
+- lib/fasterer/github/gh_traverser.rb
+- lib/fasterer/github/output_composer.rb
+- lib/fasterer/github/scanner.rb
+- lib/fasterer/github/version.rb
+homepage: https://github.com/caspg/fasterer-github
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.6
+signing_key: 
+specification_version: 4
+summary: Fasterer extension which allows to scan github repo.
+test_files: []
+has_rdoc: