api_pi 0.2.3 → 0.9

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 9bb93d26d0c2c0268df45e1d0c7b65bfac8fa71c
-  data.tar.gz: 625d48a0cd5faa4c4c25d4ef2c0eb95954214edb
+SHA256:
+  metadata.gz: 590ba41eee563126e54dbd3e6381ef5de82cf19ca7f64c7c8c7bcaf569fe6692
+  data.tar.gz: 8a40403e38f2e3691508a0eb8e5cb0b8380f8676fdb13bc16872faa1fd1d6175
 SHA512:
-  metadata.gz: d608c3bf845f9945b2904a12c22ac8c66b3213b794e090fd4b2b9d4c7728e0d36652a9d2c8594d25ef423f64bb952e0702a665ae9129bd059883133f150b2f30
-  data.tar.gz: 05181cb0c380d83d1fb509ec88ae90900abeb64edaff4c187e7ad250a1b5a06de4b7db4fb206d042a47ed66e6d95350d1aa6df6d5f0ac444bd723fedc7a87608
+  metadata.gz: 913b42c2cf80243ebe5a36af4208f5bcf2f25f0fb1525dc3eb84070203efec1283b227bf0479bea2489440b5d64158670e89f746f2b32305ee1f6c53e6437b97
+  data.tar.gz: 5c642f942401b018e98ac68f54a9de30be6bcc4a5b7f4973ec6b582e1be1d6a83c50d77042c8247903538c2ad571bd6089d682254906e012a04ad06a2aaa5b1e

data/.ruby-version

@@ -1 +1 @@
-2.0.0-p0
+2.6.5

data/.travis.yml

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

data/Gemfile.lock

@@ -1,26 +1,35 @@
 PATH
   remote: .
   specs:
-    api_pi (0.2.2)
-      map (~> 6.5)
+    api_pi (0.2.6)
+      map (~> 6.6)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    addressable (2.3.5)
-    crack (0.4.2)
+    addressable (2.7.0)
+      public_suffix (>= 2.0.2, < 5.0)
+    crack (0.4.3)
       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)
+    hashdiff (1.0.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)
       crack (>= 0.3.2)
+      hashdiff (>= 0.4.0, < 2.0.0)
 
 PLATFORMS
   ruby
 
 DEPENDENCIES
   api_pi!
-  rake (~> 10.1)
-  webmock (~> 1.17)
+  minitest (~> 5.8.4)
+  rake (~> 13.0.0)
+  webmock (~> 3.7.6)
+
+BUNDLED WITH
+   1.17.2

data/README.md

@@ -1,17 +1,17 @@
 # API P.I.
 
-A ruby DSL to test expected values in a service API!
+[![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.
 
 ## Install
 
-Api P.I. requires ruby 2.0.0+
-
 Install the gem:
 
     $ gem install api_pi 
-    
+
 ## Usage
 
 ### GETting Data
@@ -59,7 +59,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 +132,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

data/api_pi.gemspec

@@ -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 = '>= 2.0.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'
 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/{apiary.rb → example.rb}

@@ -2,14 +2,13 @@ require 'api_pi'
 
 set_header "api-pi-demo-header", "api-pi-example"
 
-get "http://apipi.apiary.io/tests" do
+get "https://raw.githubusercontent.com/benwoody/api_pi/master/example/example.json" do
 
   test "headers" do
-    response.header.contenttype.is "application/json"
     response.code.is 200
   end
 
-  test "body results.string" do
+  test "results.string" do
     response.body.results.string.is_a String
     response.body.results.string.matches /\w*/
   end
@@ -25,6 +24,6 @@ get "http://apipi.apiary.io/tests" do
   end
 
   test "results.array" do
-    response.body.results.array.includes 4
+    response.body.results.array.includes 3
   end
 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/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/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'
 end

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

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,57 +1,71 @@
 --- !ruby/object:Gem::Specification
 name: api_pi
 version: !ruby/object:Gem::Version
-  version: 0.2.3
+  version: '0.9'
 platform: ruby
 authors:
 - Ben Woodall
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-05-08 00:00:00.000000000 Z
+date: 2019-10-31 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.8.4
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 5.8.4
 - !ruby/object:Gem::Dependency
   name: webmock
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.17'
+        version: 3.7.6
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.17'
+        version: 3.7.6
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.1'
+        version: 13.0.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.1'
+        version: 13.0.0
 description: A ruby DSL to validate API requests.
 email: mail@benwoodall.com
 executables: []
@@ -59,14 +73,16 @@ extensions: []
 extra_rdoc_files:
 - README.md
 files:
-- .gitignore
-- .ruby-version
+- ".gitignore"
+- ".ruby-version"
+- ".travis.yml"
 - 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
@@ -86,17 +102,16 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: 2.0.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.0.0
+rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
 summary: API validation DSL