spaceborne 0.1.12 → 0.1.13

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: cecb429979a5bbafcdf2456c67afe00ac6a59120
-  data.tar.gz: 0b312d718ab77fb05effac5407be2f23e3c455cb
+  metadata.gz: 6dcf5788db09b9481c533588b9195a5f2555c5eb
+  data.tar.gz: a9c53ea3c698e175a53689e1f8fac534dd29f7c7
 SHA512:
-  metadata.gz: fa6a5f063b41054844f8569c449d29f6f1ed55f6f30351015e41f8ad7781be728a9ecd754ea43efc9c6f3c1cfd1ca4482fbe71b2277eb65dad5ffa26966fb1c1
-  data.tar.gz: 83b22d29b9f577f88d6cb6f5d008106c3a80989930cf26224e0a76400aff70ce0690a18207f3ff937a3b0b238769a6006cd77c334be73a47140387384fbdc630
+  metadata.gz: 9eb5f6d3eccb530d6dcf8f3e74e60def75e9ce6cb6f3d54939a87260aa5b84ea479c65ec816d61660149389bc00bcd8a4738cfac9c1d73f627e7edcad669333c
+  data.tar.gz: 6df63627e5d075195d7b396e2b3c57ab7595e9a7313d987103e2378042b300d486b880cc0848a9871291c76fefc5e0e4a0d940e2bbaa3c8eff8260ee8e77273d

data/.rubocop.yml

@@ -0,0 +1,36 @@
+Style/FrozenStringLiteralComment:
+  Enabled: false
+
+Metrics/BlockLength:
+  Exclude:
+    - 'Rakefile'
+    - '**/*.rake'
+    - 'spec/**/*.rb'
+    - '*.gemspec'
+
+Metrics/MethodLength:
+  Exclude: 
+    - 'bin/*'
+
+Metrics/ModuleLength:
+  Exclude:
+    - 'Rakefile'
+    - '**/*.rake'
+    - 'spec/**/*.rb'
+    - 'bin/*'
+
+Metrics/ClassLength:
+  Exclude:
+    - 'bin/*'
+
+Metrics/LineLength:
+  Exclude:
+    - 'spec/airborne/**/*.rb'
+
+Style/DateTime:
+  Exclude:
+    - 'spec/airborne/**/*.rb'
+
+Lint/RescueException:
+  Exclude:
+    - 'lib/spaceborne.rb'

data/.ruby-gemset

@@ -0,0 +1 @@
+spaceborne

data/.ruby-version

@@ -0,0 +1 @@
+ruby-2.4.1

data/Gemfile

@@ -5,6 +5,6 @@ gemspec
 gem 'simplecov', require: false, group: :test
 
 group :test do
-  gem 'webmock'
   gem 'sinatra'
+  gem 'webmock'
 end

data/Rakefile

@@ -1,6 +1,6 @@
-require "bundler/gem_tasks"
-require "rspec/core/rake_task"
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
 
 RSpec::Core::RakeTask.new(:spec)
 
-task :default => :spec
+task default: :spec

data/lib/spaceborne.rb

@@ -1,80 +1,140 @@
 require 'airborne'
-require "spaceborne/version"
+require 'spaceborne/version'
 require 'rest-client'
 require 'byebug'
 require 'json'
 
+# module for apitesting with spaceborne
 module Spaceborne
-  def is_json?(headers)
-    headers.has_key?(:content_type) && headers[:content_type].include?('application/json')
+  def json?(headers)
+    headers.key?(:content_type) &&
+      headers[:content_type].include?('application/json')
   end
