api_pi 0.9 → 0.9.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 590ba41eee563126e54dbd3e6381ef5de82cf19ca7f64c7c8c7bcaf569fe6692
-  data.tar.gz: 8a40403e38f2e3691508a0eb8e5cb0b8380f8676fdb13bc16872faa1fd1d6175
+  metadata.gz: ffac63a3f0f7ce1538044fa5336546effe59dc64b0a16a528761c80a740123c0
+  data.tar.gz: 146038c0ac9dd68fef685101c02370ab251cb7d77e3b2ab30af0a8013ba4a14d
 SHA512:
-  metadata.gz: 913b42c2cf80243ebe5a36af4208f5bcf2f25f0fb1525dc3eb84070203efec1283b227bf0479bea2489440b5d64158670e89f746f2b32305ee1f6c53e6437b97
-  data.tar.gz: 5c642f942401b018e98ac68f54a9de30be6bcc4a5b7f4973ec6b582e1be1d6a83c50d77042c8247903538c2ad571bd6089d682254906e012a04ad06a2aaa5b1e
+  metadata.gz: cc1440f2f95e199ac892dcd5a1ccfac5075fccdbb0043dcdccb982bb183ace03dcde7c515d0a79cea21aad942405f0982cf07faecd50173c603172c01cf36c1b
+  data.tar.gz: 1b733e4953891974bcff398e7c7bb7b0d7346f64beb91f42861a5fa245a9893033f01c3db6386ecdbf54dc955a88883495a8f0a26d0c35d21864ea6be97e62d9

data/.github/workflows/tests.yml

@@ -0,0 +1,38 @@
+# This workflow uses actions that are not certified by GitHub.
+# They are provided by a third-party and are governed by
+# separate terms of service, privacy policy, and support
+# documentation.
+# This workflow will download a prebuilt Ruby version, install dependencies and run tests with Rake
+# For more information see: https://github.com/marketplace/actions/setup-ruby-jruby-and-truffleruby
+
+name: Tests
+
+on:
+  push:
+    branches: [ "main" ]
+  pull_request:
+    branches: [ "main" ]
+
+permissions:
+  contents: read
+
+jobs:
+  test:
+
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        ruby-version: ['3.0']
+
+    steps:
+    - uses: actions/checkout@v4
+    - name: Set up Ruby
+    # To automatically get bug fixes and new Ruby versions for ruby/setup-ruby,
+    # change this to (see https://github.com/ruby/setup-ruby#versioning):
+    # uses: ruby/setup-ruby@v1
+      uses: ruby/setup-ruby@55283cc23133118229fd3f97f9336ee23a179fcf # v1.146.0
+      with:
+        ruby-version: ${{ matrix.ruby-version }}
+        bundler-cache: true # runs 'bundle install' and caches installed gems automatically
+    - name: Run tests
+      run: bundle exec rake

data/.gitignore

@@ -1,2 +1,3 @@
 .bundle/
 *.gem
+vendor/

data/.ruby-version

@@ -1 +1 @@
-2.6.5
+3.3.4

data/Gemfile.lock

@@ -1,35 +1,40 @@
 PATH
   remote: .
   specs:
-    api_pi (0.2.6)
+    api_pi (0.9.3)
       map (~> 6.6)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    addressable (2.7.0)
-      public_suffix (>= 2.0.2, < 5.0)
-    crack (0.4.3)
-      safe_yaml (~> 1.0.0)
-    hashdiff (1.0.0)
+    addressable (2.8.7)
+      public_suffix (>= 2.0.2, < 7.0)
+    bigdecimal (3.1.8)
+    crack (1.0.0)
+      bigdecimal
+      rexml
+    hashdiff (1.1.0)
     map (6.6.0)
-    minitest (5.8.5)
-    public_suffix (4.0.1)
-    rake (13.0.0)
-    safe_yaml (1.0.5)
-    webmock (3.7.6)
-      addressable (>= 2.3.6)
+    minitest (5.24.1)
+    public_suffix (6.0.0)
+    rake (13.2.1)
+    rexml (3.3.1)
+      strscan
+    strscan (3.1.0)
+    webmock (3.23.1)
+      addressable (>= 2.8.0)
       crack (>= 0.3.2)
       hashdiff (>= 0.4.0, < 2.0.0)
 
 PLATFORMS
   ruby
+  x86_64-darwin-21
 
 DEPENDENCIES
   api_pi!
-  minitest (~> 5.8.4)
-  rake (~> 13.0.0)
-  webmock (~> 3.7.6)
+  minitest (~> 5.24.1)
+  rake (~> 13.2.1)
+  webmock (~> 3.23.1)
 
 BUNDLED WITH
-   1.17.2
+   2.5.15

data/README.md

@@ -1,10 +1,9 @@
 # API P.I.
