coverband-service-client 0.0.6

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 2bbda63a9e7eacfee67d03b5e0b08f9a4a2ef31d4eea06fcb3901730b81fad95
+  data.tar.gz: bab021109fc8d6a785f273c35a7e39c9da4cf78f65d3a2b3a52105d2c9c00333
+SHA512:
+  metadata.gz: c9b9fa656753664c2e6dd37670274d9bd9231dea30c071c8735c406f234649e9c1758804da33239889ad6e7636c4652ac8e8d6c851d2eb87b74bb62683d40cc8
+  data.tar.gz: 52f461ebbfdbd5b379c7e8a48661c89aada386cca21e85f60aee3b075bb9291b6a9397503063117c33b850c933562339d57dd5910727f6713240fe57ce84e12e

data/.gitignore

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

data/.travis.yml

@@ -0,0 +1,7 @@
+---
+sudo: false
+language: ruby
+cache: bundler
+rvm:
+  - 2.5.3
+before_install: gem install bundler -v 2.0.2

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at danmayer@gmail.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,4 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in coverband-service-client.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,26 @@
+PATH
+  remote: .
+  specs:
+    coverband-service-client (0.0.6)
+      coverband (~> 4.2.4)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    coverband (4.2.4)
+      redis
+    minitest (5.14.0)
+    rake (13.0.1)
+    redis (4.1.3)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 2.0)
+  coverband-service-client!
+  minitest (~> 5.0)
+  rake (~> 13.0)
+
+BUNDLED WITH
+   2.0.2

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2020 Dan Mayer
+
+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,43 @@
+# Coverband::Service::Client
+
+Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/coverband/service/client`. To experiment with that code, run `bin/console` for an interactive prompt.
+
+TODO: Delete this and the text above, and describe your gem
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'coverband-service-client'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install coverband-service-client
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. 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).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/coverband-service-client. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the Coverband::Service::Client project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/coverband-service-client/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList["test/**/*_test.rb"]
+end
+
+task :default => :test

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "coverband/service/client"
+
+# 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/changelog.md

@@ -0,0 +1 @@
+initial release

data/coverband-service-client.gemspec

@@ -0,0 +1,33 @@
+lib = File.expand_path("lib", __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "coverband/service/client/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "coverband-service-client"
+  spec.version       = Coverband::Service::Client::VERSION
+  spec.authors       = ["Dan Mayer", "Karl Baum"]
+  spec.email         = ["danmayer@gmail.com"]
+
+  spec.summary       = %q{Coverband Service Client}
+  spec.description   = %q{Coverband service client}
+  spec.homepage      = "https://github.com/coverband-service/coverband-service-client"
+  spec.license       = "MIT"
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = "https://github.com/coverband-service/coverband-service-client"
+  spec.metadata["changelog_uri"] = "https://github.com/coverband-service/coverband-service-client"
+
+  # 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_development_dependency "bundler", "~> 2.0"
+  spec.add_development_dependency "rake", "~> 13.0"
+  spec.add_development_dependency "minitest", "~> 5.0"
+  spec.add_runtime_dependency "coverband", "~> 4.2.4"
+end

data/lib/coverband-service-client.rb

@@ -0,0 +1,192 @@
+# frozen_string_literal: true
+
+require 'coverband/service/client/version'
+require 'securerandom'
+
+COVERBAND_ENV = ENV['RACK_ENV'] || ENV['RAILS_ENV'] || (defined?(Rails) ? Rails.env : 'unknown')
+COVERBAND_SERVICE_URL = ENV['COVERBAND_URL'] ||
+  ((COVERBAND_ENV == 'development') ? 'http://127.0.0.1:3456' : 'https://coverband-service.herokuapp.com')
+COVERBAND_TIMEOUT = (COVERBAND_ENV == 'development') ? 5 : 1
+
+module Coverband
+
+  if COVERBAND_ENV == 'test' && !ENV['COVERBAND_ENABLE_TEST_MODE']
+    def self.report_coverage
+      # for now disable coverband reporting in test env by default
+    end
+  end
+
+    module Adapters
+      ###
+      # Take Coverband data and store a merged coverage set to the Coverband service
+      #
+      # NOTES:
+      # * uses net/http to avoid any dependencies
+      # * currently JSON, but likely better to move to something simpler / faster
+      ###
+      class Service < Base
+        attr_reader :coverband_url, :process_type, :runtime_env
+
+        def initialize(coverband_url, opts = {})
+          super()
+          @coverband_url = coverband_url
+          @process_type = opts.fetch(:process_type) { 'unknown' }
+          @runtime_env = opts.fetch(:runtime_env) { COVERBAND_ENV }
+        end
+
+        def clear!
+          # TBD
+        end
+
+        def clear_file!(filename)
+          # TBD
+        end
+
+        # TODO: we should support nil to mean not supported
+        def size
+          0
+        end
+
+        # TODO: no longer get by type just get both reports in a single request
+        def coverage(local_type = nil, opts = {})
+          local_type ||= opts.key?(:override_type) ? opts[:override_type] : type
+          uri = URI("#{coverband_url}/api/coverage/#{ENV['COVERBAND_ID']}?type=#{local_type}")
+          req = Net::HTTP::Get.new(uri, 'Content-Type' => 'application/json', 'Coverband-Token' => ENV['COVERBAND_API_KEY'])
+          res = Net::HTTP.start(uri.hostname, uri.port, use_ssl: uri.scheme == 'https') do |http|
+            http.request(req)
+          end
+          coverage_data = JSON.parse(res.body)
+          # puts "coverage data: "
+          # puts coverage_data
+          coverage_data
+        rescue StandardError => e
+          puts "Coverband: Error while retrieving coverage #{e}"
+        end
+
+        def save_report(report)
+          #puts caller.join(',')
+          return if report.empty?
+
+          # TODO: do we need dup
+          # TODO: remove timestamps, server will track first_seen
+          Thread.new do
+            data = expand_report(report.dup)
+            full_package = {
+              collection_type: 'coverage_delta',
+              collection_data: {
+                tags: {
+                  process_type: process_type,
+                  app_loading: type == Coverband::EAGER_TYPE,
+                  runtime_env: runtime_env
+                },
+                file_coverage: data
+              }
+            }
+            save_coverage(full_package)
+          end&.join
+        end
+
+        def raw_store
+          self
+        end
+
+        private
+
+        def save_coverage(data)
+          uri = URI("#{coverband_url}/api/collector")
+          req = Net::HTTP::Post.new(uri,
+                                    'Content-Type' => 'application/json',
+                                    'Coverband-Token' => ENV['COVERBAND_API_KEY'])
+          # puts "sending #{data}"
+          req.body = { remote_uuid: SecureRandom.uuid, data: data }.to_json
+          res = Net::HTTP.start(
+            uri.hostname,
+            uri.port,
+            open_timeout: COVERBAND_TIMEOUT,
+            read_timeout: COVERBAND_TIMEOUT,
+            ssl_timeout: COVERBAND_TIMEOUT,
+            use_ssl: uri.scheme == 'https'
+            ) do |http|
+            http.request(req)
+          end
+        rescue StandardError => e
+          puts "Coverband: Error while saving coverage #{e}"
+        end
+      end
+    end
+
+  module Service
+    module Client
+      class Error < StandardError; end
+    end
+  end
+end
+
+###
+# TODO: move to a subclass, but the railtie needs to allow setting
+# so for now just overiding the class to report via net::http
+###
+module Coverband
+  module Collectors
+    class ViewTracker
+      def report_views_tracked
+        reported_time = Time.now.to_i
+        if views_to_record.any?
+          relative_views = views_to_record.map! do |view|
+            roots.each do |root|
+              view = view.gsub(/#{root}/, '')
+            end
+            view
+          end
+          save_tracked_views(views: relative_views, reported_time: reported_time)
+        end
+        self.views_to_record = []
+      rescue StandardError => e
+        # we don't want to raise errors if Coverband can't reach redis.
+        # This is a nice to have not a bring the system down
+        logger&.error "Coverband: view_tracker failed to store, error #{e.class.name}"
+      end
+
+      private
+
+      def save_tracked_views(views:, reported_time:)
+        uri = URI("#{COVERBAND_SERVICE_URL}/api/collector")
+        req = Net::HTTP::Post.new(uri, 'Content-Type' => 'application/json', 'Coverband-Token' => ENV['COVERBAND_API_KEY'])
+        data = {
+          collection_type: 'view_tracker_delta',
+          collection_data: {
+            tags: {
+              runtime_env: COVERBAND_ENV
+            },
+            collection_time: reported_time,
+            tracked_views: views
+          }
+        }
+        # puts "sending #{data}"
+        req.body = { remote_uuid: SecureRandom.uuid, data: data }.to_json
+        res = Net::HTTP.start(uri.hostname, uri.port, use_ssl: uri.scheme == 'https') do |http|
+          http.request(req)
+        end
+      rescue StandardError => e
+        puts "Coverband: Error while saving coverage #{e}"
+      end
+    end
+  end
+end
+
+Coverband.configure do |config|
+  # Use The Test Service Adapter
+  config.store = Coverband::Adapters::Service.new(COVERBAND_SERVICE_URL)
+
+  # default to tracking views true
+  config.track_views = ENV['COVERBAND_ENABLE_VIEW_TRACKER'] ? true : false
+
+  # report every 10m by default
+  config.background_reporting_sleep_seconds = COVERBAND_ENV == 'production' ? 600 : 60
+  # add a wiggle to avoid service stampede
+  config.reporting_wiggle = COVERBAND_ENV == 'production' ? 90 : 6
+
+  if COVERBAND_ENV == 'test'
+    config.background_reporting_enabled = false
+  end
+end

data/lib/coverband/service/client/version.rb

@@ -0,0 +1,7 @@
+module Coverband
+  module Service
+    module Client
+      VERSION = '0.0.6'
+    end
+  end
+end

metadata

@@ -0,0 +1,117 @@
+--- !ruby/object:Gem::Specification
+name: coverband-service-client
+version: !ruby/object:Gem::Version
+  version: 0.0.6
+platform: ruby
+authors:
+- Dan Mayer
+- Karl Baum
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2020-03-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: coverband
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 4.2.4
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 4.2.4
+description: Coverband service client
+email:
+- danmayer@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- changelog.md
+- coverband-service-client.gemspec
+- lib/coverband-service-client.rb
+- lib/coverband/service/client/version.rb
+homepage: https://github.com/coverband-service/coverband-service-client
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/coverband-service/coverband-service-client
+  source_code_uri: https://github.com/coverband-service/coverband-service-client
+  changelog_uri: https://github.com/coverband-service/coverband-service-client
+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: []
+rubygems_version: 3.0.3
+signing_key: 
+specification_version: 4
+summary: Coverband Service Client
+test_files: []