-  def wrap_request(&block)
-    block.call
+
+  def add_time
+    "TIME: #{Time.now.strftime('%d/%m/%Y %H:%M')}"
+  end
+
+  def add_request
+    if @request_body
+      "REQUEST: #{response.request.method.upcase} #{response.request.url}"\
+      "  HEADERS:\n#{JSON.pretty_generate(response.request.headers)}"\
+      "  PAYLOAD:\n#{@request_body}"
+    else
+      ''
+    end
+  end
+
+  def add_response
+    "RESPONSE: #{response.code}"\
+    "  HEADERS:\n#{JSON.pretty_generate(response.headers)}"\
+    << response_body
+  end
+
+  def response_body
+    return '' if response.request.method.casecmp('head').zero?
+    str = if json?(response.headers)
+            "  JSON_BODY\n#{JSON.pretty_generate(json_body)}"
+          else
+            "  BODY\n#{response.body}"
+          end
+    str
+  end
+
+  def request_info(str = '')
+    str << add_time << add_request << add_response
+    str
+  end
+
+  def wrap_request
+    yield
   rescue Exception => e
     raise e unless response
-    puts "TIME: #{Time.now.strftime("%d/%m/%Y %H:%M")}"
-    puts "REQUEST: #{response.request.method.upcase} #{response.request.url}"
-    puts "  HEADERS:\n#{JSON::pretty_generate(response.request.headers)}" 
-    puts "  PAYLOAD:\n#{@request_body}" if @request_body
-    puts "RESPONSE: #{response.code}"
-    puts "  HEADERS:\n#{JSON::pretty_generate(response.headers)}"
-    if response.request.method.downcase != 'head'
-      if is_json?(response.headers)
-        puts "  JSON_BODY\n#{JSON::pretty_generate(json_body)}" 
-      else
-        puts "  BODY\n#{response.body}"
-      end
-    end
+    puts request_info
     raise e
   end
 end
 
+# monkeypatch Airborne
 module Airborne
   def json_body
     @json_body ||= JSON.parse(response.body, symbolize_names: true)
-  rescue 
-    fail InvalidJsonError, 'Api request returned invalid json'
+  rescue StandardError
+    raise InvalidJsonError, 'Api request returned invalid json'
   end
+
+  # spaceborne enhancements
   module RestClientRequester
-    def make_request(method, url, options = {})
-      @json_body = nil
-      @request_body = nil
-      if options[:headers] && options[:headers].has_key?(:use_proxy)
-        proxy_option = options[:headers][:use_proxy]
-        RestClient.proxy = proxy_option
+    def body?(method)
+      case method
+      when :post, :patch, :put
+        true
+      else
+        false
       end
+    end
+
+    def split_options(options)
+      local = {}
+      local[:nonjson_data] = options.dig(:headers, :nonjson_data)
+      options[:headers].delete(:nonjson_data) if local[:nonjson_data]
+      local[:is_hash] = options[:body].is_a?(Hash)
+      local[:proxy] = options.dig(:headers, :use_proxy)
+      local
+    end
+
+    def calc_headers(options, local)
       headers = base_headers.merge(options[:headers] || {})
-      res = if method == :post || method == :patch || method == :put
-        begin
-          @request_body = options[:body].nil? ? '' : options[:body]
-          if options[:body].is_a?(Hash)
-            if headers.delete(:nonjson_data)
-              headers.delete('Content-Type')
-            else
-              headers.merge!(no_restclient_headers: true)
-              @request_body = @request_body.to_json
-            end
-          end
-          RestClient.send(method, get_url(url), @request_body, headers)
-        rescue RestClient::Exception => e
-          e.response
-        end
+      return headers unless local[:is_hash]
+      if options[:nonjson_data]
+        headers.delete('Content-Type')
       else
-        begin
-          RestClient.send(method, get_url(url), headers)
-        rescue RestClient::Exception => e
-          e.response
-        end
+        headers[:no_restclient_headers] = true
+      end
+      headers
+    end
+
+    def handle_proxy(options, local)
+      return unless local[:proxy]
+      RestClient.proxy = local[:proxy]
+      options[:headers].delete(:use_proxy)
+    end
+
+    def calc_body(options, local)
+      return '' unless options[:body]
+      if local[:nonjson_data] || !local[:is_hash]
+        options[:body]
+      else
+        options[:body].to_json
+      end
+    end
+
+    def send_restclient(method, url, body, headers)
+      if body?(method)
+        RestClient.send(method, url, body, headers)
+      else
+        RestClient.send(method, url, headers)
       end