+![API P.I.](https://raw.githubusercontent.com/benwoody/api_pi/main/logo/pi-logo.jpg)
 
-[![Build Status](https://travis-ci.org/benwoody/api_pi.svg)](https://travis-ci.org/benwoody/api_pi)
-
-A ruby DSL to test JSON contracts.
-
-An example test can be found in the example/ directory.
+A ruby DSL to investigate and test JSON contracts.
+----------
+[![Tests](https://github.com/benwoody/api_pi/actions/workflows/tests.yml/badge.svg?branch=main)](https://github.com/benwoody/api_pi/actions/workflows/tests.yml)
 
 ## Install
 
@@ -212,4 +211,3 @@ To-Do
 -----
 
 * Ability to basic_auth before GET request
-

data/api_pi.gemspec

@@ -7,7 +7,7 @@ Gem::Specification.new do |g|
   g.version = ApiPi::VERSION
 
   g.summary     = "API validation DSL"
-  g.description = "A ruby DSL to validate API requests."
+  g.description = "A ruby DSL to investigate and validate API requests."
 
   g.authors = "Ben Woodall"
   g.email   = "mail@benwoodall.com"
@@ -16,10 +16,10 @@ Gem::Specification.new do |g|
   g.test_files = `git ls-files -- test/*`.split("\n")
 
   g.extra_rdoc_files      = ["README.md"]
-  g.required_ruby_version = '>= 2.0.0'
+  g.required_ruby_version = '>= 3.0'
 
   g.add_dependency             'map', '~> 6.6'
-  g.add_development_dependency 'minitest', '~>5.8.4'
-  g.add_development_dependency 'webmock', '~> 3.7.6'
-  g.add_development_dependency 'rake', '~> 13.0.0'
+  g.add_development_dependency 'minitest', '~>5.24.1'
+  g.add_development_dependency 'webmock', '~> 3.23.1'
+  g.add_development_dependency 'rake', '~> 13.2.1'
 end

data/example/example.rb

@@ -6,6 +6,21 @@ get "https://raw.githubusercontent.com/benwoody/api_pi/master/example/example.js
 
   test "headers" do
     response.code.is 200
+    response.header.has_key "contenttype"
+  end
+
+  test "metadata" do
+    response.body.results.is_a Hash
+    response.body.metadata.has_keys "totalCount", "totalPageCount"
+    response.body.metadata.totalCount.is_a Integer
+    response.body.metadata.totalPageCount.is_a Integer
+  end
+
+  test "results" do
+    response.body.results.is_a Hash
+    response.body.results.has_key "string"
+    response.body.results.lacks_key "nope"
+    response.body.results.has_keys "string", "int", "here", "array"
   end
 
   test "results.string" do
@@ -17,13 +32,8 @@ get "https://raw.githubusercontent.com/benwoody/api_pi/master/example/example.js
     response.body.results.int.is_an Integer
   end
 
-  test "results" do
-    response.body.results.has_key "string"
-    response.body.results.lacks_key "nope"
-    response.body.results.has_keys "string","int","here","array"
-  end
-
   test "results.array" do
+    response.body.results.array.is_an Array
     response.body.results.array.includes 3
   end
 end

data/lib/api_pi/dsl.rb

@@ -16,19 +16,19 @@ module ApiPi
       pi.investigate
     end
 
-    # Test blocks are used to group similar assertions into readable units.  
-    # 
+    # Test blocks are used to group similar assertions into readable units.
+    #
     # For example, you may want to put your header tests into one test block:
-    # 
+    #
     #     get 'example.com/user.json' do
     #       test 'Headers have correct data' do
     #         # You header assertions...
     #       end
     #     end
-    # 
+    #
     # Inside of the test block, you would then put your header assertions.
-    # onceyou run your tests, your test blocks are grouped together and 
-    # pass/fail based on  assertions in the test block.
+    # onceyou run your tests, your test blocks are grouped together and
+    # pass/fail based on assertions in the test block.
 
     def test desc, &block
       @tests[desc] = block

data/lib/api_pi/version.rb

@@ -1,3 +1,3 @@
 module ApiPi
-  VERSION = '0.9'
+  VERSION = '0.9.3'
 end

data/test/unit/test_assertions.rb

@@ -95,7 +95,7 @@ module ApiPi
 
     def test_stripped?
       assert "stripped".stripped?
-      assert_raises(ApiPi::AssertionError) { " not_stripped ". stripped? }
+      assert_raises(ApiPi::AssertionError) { " not_stripped ".stripped? }
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: api_pi
 version: !ruby/object:Gem::Version
-  version: '0.9'
+  version: 0.9.3
 platform: ruby
 authors:
 - Ben Woodall
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2019-10-31 00:00:00.000000000 Z
+date: 2024-07-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: map
@@ -30,52 +30,52 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 5.8.4
+        version: 5.24.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 5.8.4
+        version: 5.24.1
 - !ruby/object:Gem::Dependency
   name: webmock
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.7.6
+        version: 3.23.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.7.6
+        version: 3.23.1
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 13.0.0
+        version: 13.2.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 13.0.0
-description: A ruby DSL to validate API requests.
+        version: 13.2.1
+description: A ruby DSL to investigate and validate API requests.
 email: mail@benwoodall.com
 executables: []
 extensions: []
 extra_rdoc_files:
 - README.md
 files:
+- ".github/workflows/tests.yml"
 - ".gitignore"
 - ".ruby-version"
-- ".travis.yml"
 - Gemfile
 - Gemfile.lock
 - README.md
@@ -89,14 +89,15 @@ files:
 - lib/api_pi/dsl.rb
 - lib/api_pi/request.rb
 - lib/api_pi/version.rb
+- logo/pi-logo.jpg
 - test/test_helper.rb
 - test/unit/test_assertions.rb
 - test/unit/test_dsl.rb
 - test/unit/test_requests.rb
-homepage: 
+homepage:
 licenses: []
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -104,15 +105,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.0.0
+      version: '3.0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
-signing_key: 
+rubygems_version: 3.5.11
+signing_key:
 specification_version: 4
 summary: API validation DSL
 test_files:

data/.travis.yml

@@ -1,14 +0,0 @@
----
-language: ruby
-
-rvm:
-  - 2.3.0
-  - 2.4
-  - 2.5
-  - 2.6
-
-bundler_args: --jobs=2
-script:
-  - bundle exec rake
-
-cache: bundler