yabeda-http_requests 0.1.2 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2e88ed961b6fdf5bf867af58791f09cf2181e5eefdea74f85524a227bf76f9df
-  data.tar.gz: e0894e32de707a0ba65cc29b13f52aa7dd3559dfba4bda8e782761142a32c003
+  metadata.gz: 8f5c7fa7bfe5b47c64c40b7fcee8ebd9d35358a0c6f5b6dced6b5ed255282ab7
+  data.tar.gz: 2a771d809057200cad55ffd88aa1d0f4183016c316d9c6836d7d6465b9163f5e
 SHA512:
-  metadata.gz: 13ca203dbb2e22a66bab57b914cba89619d6e4c67b05acaf5c3b5f85838221701e1277eaab05c0b45277d1fb192c7c4cae32b6f0a7f0d4078d61ed40f46f4095
-  data.tar.gz: 31c2a0b712ecd8d17b49d7dd7cabd121cdba354e793daecd7b7241734a1ad65dfbf98da4e7dd0dfd064bc5aa9a8c7d3231b71a21f54294479c40ccce9b25e0cc
+  metadata.gz: fd615c28e1a2bd5ab02974fc6fd3e69114717d450d02453f2fdeb3748d47125c8c2a2cc2b488cd98afbf0803c6c39df7b3f86461d56273530c8ddccef02142ac
+  data.tar.gz: 6a410a70d61d54a26eeb3efa91b69aae96e30e6beccaac3ca14c0d7022c702eeb9ac6db9d43cbb642e3792ffe0a9a32d6051ec264123a2b768c2136bc83e5fe8

data/.github/workflows/build-release.yml