-      res
+    end
+
+    def make_request(method, url, options = {})
+      local_options = split_options(options)
+      handle_proxy(options, local_options)
+      hdrs = calc_headers(options, local_options)
+      send_restclient(method, get_url(url),
+                      calc_body(options, local_options), hdrs)
+    rescue RestClient::Exception => e
+      e.response
     end
 
     private
+
     def base_headers
       { content_type: :json }.merge(Airborne.configuration.headers || {})
     end
   end
 
+  # Extend airborne's expectations
   module RequestExpectations
     def call_with_relative_path(data, args)
       if args.length == 2
@@ -111,17 +171,14 @@ module Airborne
     end
   end
 
+  # extension to handle hash value checking
   module PathMatcher
     def get_by_path(path, json, &block)
-      fail PathError, "Invalid Path, contains '..'" if /\.\./ =~ path
+      raise PathError, "Invalid Path, contains '..'" if /\.\./ =~ path
       type = false
-      if path.class == Symbol
-        parts = path.to_s.split('.')
-      else
-        parts = path.split('.')
-      end
+      parts = path.to_s.split('.')
       parts.each_with_index do |part, index|
-        if part == '*' || part == '?'
+        if %w[* ?].include?(part)
           ensure_array_or_hash(path, json)
           type = part
           if index < parts.length.pred
@@ -131,8 +188,9 @@ module Airborne
         end
         begin
           json = process_json(part, json)
-        rescue
-          raise PathError, "Expected #{json.class}\nto be an object with property #{part}"
+        rescue StandardError
+          raise PathError,
+                "Expected #{json.class}\nto be an object with property #{part}"
         end
       end
       if type == '*'
@@ -140,7 +198,7 @@ module Airborne
         when 'Array'
           expect_all(json, &block)
         when 'Hash'
-          json.each do |k,v|
+          json.each do |k, _v|
             yield json[k]
           end
         end
@@ -152,8 +210,10 @@ module Airborne
     end
 
     def ensure_array_or_hash(path, json)
-      fail RSpec::Expectations::ExpectationNotMetError, "Expected #{path} to be array or hash, got #{json.class} from JSON response" unless
-        json.class == Array || json.class == Hash
+      return if json.class == Array || json.class == Hash
+      raise RSpec::Expectations::ExpectationNotMetError,
+            "Expected #{path} to be array or hash, got #{json.class}"\
+            ' from JSON response'
     end
   end
 end

data/lib/spaceborne/version.rb

@@ -1,3 +1,3 @@
 module Spaceborne
-  VERSION = "0.1.12"
+  VERSION = '0.1.13'.freeze
 end

data/spaceborne.gemspec

