pig-ci-rails 0.2.2 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 692e79ca136ab61ee5ab3e6c5c96e8ea6aabbdb6ab41d64af488f25d082d7748
-  data.tar.gz: 8c763069f1f45db06b156c01a3365246c3a656550d5a4e4155e1790070535710
+  metadata.gz: b66f58f3bb5e578d8856a2f51d28024ba4174f05cd346c9c2dc710d3ce87ecf2
+  data.tar.gz: 421d50cde44adf6eb69abb5a726383aef6e1271ad9ba21ced7bda35821f8a437
 SHA512:
-  metadata.gz: 22b24a17c062e0f39ac32cb3de7a59f3ae6a5d5a36c9b54517b74d2fc6849fc63993fd48e67fd1588ef31ef1f0749bd7dc4b72a315ca079c163a1c1656827e60
-  data.tar.gz: 27a1c3c392292f2b6022b2d38725b2ba9988db6cf3c038413ffdac0fae4b8238ae65c2c1995eee89660d893db6dedac842ae4d4d35b0ff5a3f97c9db0fa0a92b
+  metadata.gz: 6c481a3f96647b1e85bf9b25ea62e18e7265a1b95fc802c6f0d37eb0a69769be91ca3478ac0e4f589f8784bc22c26a1328488f84f5dec59a0defc0dbf2bf8277
+  data.tar.gz: 299023a04fd3302922a16b50f3af2f4ae2a12e653d41793d1d33037287a92dfaeac1c659e7cbddc6e64d54ce99e207f8e775221b07fca3075ff12328d84c0542

data/CHANGELOG.md

@@ -1,8 +1,10 @@
 # Changelog
 
-## 0.3.0 (In Development)
+## 1.0.1 (In development
 
