bullet_proof_json 0.1.0 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: aeade736ab3a008d00b531f23618b7392faa686b5c549d925cb13449d93af940
-  data.tar.gz: acbdc1bfc70bf17d1ab143300fcd99ea418c3ad050cd561e9623d1687fd6a44a
+  metadata.gz: 34ddf20fa884b08de58f2b6345d6a95f15f3eca92349b29377219cc2323691d6
+  data.tar.gz: 9435f6aa2cf52335ab5154280c397bad0593f0e81e3d5cd1f970d32269018769
 SHA512:
-  metadata.gz: 0c401ddb954c1947c915f7d94775a7cbdcde597fb8fcb2659ae74f9a784ef6bf80779f4dd62b2e5c7598b93da17b09df3e9ad22a51445201189664189710fb7d
-  data.tar.gz: e47dd701ffaf691eb39c15f6eda994fd8c7fdeed536d3f7f095b8bf0878be4ddf546a9f8102e5406a0a8a68f84df6bb19ec962e18c3e4f711ff5d3aab265d2b6
+  metadata.gz: 33534e8d747a100b7f6e657a2eccfc74e002736d6b4863207fa18378ad01ffbc7675a6b5bdffc95c4b4ee1df2b37e24a32e85dd041988db78599076d981b7d17
+  data.tar.gz: eff4ea4dc8d24e85651146ae46eb65a7c6882413fa12ce479447bd725eced5141ff85605295369cc3b17eae9164e82a032286cac6c13d8a8f5f9ce697c5225ca

data/.github/workflows/ruby.yml

@@ -0,0 +1,37 @@
+name: Ruby RSpec Tests
+
+on:
+  push:
+    branches:
+      - main
+  pull_request:
+    branches:
+      - main
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+
+    steps:      
+      - name: Checkout repository
+        uses: actions/checkout@v3
+
+      - name: Set up Ruby
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: '3.3'
+
+      - name: Install dependencies
+        run: |
+          gem install bundler
+          bundle install
+
+      - name: Run RSpec tests
+        run: bundle exec rspec
+
+      - name: Upload coverage reports to Codecov
+        uses: codecov/codecov-action@v5
+        with:
+          files: coverage/.resultset.json
+          token: ${{ secrets.CODECOV_TOKEN }}
+          verbose: false

data/.gitignore

@@ -46,11 +46,17 @@ build-iPhoneSimulator/
 # for a library or gem, you might want to ignore these files since the code is
 # intended to run in multiple environments; otherwise, check them in:
 # Gemfile.lock
-# .ruby-version
+.ruby-version
 # .ruby-gemset
 
 # unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
 .rvmrc
 
 # Used by RuboCop. Remote config files pulled in from inherit_from directive.
-# .rubocop-https?--*
+# .rubocop-https?--*
+
+# .DS_Store
+.DS_Store
+
+# rspec status
+.rspec_status

data/CHANGELOG.md

@@ -0,0 +1,14 @@
+## [0.2.1] - 2025-07-22
+### Added
+- How to release a new version in README
+- Full test coverage
+- Upload test coverage to codecov.io using codecov/codecov-action@v5 GitHub action
+### Fixed
+- max_retries condition
+
+## [0.2.0] - 2025-07-22
+### Added
+- HTTP request header User-Agent with a gem name to be identified properly by public APIs
+
+## [0.1.0] - 2025-02-09
+- Initial version

data/Gemfile.lock

@@ -1,15 +1,16 @@
 PATH
   remote: .
   specs:
-    bullet_proof_json (0.1.0)
+    bullet_proof_json (0.2.1)
 
 GEM
   remote: https://rubygems.org/
   specs:
     coderay (1.1.3)
-    diff-lcs (1.5.1)
-    ffi (1.17.1)
-    formatador (1.1.0)
+    diff-lcs (1.6.2)
+    docile (1.4.1)
+    ffi (1.17.2)
+    formatador (1.1.1)
     guard (2.19.1)
       formatador (>= 0.2.4)
       listen (>= 2.7, < 4.0)
@@ -29,36 +30,42 @@ GEM
     listen (3.9.0)
       rb-fsevent (~> 0.10, >= 0.10.3)
       rb-inotify (~> 0.9, >= 0.9.10)
-    logger (1.6.5)
-    lumberjack (1.2.10)
+    logger (1.7.0)
+    lumberjack (1.3.1)
     method_source (1.1.0)
     nenv (0.3.0)
     notiffany (0.1.3)
       nenv (~> 0.1)
       shellany (~> 0.0)
-    ostruct (0.6.1)
+    ostruct (0.6.3)
     pry (0.15.2)
       coderay (~> 1.1)
       method_source (~> 1.0)
