api_pi 0.2.3 → 0.9.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 9bb93d26d0c2c0268df45e1d0c7b65bfac8fa71c
-  data.tar.gz: 625d48a0cd5faa4c4c25d4ef2c0eb95954214edb
+SHA256:
+  metadata.gz: ffac63a3f0f7ce1538044fa5336546effe59dc64b0a16a528761c80a740123c0
+  data.tar.gz: 146038c0ac9dd68fef685101c02370ab251cb7d77e3b2ab30af0a8013ba4a14d
 SHA512:
-  metadata.gz: d608c3bf845f9945b2904a12c22ac8c66b3213b794e090fd4b2b9d4c7728e0d36652a9d2c8594d25ef423f64bb952e0702a665ae9129bd059883133f150b2f30
-  data.tar.gz: 05181cb0c380d83d1fb509ec88ae90900abeb64edaff4c187e7ad250a1b5a06de4b7db4fb206d042a47ed66e6d95350d1aa6df6d5f0ac444bd723fedc7a87608
+  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.0.0-p0
+3.3.4

data/Gemfile.lock

@@ -1,26 +1,40 @@
 PATH
   remote: .
   specs:
-    api_pi (0.2.2)
-      map (~> 6.5)
+    api_pi (0.9.3)
+      map (~> 6.6)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    addressable (2.3.5)
-    crack (0.4.2)
-      safe_yaml (~> 1.0.0)
-    map (6.5.1)
-    rake (10.1.0)
-    safe_yaml (1.0.1)
-    webmock (1.17.3)
-      addressable (>= 2.2.7)
+    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.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!
-  rake (~> 10.1)
-  webmock (~> 1.17)
+  minitest (~> 5.24.1)
+  rake (~> 13.2.1)
+  webmock (~> 3.23.1)
+
+BUNDLED WITH
+   2.5.15

data/README.md

@@ -1,17 +1,16 @@
 # API P.I.