-* TODO: Deprecate pigci.com integration.
+## 1.0.0
+
+* [Removing PigCI.com integration](https://github.com/PigCI/pig-ci-rails/pull/27) - For more information please [see my announcement](https://pigci.com/github-integration-deprecation-notice).
 
 ## 0.2.2
 

data/README.md

@@ -7,7 +7,7 @@
 
 # PigCI
 
-![Sample Output of PigCI in TravisCI](https://user-images.githubusercontent.com/325384/76989551-76307f00-693e-11ea-8afc-c568a9b1e5fe.png)
+![Sample Output of PigCI in TravisCI](https://user-images.githubusercontent.com/325384/78711087-545b6400-790e-11ea-96b7-bb75c119914a.png)
 
 Monitor your Ruby Applications metrics (Memory, SQL Requests & Request Time) as part of your test suite.
 
@@ -81,24 +81,6 @@ end # if RSpec.configuration.files_to_run.count > 1
 
 You can see the full configuration options [lib/pig_ci.rb](https://github.com/PigCI/pig-ci-rails/blob/master/lib/pig_ci.rb#L21).
 
-
-### With [PigCI.com](https://pigci.com) - For sharing runs as a team via CI
-
-_Note: This feature will be deprecated in the future. Instead use "Configuring thresholds" to have CI pass/fail._
-
-You can hookup your project to PigCI.com, this will fail PRs when metric thresholds are exceeded (e.g. your app see a big increase in memory).
-
-```ruby
-# In spec/rails_helper.rb
-require 'pig_ci'
-PigCI.start do |config|
-  # When you connect your project, you'll be given an API key.
-  config.api_key = 'your-api-key-here'
-end
-```
-
-It's a great way to track metrics over time & support this project.
-
 ### Framework support
 
 Currently this gem only supports Ruby on Rails tested via RSpec.
@@ -150,10 +132,7 @@ To install this gem onto your local machine, run `bundle exec rake install`. To
 
 Features I'd like to add at some point:
 
-* Add support for "upsert" for when tests are split over multiple machines
 * HTML output to include branch - Right now they're just timestamps which makes filtering hard.
-* Document setting branch/commit to handle when CI doesn't set it correctly.
-* Add rake for submitting reports.
 * https://rubydoc.info/gems/yard/file/docs/GettingStarted.md - Document the gem so it's easier for people to jump on.
 * Support ActionCable (when requests have no key).
 

data/config/locales/pig_ci/en.yml

@@ -1,10 +1,5 @@
 en:
   pig_ci:
-    api:
-      reports:
-        success: 'PigCI: Successfully submitted report to pigci.com'
-        error: 'Unable to connect to PigCI API: %{error}'
-        api_error: 'Unable to connect to PigCI API'
     summary:
       ci_start: 'PigCI Thresholds Summary:'
       ci_failure: 'PigCI: This commit has exceeded the thresholds defined in PigCI.thresholds'

data/lib/pig_ci.rb

@@ -3,7 +3,6 @@ require 'active_support/core_ext/string/inflections'
 require 'rake'
 
 require 'pig_ci/version'
-require 'pig_ci/api'
 require 'pig_ci/configuration'
 require 'pig_ci/decorator'
 require 'pig_ci/summary'
@@ -88,21 +87,6 @@ module PigCI
     @profiler_engine ||= PigCI::ProfilerEngine::Rails.new
   end
 
-  attr_writer :api_base_uri
-  def api_base_uri
-    @api_base_uri || 'https://api.pigci.com/api'
-  end
-
-  attr_accessor :api_verify_ssl
-  def api_verify_ssl?
-    !@api_verify_ssl.nil? ? @api_verify_ssl : true
-  end
-
-  attr_accessor :api_key
-  def api_key?
-    !@api_key.nil? && @api_key != ''
-  end
-
   attr_writer :commit_sha1
   def commit_sha1
     @commit_sha1 || ENV['CI_COMMIT_ID'] || ENV['CIRCLE_SHA1'] || ENV['TRAVIS_COMMIT'] || `git rev-parse HEAD`.strip
@@ -113,6 +97,11 @@ module PigCI
     @head_branch || ENV['CI_BRANCH'] || ENV['CIRCLE_BRANCH'] || ENV['TRAVIS_BRANCH'] || `git rev-parse --abbrev-ref HEAD`.strip
   end
 
+  # Throw deprecation notice for setting API
+  def api_key=(value)
+    puts 'DEPRECATED: PigCI.com API has been retired, you no longer need to set config.api_key in your spec/rails_helper.rb file.'
+  end
+
   attr_writer :locale
   def locale
     @locale || :en
@@ -161,9 +150,6 @@ module PigCI
     # Save the report summary to the project root.
     PigCI::Summary::HTML.new(reports: profiler_engine.reports).save! if PigCI.generate_html_summary?
 
-    # If they have an API key, share it with PigCI.com
-    PigCI::Api::Reports.new(reports: profiler_engine.reports).share! if PigCI.api_key?
-
     # Make sure CI fails when metrics are over thresholds.
     PigCI::Summary::CI.new(reports: profiler_engine.reports).call!
   end

data/lib/pig_ci/version.rb

@@ -1,3 +1,3 @@
 module PigCI
-  VERSION = '0.2.2'.freeze
+  VERSION = '1.0.0'.freeze
 end

data/pig_ci.gemspec

@@ -24,7 +24,6 @@ Gem::Specification.new do |spec|
   spec.add_dependency 'activesupport', '>= 4.2'
   spec.add_dependency 'colorize', '>= 0.8.1'
   spec.add_dependency 'get_process_mem', '~> 0.2.3'
-  spec.add_dependency 'httparty', '>= 0.16'
   spec.add_dependency 'i18n', '>= 0.9', '< 2'
   spec.add_dependency 'rails', '>= 4.2.0'
   spec.add_dependency 'terminal-table', '~> 1.8.0'
@@ -41,7 +40,7 @@ Gem::Specification.new do |spec|
   spec.post_install_message = [
     'Thank you for installing Pig CI!',
     'Upgrade Notes:',
-    'The latest version adds a "config.thresholds" option which will replace the pigci.com integration in future.',
+    'The latest version adds a "config.thresholds" option which replaces the PigCI.com GitHub integration.',
     'See https://github.com/PigCI/pig-ci-rails#configuring-thresholds for more information :)'
   ].join("\n")
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: pig-ci-rails
 version: !ruby/object:Gem::Version
-  version: 0.2.2
+  version: 1.0.0
 platform: ruby
 authors:
 - Mike Rogers
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-03-23 00:00:00.000000000 Z
+date: 2020-04-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -52,20 +52,6 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 0.2.3
-- !ruby/object:Gem::Dependency
-  name: httparty
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0.16'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0.16'
 - !ruby/object:Gem::Dependency
   name: i18n
   requirement: !ruby/object:Gem::Requirement
@@ -236,8 +222,6 @@ files:
 - bin/setup
 - config/locales/pig_ci/en.yml
 - lib/pig_ci.rb
-- lib/pig_ci/api.rb
-- lib/pig_ci/api/reports.rb
 - lib/pig_ci/configuration.rb
 - lib/pig_ci/decorator.rb
 - lib/pig_ci/decorator/report_terminal_decorator.rb
@@ -272,7 +256,7 @@ metadata: {}
 post_install_message: |-
   Thank you for installing Pig CI!
   Upgrade Notes:
-  The latest version adds a "config.thresholds" option which will replace the pigci.com integration in future.
+  The latest version adds a "config.thresholds" option which replaces the PigCI.com GitHub integration.
   See https://github.com/PigCI/pig-ci-rails#configuring-thresholds for more information :)
 rdoc_options: []
 require_paths:

data/lib/pig_ci/api.rb

@@ -1,14 +0,0 @@
-require 'httparty'
-
-class PigCI::Api
-  include HTTParty
-
-  def headers
-    {
-      'Content-Type': 'application/json',
-      'X-ApiKey': PigCI.api_key
-    }
-  end
-end
-
-require 'pig_ci/api/reports'

data/lib/pig_ci/api/reports.rb

@@ -1,47 +0,0 @@
-class PigCI::Api::Reports < PigCI::Api
-  def initialize(reports: [])
-    @reports = reports
-  end
-
-  def share!
-    response = post_payload
-    if response.success?
-      puts I18n.t('pig_ci.api.reports.success')
-      return
-    end
-
-    if response.parsed_response.is_a?(Hash)
-      puts I18n.t('pig_ci.api.reports.error', error: response.parsed_response.dig('error'))
-    else
-      puts I18n.t('pig_ci.api.reports.error')
-    end
-  rescue JSON::ParserError => _e
-    puts I18n.t('pig_ci.api.reports.api_error')
-  rescue SocketError => e
-    puts I18n.t('pig_ci.api.reports.error', error: e)
-  rescue Net::OpenTimeout => e
-    puts I18n.t('pig_ci.api.reports.error', error: e.inspect)
-  end
-
-  private
-
-  def post_payload
-    self.class.post(
-      '/v1/reports',
-      base_uri: PigCI.api_base_uri,
-      verify: PigCI.api_verify_ssl?,
-      body: payload,
-      headers: headers
-    )
-  end
-
-  def payload
-    {
-      library: 'pig-ci-rails',
-      library_version: PigCI::VERSION,
-      commit_sha1: PigCI.commit_sha1,
-      head_branch: PigCI.head_branch,
-      reports: @reports.collect { |report| report.to_payload_for(PigCI.run_timestamp) }
-    }.to_json
-  end
-end