-    rake (10.5.0)
+    rake (12.3.3)
     rb-fsevent (0.11.2)
     rb-inotify (0.11.1)
       ffi (~> 1.0)
-    rspec (3.13.0)
+    rspec (3.13.1)
       rspec-core (~> 3.13.0)
       rspec-expectations (~> 3.13.0)
       rspec-mocks (~> 3.13.0)
-    rspec-core (3.13.3)
+    rspec-core (3.13.5)
       rspec-support (~> 3.13.0)
-    rspec-expectations (3.13.3)
+    rspec-expectations (3.13.5)
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.13.0)
-    rspec-mocks (3.13.2)
+    rspec-mocks (3.13.5)
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.13.0)
-    rspec-support (3.13.2)
+    rspec-support (3.13.4)
     shellany (0.0.1)
-    thor (1.2.2)
+    simplecov (0.22.0)
+      docile (~> 1.1)
+      simplecov-html (~> 0.11)
+      simplecov_json_formatter (~> 0.1)
+    simplecov-html (0.13.2)
+    simplecov_json_formatter (0.1.4)
+    thor (1.4.0)
 
 PLATFORMS
   ruby
@@ -69,8 +76,9 @@ DEPENDENCIES
   guard (~> 2.19.1)
   guard-rspec (~> 4.7.3)
   pry (~> 0.15.2)
-  rake (~> 10.0)
+  rake (~> 12.3)
   rspec (~> 3.0)
+  simplecov (~> 0.22.0)
 
 BUNDLED WITH
    2.6.3

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2025 Grzegorz Błaszczyk
+
+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