@@ -1,34 +1,35 @@
-# coding: utf-8
-lib = File.expand_path('../lib', __FILE__)
+lib = File.expand_path('lib', __dir__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'spaceborne/version'
 
 Gem::Specification.new do |spec|
-  spec.name          = "spaceborne"
+  spec.name          = 'spaceborne'
   spec.version       = Spaceborne::VERSION
-  spec.authors       = ["Keith Williams"]
-  spec.email         = ["keithrw@comcast.net"]
+  spec.authors       = ['Keith Williams']
+  spec.email         = ['keithrw@comcast.net']
 
   spec.summary       = 'Gem supporting API testing'
   spec.description   = 'Extends brooklynDev/airborne'
-  spec.homepage      = "https://github.com/keithrw54/spaceborne.git"
-  spec.license       = "MIT"
+  spec.homepage      = 'https://github.com/keithrw54/spaceborne.git'
+  spec.license       = 'MIT'
 
-  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
-  spec.bindir        = "exe"
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = 'exe'
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
-  spec.require_paths = ["lib"]
+  spec.require_paths = ['lib']
 
-  spec.add_runtime_dependency 'rspec', '~> 3.1'
-  spec.add_runtime_dependency 'rest-client', '< 3.0', '>= 1.7.3'
-  spec.add_runtime_dependency 'rack-test', '~> 0.6', '>= 0.6.2'
-  spec.add_runtime_dependency 'rack'
   spec.add_runtime_dependency 'activesupport'
-  spec.add_runtime_dependency "airborne", "~> 0.2.13"
-  spec.add_runtime_dependency "curlyrest", "~> 0.1.0"
+  spec.add_runtime_dependency 'airborne', '~> 0.2.13'
+  spec.add_runtime_dependency 'curlyrest', '~> 0.1.0'
+  spec.add_runtime_dependency 'rack'
+  spec.add_runtime_dependency 'rack-test', '~> 0.6', '>= 0.6.2'
+  spec.add_runtime_dependency 'rest-client', '< 3.0', '>= 1.7.3'
+  spec.add_runtime_dependency 'rspec', '~> 3.1'
   spec.add_development_dependency 'webmock', '~> 0'
 
-  spec.add_development_dependency "bundler", "~> 1.11"
-  spec.add_development_dependency "rake", "~> 10.0"
-  spec.add_development_dependency "byebug", "~> 2.0"
+  spec.add_development_dependency 'bundler', '~> 1.11'
+  spec.add_development_dependency 'byebug', '~> 2.0'
+  spec.add_development_dependency 'rake', '~> 10.0'
 end

metadata

@@ -1,69 +1,57 @@
 --- !ruby/object:Gem::Specification
 name: spaceborne
 version: !ruby/object:Gem::Version
-  version: 0.1.12
+  version: 0.1.13
 platform: ruby
 authors:
 - Keith Williams
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-07-13 00:00:00.000000000 Z
+date: 2018-08-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: rspec
+  name: activesupport
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '3.1'
+        version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '3.1'
+        version: '0'
 - !ruby/object:Gem::Dependency
-  name: rest-client
+  name: airborne
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "<"
-      - !ruby/object:Gem::Version
-        version: '3.0'
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.7.3
+        version: 0.2.13
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "<"
-      - !ruby/object:Gem::Version
-        version: '3.0'
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.7.3
+        version: 0.2.13
 - !ruby/object:Gem::Dependency
-  name: rack-test
+  name: curlyrest
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.6'
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 0.6.2
+        version: 0.1.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.6'
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 0.6.2
+        version: 0.1.0
 - !ruby/object:Gem::Dependency
   name: rack
   requirement: !ruby/object:Gem::Requirement
@@ -79,47 +67,59 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: activesupport
+  name: rack-test
   requirement: !ruby/object:Gem::Requirement
     requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.6'
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.6.2
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.6'
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.6.2
 - !ruby/object:Gem::Dependency
-  name: airborne
+  name: rest-client
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - "<"
       - !ruby/object:Gem::Version
-        version: 0.2.13
+        version: '3.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.7.3
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - "<"
       - !ruby/object:Gem::Version
-        version: 0.2.13
+        version: '3.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.7.3
 - !ruby/object:Gem::Dependency
-  name: curlyrest
+  name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.1.0
+        version: '3.1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.1.0
+        version: '3.1'
 - !ruby/object:Gem::Dependency
   name: webmock
   requirement: !ruby/object:Gem::Requirement
@@ -149,33 +149,33 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '1.11'
 - !ruby/object:Gem::Dependency
-  name: rake
+  name: byebug
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '2.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '2.0'
 - !ruby/object:Gem::Dependency
-  name: byebug
+  name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.0'
+        version: '10.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.0'
+        version: '10.0'
 description: Extends brooklynDev/airborne
 email:
 - keithrw@comcast.net
@@ -185,6 +185,9 @@ extra_rdoc_files: []
 files:
 - ".gitignore"
 - ".rspec"
+- ".rubocop.yml"
+- ".ruby-gemset"
+- ".ruby-version"
 - Gemfile
 - LICENSE.txt
 - README.md