+![API P.I.](https://raw.githubusercontent.com/benwoody/api_pi/main/logo/pi-logo.jpg)
 
-A ruby DSL to test expected values in a service API!
-
-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
 
-Api P.I. requires ruby 2.0.0+
-
 Install the gem:
 
     $ gem install api_pi 
-    
+
 ## Usage
 
 ### GETting Data
@@ -59,7 +58,7 @@ Header fields can be queried using the following format:
 `response.header` is required in order to use dot notation on header fields.
 
 Example:
-    
+
     response.header.connection.is 'keep-alive'
     response.header.contenttype.is 'application/json'
 
@@ -132,7 +131,7 @@ This goes through the array and tests every item in it!
     "this".is "that"  => false
     
 ### is_a, is_an
-  
+
 The `is_a` and `is_an` assertions are used to assert Type on a field:
 
     "Hello, World!".is_a String   => true
@@ -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,9 +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.add_dependency             'map', '~> 6.5'
-  g.add_development_dependency 'webmock', '~> 1.17'
-  g.add_development_dependency 'rake', '~> 10.1'
+  g.required_ruby_version = '>= 3.0'
+
+  g.add_dependency             'map', '~> 6.6'
+  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.json

@@ -0,0 +1,12 @@
+{
+  "metadata": {
+    "totalCount": 120,
+    "totalPageCount": 13
+  },
+  "results": {
+    "string": "I'm a String!",
+    "int": 12,
+    "here": "I'm present!",
+    "array": [0, 1, 2, 3]
+  }
+}

data/example/example.rb

@@ -0,0 +1,39 @@
+require 'api_pi'
+
+set_header "api-pi-demo-header", "api-pi-example"
+
+get "https://raw.githubusercontent.com/benwoody/api_pi/master/example/example.json" do
+
+  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
+    response.body.results.string.is_a String
+    response.body.results.string.matches /\w*/
+  end
+
+  test "results.int" do
+    response.body.results.int.is_an Integer
+  end
+
+  test "results.array" do
+    response.body.results.array.is_an Array
+    response.body.results.array.includes 3
+  end
+end

data/lib/api_pi/assertion.rb

@@ -15,13 +15,13 @@ class Object
     end
     true
   end
-  
+
   # `is` assertions are used to compare exact values.
-  #   
+  #
   #     "this".is "this"  => true
   #     200.is "200"      => true
   #     "this".is "that"  => false
-  
+
   def is this
     msg = "#{self} is not #{this}"
     if this.is_a? Integer
@@ -32,29 +32,29 @@ class Object
   end
 
   # The `is_a` and `is_an` assertions are used to assert Type on a field:
-  # 
+  #
   #     "Hello, World!".is_a String   => true
   #     3.14159265359.is_a Float      => true
   #     "Not an array!".is_an Array   => false
-  
+
   def is_a klass
     msg = "#{self} is not a #{klass}"
-    check_if self.is_a?(klass), msg 
+    check_if self.is_a?(klass), msg
   end
   alias :is_an :is_a
 
   # The `has_key` assertion can be used to query if a certain
   # field is present in a JSON block:
-  # 
+  #
   #     { "here": "present!" }.has_key "here"   => true
   #     { "here": "present!" }.has_key "nope!"  => false
-  
+
   def has_key kkey
     msg = "#{kkey} was not found in #{self.keys.join(', ')}}"
     check_if self.respond_to?(kkey), msg
   end
 
-  # The `has_keys` assertion works the same as `has_key`, except it takes 
+  # The `has_keys` assertion works the same as `has_key`, except it takes
   # multiple keys and tests them all at once:
   #
   #     { "here": "present!", "hello": "world!" }.has_keys "here","hello" => true
@@ -71,7 +71,7 @@ class Object
       true
     else
       nf = not_found.join(", ")
-      msg = "#{nf} were not found in #{self.keys.join(', ')}" 
+      msg = "#{nf} were not found in #{self.keys.join(', ')}"
       raise ApiPi::AssertionError, msg
     end
   end
@@ -88,7 +88,7 @@ class Object
   end
 
   # `matches` expectes a Regex formed value.
-  # 
+  #
   #     "hello".matches /ll/    => true
 
   def matches regex
@@ -97,7 +97,7 @@ class Object
   end
 
   # `includes` can be used for array to query if specific values are present:
-  # 
+  #
   #     [1,2,3,4].includes 2    => true
 
   def includes item
@@ -106,7 +106,7 @@ class Object
   end
 
   # `not_nil?` checks to see if the value is nil:
-  # 
+  #
   #     nil.not_nil?          => false
   #     "something".not_nil?  => true
 
@@ -116,10 +116,10 @@ class Object
   end
 
   # `stripped?` will test is there is whitespace before or after a string:
-  # 
+  #
   #     "works".stripped?     => true
   #     " spaces ".stripped?  => false
-  
+
   def stripped?
     msg = "#{self} contains whitespace"
     check_if(self.strip == self, msg)

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/request.rb

@@ -9,7 +9,9 @@ module Kernel
     uri = URI.parse url
     get = Net::HTTP::Get.new(uri)
     req = Net::HTTPHeader.build_headers get
-    resp = Net::HTTP.start(uri.host, uri.port) { |http| http.request(req) }
+    http = Net::HTTP.new(uri.host, uri.port)
+    http.use_ssl = (uri.scheme == 'https')
+    resp = http.request req
     json = net_parse resp
     ApiPi::Dsl.new(json).parse(url, block)
   end
@@ -21,7 +23,7 @@ module Kernel
   end
 
   private
-   
+
     # Groups all of the response parsing
 
     def net_parse response

data/lib/api_pi/version.rb

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

data/lib/api_pi.rb

@@ -5,7 +5,7 @@ require 'api_pi/assertion'
 require 'api_pi/version'
 
 module ApiPi
-  
+
   # Build Headers, setting default User-Agent.
 
   HEADER = { "user-agent" => "ApiPi-v#{ApiPi::VERSION}"}

data/test/test_helper.rb

@@ -3,7 +3,7 @@ require 'webmock/minitest'
 require 'api_pi'
 
 module ApiPi
-  class TestCase < MiniTest::Unit::TestCase
+  class TestCase < Minitest::Test
 
     def setup
       map = { k: "v", a: [1,2,3], m: 1 }

data/test/unit/test_assertions.rb

@@ -2,10 +2,10 @@ require 'test_helper'
 
 module ApiPi
   class TestAssertions < TestCase
-    
+
     def test_patch_methods
       assert Object.respond_to?(:check_if), Object.check_if(true, "Yep")
-      assert Object.respond_to?(:is), Object.is(Object) 
+      assert Object.respond_to?(:is), Object.is(Object)
       assert Object.respond_to?(:is_a), @map.k.is_a(String)
       assert Object.respond_to?(:is_an), Object.is_an(Object)
       assert Object.respond_to?(:has_key), @map.has_key(:k)
@@ -38,7 +38,7 @@ module ApiPi
     end
 
     def test_is_a__with_true
-      assert "string".is_a(String) 
+      assert "string".is_a(String)
     end
 
     def test_is_a__with_false
@@ -58,7 +58,7 @@ module ApiPi
     end
 
     def test_has_keys__with_false
-      assert_raises(ApiPi::AssertionError) { @map.has_keys(:n,:r) } 
+      assert_raises(ApiPi::AssertionError) { @map.has_keys(:n,:r) }
     end
 
     def test_lacks_key__with_true
@@ -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

data/test/unit/test_dsl.rb

@@ -5,7 +5,7 @@ module ApiPi
 
     def test_response_gathering
       r = ApiPi::Dsl.new(t:'t')
-      r.test "metadata" do 
+      r.test "metadata" do
         "test".is_a(String)
       end
       assert r.tests.has_key?('metadata'), r.tests['metadata']

metadata

@@ -1,103 +1,119 @@
 --- !ruby/object:Gem::Specification
 name: api_pi
 version: !ruby/object:Gem::Version
-  version: 0.2.3
+  version: 0.9.3
 platform: ruby
 authors:
 - Ben Woodall
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2014-05-08 00:00:00.000000000 Z
+date: 2024-07-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: map
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '6.5'
+        version: '6.6'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '6.5'
+        version: '6.6'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 5.24.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 5.24.1
 - !ruby/object:Gem::Dependency
   name: webmock
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.17'
+        version: 3.23.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.17'
+        version: 3.23.1
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.1'
+        version: 13.2.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.1'
-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:
-- .gitignore
-- .ruby-version
+- ".github/workflows/tests.yml"
+- ".gitignore"
+- ".ruby-version"
 - Gemfile
 - Gemfile.lock
 - README.md
 - Rakefile
 - api_pi.gemspec
-- example/apiary.rb
+- example/example.json
+- example/example.rb
 - lib/api_pi.rb
 - lib/api_pi/assertion.rb
 - lib/api_pi/case.rb
 - 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
 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: []
-rubyforge_project: 
-rubygems_version: 2.0.0
-signing_key: 
+rubygems_version: 3.5.11
+signing_key:
 specification_version: 4
 summary: API validation DSL
 test_files:

data/example/apiary.rb

@@ -1,30 +0,0 @@
-require 'api_pi'
-
-set_header "api-pi-demo-header", "api-pi-example"
-
-get "http://apipi.apiary.io/tests" do
-
-  test "headers" do
-    response.header.contenttype.is "application/json"
-    response.code.is 200
-  end
-
-  test "body results.string" do
-    response.body.results.string.is_a String
-    response.body.results.string.matches /\w*/
-  end
-
-  test "results.int" do
-    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.includes 4
-  end
-end