@@ -0,0 +1,82 @@
+name: Build and release gem to RubyGems
+
+on:
+  push:
+    tags:
+      - v*
+
+jobs:
+  release:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+        with:
+          fetch-depth: 0 # Fetch current tag as annotated. See https://github.com/actions/checkout/issues/290
+      - uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: 2.7
+      - name: "Extract data from tag: version, message, body"
+        id: tag
+        run: |
+          git fetch --tags --force # Really fetch annotated tag. See https://github.com/actions/checkout/issues/290#issuecomment-680260080
+          echo ::set-output name=version::${GITHUB_REF#refs/tags/v}
+          echo ::set-output name=subject::$(git for-each-ref $GITHUB_REF --format='%(contents:subject)')
+          BODY="$(git for-each-ref $GITHUB_REF --format='%(contents:body)')"
+          # Extract changelog entries between this and previous version headers
+          escaped_version=$(echo ${GITHUB_REF#refs/tags/v} | sed -e 's/[]\/$*.^[]/\\&/g')
+          changelog=$(awk "BEGIN{inrelease=0} /## ${escaped_version}/{inrelease=1;next} /## [0-9]+\.[0-9]+\.[0-9]+/{inrelease=0;exit} {if (inrelease) print}" CHANGELOG.md)
+          # Multiline body for release. See https://github.community/t/set-output-truncates-multiline-strings/16852/5
+          BODY="${BODY}"$'\n'"${changelog}"
+          BODY="${BODY//'%'/'%25'}"
+          BODY="${BODY//$'\n'/'%0A'}"
+          BODY="${BODY//$'\r'/'%0D'}"
+          echo "::set-output name=body::$BODY"
+          # Add pre-release option if tag name has any suffix after vMAJOR.MINOR.PATCH
+          if [[ ${GITHUB_REF#refs/tags/} =~ ^v[0-9]+\.[0-9]+\.[0-9]+.+ ]]; then
+            echo ::set-output name=prerelease::true
+          fi
+      - name: Build gem
+        run: gem build
+      - name: Calculate checksums
+        run: sha256sum yabeda-http_requests-${{ steps.tag.outputs.version }}.gem > SHA256SUM
+      - name: Check version
+        run: ls -l yabeda-http_requests-${{ steps.tag.outputs.version }}.gem
+      - name: Create Release
+        id: create_release
+        uses: actions/create-release@v1
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+        with:
+          tag_name: ${{ github.ref }}
+          release_name: ${{ steps.tag.outputs.subject }}
+          body: ${{ steps.tag.outputs.body }}
+          draft: false
+          prerelease: ${{ steps.tag.outputs.prerelease }}
+      - name: Upload built gem as release asset
+        uses: actions/upload-release-asset@v1
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+        with:
+          upload_url: ${{ steps.create_release.outputs.upload_url }}
+          asset_path: yabeda-http_requests-${{ steps.tag.outputs.version }}.gem
+          asset_name: yabeda-http_requests-${{ steps.tag.outputs.version }}.gem
+          asset_content_type: application/x-tar
+      - name: Upload checksums as release asset
+        uses: actions/upload-release-asset@v1
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+        with:
+          upload_url: ${{ steps.create_release.outputs.upload_url }}
+          asset_path: SHA256SUM
+          asset_name: SHA256SUM
+          asset_content_type: text/plain
+      - name: Publish to GitHub packages
+        env:
+          GEM_HOST_API_KEY: Bearer ${{ secrets.GITHUB_TOKEN }}
+        run: |
+          gem push yabeda-http_requests-${{ steps.tag.outputs.version }}.gem --host https://rubygems.pkg.github.com/${{ github.repository_owner }}
+      - name: Publish to RubyGems
+        env:
+          GEM_HOST_API_KEY: "${{ secrets.RUBYGEMS_API_KEY }}"
+        run: |
+          gem push yabeda-http_requests-${{ steps.tag.outputs.version }}.gem

data/.github/workflows/test.yml

@@ -0,0 +1,47 @@
+name: Run tests
+
+on:
+  pull_request:
+  push:
+    branches:
+      - '**'
+    tags-ignore:
+      - 'v*'
+
+jobs:
+  test:
+    name: "Run tests"
+    if: "! contains(toJSON(github.event.commits.latest.message), '[ci skip]')"
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        include:
+          - ruby: 3.0
+          - ruby: 2.7
+          - ruby: 2.6
+          - ruby: 2.5
+    container:
+      image: ruby:${{ matrix.ruby }}
+      env:
+        CI: true
+    steps:
+      - uses: actions/checkout@v2
+      - uses: actions/cache@v2
+        with:
+          path: vendor/bundle
+          key: bundle-${{ matrix.ruby }}-${{ hashFiles('**/*.gemspec') }}-${{ hashFiles('**/Gemfile') }}
+          restore-keys: |
+            bundle-${{ matrix.ruby }}-${{ hashFiles('**/*.gemspec') }}-${{ hashFiles('**/Gemfile') }}
+            bundle-${{ matrix.ruby }}-
+      - name: Upgrade Bundler to 2.0 (for older Rubies)
+        run: gem install bundler -v '~> 2.0'
+      - name: Bundle install
+        run: |
+          bundle config path vendor/bundle
+          bundle install
+          bundle update
+      - name: Run Rubocop
+        run: bundle exec rubocop
+      - name: Run RSpec
+        run: bundle exec rspec

data/CHANGELOG.md

@@ -0,0 +1,38 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/)
+and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.html).
+
+## 0.2.0 - 2021-01-25
+
+### Fixed
+
+- Ruby 3.0 compatibility due to keyword arguments behavior change. [@danmarcab], [#3](https://github.com/yabeda-rb/yabeda-http_requests/pull/3)
+- Sniffer middleware chain execution. [@dreikanter], [#2](https://github.com/yabeda-rb/yabeda-http_requests/pull/2)
+
+### Removed
+
+- Support for Ruby 2.3 and 2.4 as they've reached their End of Life and Sniffer supports only 2.5 and newer anyway. [@Envek]
+
+## 0.1.2 - 2020-03-26
+
+### Fixed
+
+- Error related to constant search. [@dsalahutdinov]
+
+## 0.1.1 - 2020-03-23
+
+### Fixed
+
+- Memory bloat problem due to requests and responses history stored by Sniffer. [@dsalahutdinov]
+
+## 0.1.0 - 2020-03-19
+
+Initial release.
+
+[@dsalahutdinov]: https://github.com/dsalahutdinov "Dmitry Salahutdinov"
+[@dreikanter]: https://github.com/dreikanter "Alex Musayev"
+[@danmarcab]: https://github.com/danmarcab "Daniel Marín"
+[@Envek]: https://github.com/Envek "Andrey Novikov"

data/README.md

@@ -79,6 +79,37 @@ docker-compose run app bundle exec rspec
 
 Bug reports and pull requests are welcome on GitHub at https://github.com/yabeda-rb/yabeda-http_requests.
 
+### Releasing
+
+1. Bump version number in `lib/yabeda/http_requests/version.rb`
+
+   In case of pre-releases keep in mind [rubygems/rubygems#3086](https://github.com/rubygems/rubygems/issues/3086) and check version with command like `Gem::Version.new(Yabeda::VERSION).to_s`
+
+2. Fill `CHANGELOG.md` with missing changes, add header with version and date.
+
+3. Make a commit:
+
+   ```sh
+   git add lib/yabeda/http_requests/version.rb CHANGELOG.md
+   version=$(ruby -r ./lib/yabeda/http_requests/version.rb -e "puts Gem::Version.new(Yabeda::HttpRequests::VERSION)")
+   git commit --message="${version}: " --edit
+   ```
+
+4. Create annotated tag:
+
+   ```sh
+   git tag v${version} --annotate --message="${version}: " --edit --sign
+   ```
+
+5. Fill version name into subject line and (optionally) some description (list of changes will be taken from changelog and appended automatically)
+
+6. Push it:
+
+   ```sh
+   git push --follow-tags
+   ```
+
+7. GitHub Actions will create a new release, build and push gem into RubyGems! You're done!
 
 ## License
 

data/lib/yabeda/http_requests.rb

@@ -10,15 +10,14 @@ module Yabeda
   module HttpRequests
     SNIFFER_STORAGE_SIZE = 0
 
-    # rubocop: disable Metrics/BlockLength
+    LONG_RUNNING_REQUEST_BUCKETS = [
+      0.5, 1, 2.5, 5, 10, 25, 50, 100, 250, 500, 1000, # standard
+      30_000, 60_000, 120_000, 300_000, 600_000 # slow queries
+    ].freeze
+
     Yabeda.configure do
       group :http
 
-      LONG_RUNNING_REQUEST_BUCKETS = [
-        0.5, 1, 2.5, 5, 10, 25, 50, 100, 250, 500, 1000, # standard
-        30_000, 60_000, 120_000, 300_000, 600_000 # slow queries
-      ].freeze
-
       counter :request_total,
               comment: 'A counter of the total number of external HTTP \
                          requests.',
@@ -43,6 +42,5 @@ module Yabeda
         end
       end
     end
-    # rubocop: enable Metrics/BlockLength
   end
 end

data/lib/yabeda/http_requests/sniffer.rb

@@ -5,14 +5,18 @@ module Yabeda
     # Middleware for sniffer gem
     class Sniffer
       def request(data_item)
+        yield
         Yabeda.http_request_total.increment(
-          host: data_item.request.host,
-          port: data_item.request.port,
-          method: data_item.request.method
+          {
+            host: data_item.request.host,
+            port: data_item.request.port,
+            method: data_item.request.method
+          }
         )
       end
 
       def response(data_item)
+        yield
         log_http_response_total(data_item)
         log_http_response_duration(data_item)
       end
@@ -21,10 +25,12 @@ module Yabeda
 
       def log_http_response_total(data_item)
         Yabeda.http_response_total.increment(
-          host: data_item.request.host,
-          port: data_item.request.port,
-          method: data_item.request.method,
-          status: data_item.response.status
+          {
+            host: data_item.request.host,
+            port: data_item.request.port,
+            method: data_item.request.method,
+            status: data_item.response.status
+          }
         )
       end
 

data/lib/yabeda/http_requests/version.rb

@@ -2,6 +2,6 @@
 
 module Yabeda
   module HttpRequests
-    VERSION = '0.1.2'
+    VERSION = '0.2.0'
   end
 end

data/yabeda-http_requests.gemspec

@@ -12,7 +12,7 @@ Gem::Specification.new do |spec|
   spec.description   = 'Extends Yabeda metrics to collect external calls'
   spec.homepage      = 'https://github.com/yabeda-rb/yabeda-http_requests'
   spec.license       = 'MIT'
-  spec.required_ruby_version = Gem::Requirement.new('>= 2.3.0')
+  spec.required_ruby_version = Gem::Requirement.new('>= 2.5')
 
   spec.metadata['homepage_uri'] = spec.homepage
   spec.metadata['source_code_uri'] = 'https://github.com/yabeda-rb/yabeda-http_requests'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: yabeda-http_requests
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.2.0
 platform: ruby
 authors:
 - Dmitry Salahutdinov
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-03-26 00:00:00.000000000 Z
+date: 2021-01-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: sniffer
@@ -45,10 +45,12 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/workflows/build-release.yml"
+- ".github/workflows/test.yml"
 - ".gitignore"
 - ".rspec"
 - ".rubocop.yml"
-- ".travis.yml"
+- CHANGELOG.md
 - Gemfile
 - LICENSE.txt
 - README.md
@@ -74,14 +76,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.3.0
+      version: '2.5'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.2
+rubygems_version: 3.1.4
 signing_key: 
 specification_version: 4
 summary: Monitoring of external services HTTP/HTTPS calls

data/.travis.yml

@@ -1,6 +0,0 @@
----
-language: ruby
-cache: bundler
-rvm:
-  - 2.7.0
-before_install: gem install bundler -v 2.1.2