@@ -1,4 +1,9 @@
-# Goal
+[![Ruby RSpec Tests](https://github.com/grzegorzblaszczyk/bullet-proof-json/actions/workflows/ruby.yml/badge.svg)](https://github.com/grzegorzblaszczyk/bullet-proof-json/actions/workflows/ruby.yml)
+[![Dependabot Updates](https://github.com/grzegorzblaszczyk/bullet-proof-json/actions/workflows/dependabot/dependabot-updates/badge.svg)](https://github.com/grzegorzblaszczyk/bullet-proof-json/actions/workflows/dependabot/dependabot-updates)
+[![Gem Version](https://badge.fury.io/rb/bullet-proof-json.svg)](https://badge.fury.io/rb/bullet-proof-json)
+[![codecov](https://codecov.io/gh/grzegorzblaszczyk/bullet-proof-json/branch/main/graph/badge.svg)](https://codecov.io/gh/grzegorzblaszczyk/bullet-proof-json)
+
+# The Goal
 
 Tired of dealing with unreliable REST APIs with JSON responses, endless timeouts, and complex error handling just to fetch some JSON data?
 
@@ -17,6 +22,8 @@ It depends only on a few standard Ruby libraries like:
 * JSON
 * Net::HTTP
 
+🪶 No dependencies except standard Ruby classes.
+
 # Installation
 
 Add this line to your application's Gemfile:
@@ -71,3 +78,16 @@ The gem is available as open source under the terms of the [MIT License](https:/
 
 Everyone interacting in the BulletProofJSON project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/grzegorzblaszczyk/bullet-proof-json-provider//blob/master/CODE_OF_CONDUCT.md).
 
+## How to release a new version to RubyGems.org
+
+```bash
+rspec spec
+mdv CHANGELOG.md
+git ci -m "UPGRADE: version x.y.z" .
+git push origin main
+gem build bullet_proof_json.gemspec
+gem push bullet_proof_json-x.y.z.gem
+git tag vx.y.z
+git push origin main --tags
+```
+

data/SECURITY.md

@@ -0,0 +1,5 @@
+# Security Policy
+
+## Reporting a Vulnerability
+
+Please create a new issue in Issues section: https://github.com/grzegorzblaszczyk/bullet-proof-json/issues

data/bullet_proof_json.gemspec

@@ -9,6 +9,9 @@ Gem::Specification.new do |spec|
   spec.authors       = ["Grzegorz Błaszczyk"]
   spec.email         = ["grzegorz.blaszczyk@gmail.com"]
 
+  spec.metadata["source_code_uri"]  = "https://github.com/grzegorzblaszczyk/bullet-proof-json"
+  spec.metadata["changelog_uri"]    = "https://github.com/grzegorzblaszczyk/bullet-proof-json/blob/main/CHANGELOG.md"
+
   spec.summary       = "Bullet Proof JSON for Ruby with seamless request handling, smart throttling and robust retry mchanism"
   spec.description   = "Bullet Proof JSON for Ruby takes the hassle out of API response handling by offering: Seamless Request Handling - automatically manage timeouts and errors so your app stays resilient, Smart Throttling - respect API rate limits without overcomplicating your code, Robust Retry Mechanism - never miss a response due to transient errors."
   spec.homepage      = "https://github.com/grzegorzblaszczyk/bullet-proof-json"
@@ -29,6 +32,7 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "guard", "~> 2.19.1"
   spec.add_development_dependency "guard-rspec", "~> 4.7.3"
   spec.add_development_dependency "pry", "~> 0.15.2"
-  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rake", "~> 12.3"
   spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "simplecov", "~> 0.22.0"
 end

data/lib/bullet_proof_json/provider.rb

@@ -23,12 +23,13 @@ module BulletProofJson
         uri = URI(uri_string)
         http_headers = {}
         http_headers["Authorization"] = "Bearer #{@api_key}" unless @api_key.nil?
+        http_headers["User-Agent"] = user_agent
         response = ::Net::HTTP.get(uri, http_headers)
         json = JSON(response)
 
       rescue ::Net::ReadTimeout => e
         @logger.error(self.class.name, " #{page.nil? ? "" : (page.to_s + ":")} #{e}\n#{uri_string}")
-        if (attempts += 1) < max_attempts
+        if (attempts += 1) <= max_attempts
           @logger.debug(self.class.name, "\tAttempt no. #{attempts} ...")
           sleep sleep_time
           retry
@@ -39,7 +40,7 @@ module BulletProofJson
 
       rescue ::Net::OpenTimeout => e
         @logger.error(self.class.name, " #{page.nil? ? "" : (page.to_s + ":")} #{e}\n#{uri_string}")
-        if (attempts += 1) < max_attempts
+        if (attempts += 1) <= max_attempts
           @logger.debug(self.class.name, "\tAttempt no. #{attempts} ...")
           sleep sleep_time
           retry
@@ -51,7 +52,7 @@ module BulletProofJson
       rescue ::JSON::ParserError => e
         @logger.error(self.class.name, " #{page.nil? ? "" : (page.to_s + ":")} #{e}\n#{uri_string}")
 
-        if (attempts += 1) < max_attempts
+        if (attempts += 1) <= max_attempts
           @logger.debug(self.class.name,  "\tAttempt no. #{attempts} ...")
           sleep sleep_time
           retry
@@ -63,6 +64,11 @@ module BulletProofJson
       json
     end
 
+    private
+      def user_agent(version = BulletProofJson::VERSION)
+        "bullet-proof-json #{version} - https://github.com/grzegorzblaszczyk/bullet-proof-json"
+      end
+
   end
 
   class ProviderError < ::StandardError

data/lib/bullet_proof_json/version.rb

@@ -1,3 +1,3 @@
 module BulletProofJson
-  VERSION = "0.1.0"
+  VERSION = "0.2.1"
 end

data/lib/bullet_proof_json.rb

@@ -1,5 +1,5 @@
-require "bullet_proof_json/version"
 require_relative "bullet_proof_json/provider"
+require_relative "bullet_proof_json/version"
 require_relative "bullet_proof_json/console_logger"
 
 module BulletProofJson

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: bullet_proof_json
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.1
 platform: ruby
 authors:
 - Grzegorz Błaszczyk
 bindir: bin
 cert_chain: []
-date: 2025-02-09 00:00:00.000000000 Z
+date: 2025-07-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -71,14 +71,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '12.3'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '12.3'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -93,6 +93,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.22.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.22.0
 description: 'Bullet Proof JSON for Ruby takes the hassle out of API response handling
   by offering: Seamless Request Handling - automatically manage timeouts and errors
   so your app stays resilient, Smart Throttling - respect API rate limits without
@@ -104,16 +118,19 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".DS_Store"
+- ".github/workflows/ruby.yml"
 - ".gitignore"
 - ".ruby-version"
+- CHANGELOG.md
 - CODE_OF_CONDUCT.md
 - Gemfile
 - Gemfile.lock
 - Guardfile
 - LICENSE
+- LICENSE.txt
 - README.md
 - Rakefile
+- SECURITY.md
 - bin/console
 - bin/setup
 - bullet_proof_json.gemspec
@@ -124,7 +141,9 @@ files:
 homepage: https://github.com/grzegorzblaszczyk/bullet-proof-json
 licenses:
 - MIT
-metadata: {}
+metadata:
+  source_code_uri: https://github.com/grzegorzblaszczyk/bullet-proof-json
+  changelog_uri: https://github.com/grzegorzblaszczyk/bullet-proof-json/blob/main/CHANGELOG.md
 rdoc_options: []
 require_paths:
 - lib