rest_baby 1.5.1 → 1.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e7a7dbc26025a16d879f2c517c25da5736c27b00
-  data.tar.gz: b4bbfee0238e016145ada7b68c446b5d88970282
+  metadata.gz: 6b7b7443ba8576c50f5da518edd296251f8208c4
+  data.tar.gz: d9fdfd2befbe02da53f6006e1bf0750cad64b1ca
 SHA512:
-  metadata.gz: 665c935a620d22995ba343015ae26a723b310f7f1b0dd3abeb51395972b170329dd144bec4ba5a7c40c5edcacc56b60b7709c4cc2844f18497d8458066d18bd3
-  data.tar.gz: bc3398cc32639c2e3c2e15f338546e430b42ac560f8f37c3a741c14d2e0b02a16725278df7644886664272347a5410e3ed978788bb396bb2730a4be458be4ba3
+  metadata.gz: 39ad7b000365d9faf3baaa84e9bc009af229b537bc51c0289a0ece75457daa9283afaa3f9a681f02537892c9ee5b062f12b04b2e61c38efa8e15ec88a5f15f07
+  data.tar.gz: b22c1f8da9daa64e11a4ad7dc98ec35545cd1aa019366fdbfc9e14817f07a3ceffb1aba0308a7f9ae993eb9d33d7dd41c046895dfea3474db1c55a1068c21649

data/.codeclimate.yml

@@ -1,6 +1,44 @@
 engines:
   rubocop:
     enabled: true
+    # Configuration parameters: AllowURI, URISchemes.
+    Metrics/LineLength:
+      Max: 81
+
+    # Configuration parameters: CountComments.
+    Metrics/MethodLength:
+      Max: 14
+
+    # Configuration parameters: CountKeywordArgs.
+    Metrics/ParameterLists:
+      Max: 6
+  reek:
+    enabled: true
+    UtilityFunction:
+      exclude:
+      - RestBaby::Client#header_text
+      - RestBaby::Client#pretty_xml
+    ControlParameter:
+      exclude:
+      - RestBaby::Client#body_text
+    DuplicateMethodCall:
+      exclude:
+      - RestBaby::Client#print_request
+    DataClump:
+      exclude:
+      - RestBaby::Client
+    FeatureEnvy:
+      exclude:
+      - RestBaby::Client#print_request
+    InstanceVariableAssumption:
+      exclude:
+      - RestBaby::Client
+    TooManyInstanceVariables:
+      exclude:
+      - RestBaby::Client
+    TooManyStatements:
+      exclude:
+      - RestBaby::Client#send_request
 ratings:
   paths:
   - lib/**
@@ -8,3 +46,4 @@ ratings:
 exclude_paths:
   - doc/**/*
   - features/**/*
+  

data/.gitignore

@@ -0,0 +1,3 @@
+Gemfile.lock
+coverage
+features_*.html

data/.travis.yml

@@ -1,6 +1,56 @@
 language: ruby
 rvm:
   - 2.0.0
-  - 2.1.0
-  - 2.2.0
-  - jruby-19mode # JRuby in 1.9 mode
+  - 2.1.10
+  - 2.2.5
+  - 2.3.1
+  - ruby-head
+  - jruby-19mode
+  - jruby-head
+jdk:
+  - openjdk6
+  - openjdk7
+  - oraclejdk7
+  - oraclejdk8
+matrix:
+  allow_failures:
+    - rvm: jruby-19mode
+    - rvm: ruby-head
+    - rvm: jruby-head
+  exclude:
+    - rvm: 2.0.0
+      jdk: openjdk6
+    - rvm: 2.0.0
+      jdk: openjdk7
+    - rvm: 2.0.0
+      jdk: oraclejdk7
+    - rvm: 2.1.10
+      jdk: openjdk6
+    - rvm: 2.1.10
+      jdk: openjdk7
+    - rvm: 2.1.10
+      jdk: oraclejdk7
+    - rvm: 2.2.5
+      jdk: openjdk6
+    - rvm: 2.2.5
+      jdk: openjdk7
+    - rvm: 2.2.5
+      jdk: oraclejdk7
+    - rvm: 2.3.1
+      jdk: openjdk6
+    - rvm: 2.3.1
+      jdk: openjdk7
+    - rvm: 2.3.1
+      jdk: oraclejdk7
+    - rvm: rbx-2
+      jdk: openjdk6
+    - rvm: rbx-2
+      jdk: openjdk7
+    - rvm: rbx-2
+      jdk: oraclejdk7
+    - rvm: ruby-head
+      jdk: openjdk6
+    - rvm: ruby-head
+      jdk: openjdk7
+    - rvm: ruby-head
+      jdk: oraclejdk7

data/ChangeLog

@@ -54,4 +54,9 @@
 === Version 1.5.1 / 2016-03-08
 * Updated README.md
 * Added more config files to provide better status feedback
-
+=== Version 1.6 / 2016-10-18
+* Updated supported versions list (removed 1.9 versions, rbx-2)
+* Updated travis to test latest released versions of 2.0-2.3
+* Updated README.md
+* Updated reek ignore list
+* Added "demo" mode profile to cucumber.yml

data/Gemfile

@@ -1,23 +1,19 @@
 source 'https://rubygems.org'
 
-gem 'json'
-gem 'nokogiri'
+gemspec
 
+version = RUBY_VERSION[0..2].split('.')[0..1].join('.').to_f
 group :development do
-  gem 'bundler'
-  gem 'rake'
-  gem 'cucumber'
-  gem 'fig_newton'
-  gem 'rspec'
-  gem 'webmock'
-  gem 'coveralls'
-  gem 'simplecov'
   gem 'rubocop'
-  if ENV['JRUBY'] || RUBY_PLATFORM == 'java'
-    # Skip the yard gems for jruby
-  else
+  if version > 2.0
+    gem 'reek'
+  end
+end
+
+group :documentation do
+  if not(ENV['JRUBY'] || RUBY_PLATFORM == 'java')
     gem 'yard'
-    gem 'yard-cucumber'
+    gem 'yard-cucumber', git: 'https://github.com/burtlo/yard-cucumber'
     gem 'redcarpet'
   end
 end

data/README.md

@@ -1,15 +1,16 @@
 # rest_baby
 
-Small rest client, supports ruby-2.0.0, ruby-2.1.0, ruby-2.2.0, jruby (based 1.9). You can only updated docs in ruby, not jruby.
+Small rest client, supports ruby-2.0.0, ruby-2.1.0, and ruby-2.2.0. You can only run reek with ruby 2.1 or above. You *could* use jruby but some develop dependencies are not supported any longer, including coveralls and yard-cucumber.
 
 Item | Status
 --- | ---
 Gem | [![Gem Version](https://badge.fury.io/rb/rest_baby.svg)](https://badge.fury.io/rb/rest_baby )
 Dependencies | [![Dependency Status](https://gemnasium.com/dmcnulla/rest_baby.svg)](https://gemnasium.com/dmcnulla/rest_baby)
-Build | [![Build Status](https://travis-ci.org/dmcnulla/rest_baby.svg?branch=master)](https://travis-ci.org/dmcnulla/rest_baby)
+Build/Test | [![Build Status](https://travis-ci.org/dmcnulla/rest_baby.svg?branch=master)](https://travis-ci.org/dmcnulla/rest_baby)
 Coverage | [![Coverage Status](https://coveralls.io/repos/dmcnulla/rest_baby/badge.svg?branch=v1_5&service=github)](https://coveralls.io/github/dmcnulla/rest_baby?branch=v1_5)
 Code Analysis | [![Code Climate](https://codeclimate.com/github/dmcnulla/rest_baby/badges/gpa.svg)](https://codeclimate.com/github/dmcnulla/rest_baby)
 Docs | [![Inline docs](http://inch-ci.org/github/dmcnulla/rest_baby.svg?branch=master)](http://inch-ci.org/github/dmcnulla/rest_baby)
+codeship | [ ![Codeship Status for dmcnulla/rest_baby](https://codeship.com/projects/6002d4e0-efc4-0133-4e00-7aa0b68b0e4b/status?branch=master)](https://codeship.com/projects/149095)
 
 ## Purpose
 
@@ -35,18 +36,18 @@ Or install it yourself as:
 client = RestBaby::Client.new('http://gis.srh.noaa.gov/arcgis/rest/services/System')
 # get(HEADERS, PATH, PARAMETERS)
 # returns http response, usually the body is what is wanted.
-message = JSON.parse(client.get( { 'Accept' => 'application/json' }, 
-                                   '/ReportingTools/GPServer/info/iteminfo', 
+message = JSON.parse(client.get( { 'Accept' => 'application/json' },
+                                   '/ReportingTools/GPServer/info/iteminfo',
                                    {'f' => 'pjson'}).body)
 
 client = RestBaby::Client.new('http://127.0.0.1:9001')
 # post(BODY, HEADERS, PATH)
-message = JSON.parse(client.post('{ "name": "Ben Franklin" }', 
-                                { 'Content-Type' => 'application/json' }, 
+message = JSON.parse(client.post('{ "name": "Ben Franklin" }',
+                                { 'Content-Type' => 'application/json' },
                                 '/person').body)
-# or 
-message = JSON.parse(client.post({ "name" => "Ben Franklin" }.to_json, 
-                                 { 'Content-Type' => 'application/json' }, 
+# or
+message = JSON.parse(client.post({ "name" => "Ben Franklin" }.to_json,
+                                 { 'Content-Type' => 'application/json' },
                                  '/person').body)
 ```
 

data/Rakefile

@@ -3,27 +3,56 @@ require 'rubygems'
 require 'cucumber'
 require 'cucumber/rake/task'
 require 'coveralls/rake/task'
+require 'rubocop/rake_task'
 
-if ENV['JRUBY'] || RUBY_PLATFORM == 'java'
-  # Skip the yard gems for jruby
-else
-  require 'yard'
-  # rake yard
-  YARD::Rake::YardocTask.new do |t|
-    t.files = ['lib/**/*.rb', 'features/**/*.feature', 'features/**/*.rb']
+version = RUBY_VERSION[0..2].split('.')[0..1].join('.').to_f
+
+desc 'Run lint check RuboCop'
+task :rubocop do
+  RuboCop::RakeTask.new do |t|
+    t.formatters = %w(files offenses)
+    t.options = [['--config', '.rubocop.yml']]
+    t.fail_on_error = true
   end
 end
 
+desc 'Test'
 Cucumber::Rake::Task.new(:features) do |t|
   t.profile = 'default'
 end
 
+desc 'Check test coverage'
 Coveralls::RakeTask.new
 
-task default: [:features, 'coveralls:push']
-
 task :clean do
   `rm -rf doc`
   `rm -rf .yardoc`
   `git checkout doc`
 end
+
+if ENV['JRUBY'] || RUBY_PLATFORM == 'java' || version < 2.1
+  task default: [:features, 'coveralls:push', :rubocop]
+
+elsif version > 2.0
+  desc 'Run lint check Reek'
+  require 'reek/rake/task'
+  Reek::Rake::Task.new(:lint) do |t|
+    t.name          = 'reek'
+    t.config_file   = 'config/config.reek'
+    t.source_files  = 'lib/**/*.rb'
+    t.reek_opts     = '-U'
+    t.fail_on_error = true
+    t.verbose       = true
+  end
+
+  task default: [:features, 'coveralls:push', :rubocop, :reek]
+else
+  desc 'Documentation'
+  require 'yard'
+  YARD::Rake::YardocTask.new do |t|
+    t.files = ['lib/**/*.rb', 'features/**/*.feature', 'features/**/*.rb']
+  end
+
+  # regular ruby default rake task
+  task default: [:features, 'coveralls:push', :rubocop, :reek]
+end

data/config/config.reek

@@ -0,0 +1,30 @@
+exclude_paths:
+  - coverage
+  - doc
+  - features
+  - pkg
+UtilityFunction:
+  exclude:
+  - RestBaby::Client#header_text
+  - RestBaby::Client#pretty_xml
+ControlParameter:
+  exclude:
+  - RestBaby::Client#body_text
+DuplicateMethodCall:
+  exclude:
+  - RestBaby::Client#print_request
+DataClump:
+  exclude:
+  - RestBaby::Client
+FeatureEnvy:
+  exclude:
+  - RestBaby::Client#print_request
+InstanceVariableAssumption:
+  exclude:
+  - RestBaby::Client
+TooManyInstanceVariables:
+  exclude:
+  - RestBaby::Client
+TooManyStatements:
+  exclude:
+  - RestBaby::Client#send_request

data/cucumber.yml

@@ -1,4 +1,5 @@
 default: FIG_NEWTON_FILE=mock.yml DEBUG_HTTP=true --tags ~@wip --no-source --color --format pretty
 debug: FIG_NEWTON_FILE=mock.yml DEBUG_HTTP=true --no-source --color --format pretty
+demo: FIG_NEWTON_FILE=mock.yml DEBUG_HTTP=false --tags ~@wip --no-source --color --format pretty
 report: FIG_NEWTON_FILE=mock.yml DEBUG_HTTP=false  --no-source --color --format progress --format html --out='features_<%= Time.new.strftime('%Y-%m-%d_%H_%M_%S') %>.html'
 wip: FIG_NEWTON_FILE=mock.yml DEBUG_HTTP=true --tags @wip --color --format pretty

data/features/nil_body.feature

@@ -0,0 +1,20 @@
+@nil
+Feature: Create a basic rest client that can get, put, post, and delete
+
+@core @put @nil
+@nil.S1
+Scenario: client rest PUT
+  Given I have a web service
+  And I have "PUT" service for "/nil" that requires no body
+  And I am a rest client
+  When I "PUT" to the web service with no body
+  Then I receive the no message
+
+@core @post @nil
+@nil.S2
+Scenario: client rest POST
+  Given I have a web service
+  And I have "POST" service for "/nil" that requires no body
+  And I am a rest client
+  When I "POST" to the web service with no body
+  Then I receive the no message

data/features/step_definitions/rest_client_steps.rb

@@ -24,6 +24,13 @@ Given(/^I have "(GET|PUT|POST|DELETE)" service for "([^"]*)"$/) do |type, path|
   end
 end
 
+Given(/^I have "(PUT|POST)" service for "([^"]*)" that requires no body$/) do |type, path|
+  @path = path
+  @path = path
+  @mockservice.store_msg(type, path, nil,
+                         {}, nil, nil, nil)
+end
+
 Given(/^I have an xml service for "([^"]*)"$/) do |path|
   @path = path
   @mockservice.store_msg('POST', path, DEFAULT_XML,
@@ -83,6 +90,15 @@ do |type, message|
   end
 end
 
+When(/^I "(PUT|POST)" to the web service with no body$/) do |type|
+  case type.downcase
+  when 'put'
+    @response = @restbaby.put()
+  when 'post'
+    @response = @restbaby.post()
+  end
+end
+
 When(/^I "GET" from the web service with the parameters$/) do |table|
   @response = @restbaby.get({}, nil, table.rows_hash)
 end
@@ -105,3 +121,9 @@ Then(/^I receive the xml message$/) do
   expect(@response.code).to eq('200')
   expect(@response.body).to eq(DEFAULT_XML)
 end
+
+Then(/^I receive the no message$/) do
+  expect(@response.code).to eq('200')
+  expect(@response.body).to be_nil
+end
+

data/lib/rest_baby.rb

@@ -1,5 +1,5 @@
 # rest_baby.rb
-# @author Dave McNulla of ResMed
+# @author Dave McNulla
 # Originated: 2011
 # This library was written to simplify communications with rest services.
 
@@ -15,8 +15,8 @@ require 'rest_baby/version'
 module RestBaby
   # Sends and receives data to a restful web service
   class Client
-    PARAM_STARTER = '?'
-    PARAM_SEPARATOR = '&'
+    PARAM_STARTER = '?'.freeze
+    PARAM_SEPARATOR = '&'.freeze
 
     # The WebService Response from the last call
     attr_reader :wsresponse
@@ -84,7 +84,7 @@ module RestBaby
     def post(body = nil, headers = {}, path = '')
       uri = URI.parse("#{@url}#{path}")
       request = Net::HTTP::Post.new(uri.request_uri)
-      request.body = body unless body.nil?
+      request.body = body
       send_request(uri, request, headers)
     end
 
@@ -112,7 +112,7 @@ module RestBaby
     def put(body = nil, headers = {}, path = '')
       uri = URI.parse("#{@url}#{path}")
       request = Net::HTTP::Put.new(uri.request_uri)
-      request.body = body unless body.nil?
+      request.body = body
       send_request(uri, request, headers)
     end
 
@@ -120,7 +120,7 @@ module RestBaby
 
     def send_request(uri, request, headers)
       @headers.merge(headers).each { |key, value| request[key] = value }
-      request.basic_auth(@user, @password) unless @user.nil?
+      request.basic_auth(@user, @password)
       http = Net::HTTP.new(uri.host, uri.port)
       http.use_ssl = true if uri.scheme == 'https'
       print_request(request, uri)
@@ -131,7 +131,7 @@ module RestBaby
 
     def print_request(request, uri)
       return nil unless @verbose
-      query = ((uri.query == '') ? '' : "?#{uri.query}")
+      query = uri.query == '' ? '' : "?#{uri.query}"
       puts ">> REQUEST\n"\
         ">  URL: #{uri.scheme}://#{uri.host}:#{uri.port}#{uri.path}#{query}\n"\
         ">  Headers:\n"\
@@ -157,7 +157,7 @@ module RestBaby
     end
 
     def body_text(type, response_body)
-      return '[Empty]' if response_body.nil?
+      response_body ||= '[Empty]'
       case type
       when 'application/json'
         pretty_json(response_body)

data/lib/rest_baby/version.rb

@@ -1,4 +1,4 @@
 # Identify the version
 module RestBaby
-  VERSION = '1.5.1'
+  VERSION = '1.6.0'.freeze
 end

data/rest_baby.gemspec

@@ -4,6 +4,9 @@ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'rest_baby/version'
 
 Gem::Specification.new do |spec|
+  spec.required_ruby_version = '>= 2.0.0'
+  spec.required_rubygems_version = '>= 1.6.0'
+
   spec.name          = 'rest_baby'
   spec.version       = RestBaby::VERSION
   spec.authors       = ['Dave McNulla']
@@ -14,21 +17,18 @@ Gem::Specification.new do |spec|
   spec.license       = 'MIT'
 
   spec.files         = `git ls-files`.split($INPUT_RECORD_SEPARATOR)
-  spec.executables   = spec.files.grep(/^bin/) { |f| File.basename(f) }
-  spec.test_files    = spec.files.grep(/^(test|spec|features)/)
+  spec.test_files    = spec.files.grep(/^(features)/)
   spec.require_paths = ['lib']
 
   spec.add_dependency 'nokogiri', '~> 1.6'
   spec.add_dependency 'json', '~> 1.8', '>= 1.8.0'
+
   spec.add_development_dependency 'bundler', '~> 1.3'
   spec.add_development_dependency 'rake', '~> 0'
   spec.add_development_dependency 'cucumber', '~> 2.1', '>= 2.1.0'
   spec.add_development_dependency 'fig_newton', '~> 0.9'
   spec.add_development_dependency 'rspec', '~> 2.14', '>= 2.14.1'
   spec.add_development_dependency 'webmock', '~> 1.13', '>= 1.13.0'
-  spec.add_development_dependency 'yard', '~> 0.8', '>= 0.8.7.6'
-  spec.add_development_dependency 'yard-cucumber', '~> 2.3', '>= 2.3.2'
-  spec.add_development_dependency 'redcarpet', '~> 3.3', '>= 3.3.0'
   spec.add_development_dependency 'coveralls', '~> 0.7'
   spec.add_development_dependency 'simplecov', '~> 0.11'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rest_baby
 version: !ruby/object:Gem::Version
-  version: 1.5.1
+  version: 1.6.0
 platform: ruby
 authors:
 - Dave McNulla
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-03-09 00:00:00.000000000 Z
+date: 2016-10-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: nokogiri
@@ -146,66 +146,6 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 1.13.0
-- !ruby/object:Gem::Dependency
-  name: yard
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.8'
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 0.8.7.6
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.8'
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 0.8.7.6
-- !ruby/object:Gem::Dependency
-  name: yard-cucumber
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '2.3'
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 2.3.2
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '2.3'
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 2.3.2
-- !ruby/object:Gem::Dependency
-  name: redcarpet
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.3'
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 3.3.0
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.3'
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 3.3.0
 - !ruby/object:Gem::Dependency
   name: coveralls
   requirement: !ruby/object:Gem::Requirement
@@ -243,6 +183,7 @@ extra_rdoc_files: []
 files:
 - ".codeclimate.yml"
 - ".coveralls.yml"
+- ".gitignore"
 - ".rubocop.yml"
 - ".travis.yml"
 - ChangeLog
@@ -250,6 +191,7 @@ files:
 - LICENSE.txt
 - README.md
 - Rakefile
+- config/config.reek
 - config/environments/mock.yml
 - cucumber.yml
 - doc/MockRestService.html
@@ -309,6 +251,7 @@ files:
 - doc/tag_list.html
 - doc/top-level-namespace.html
 - features/header_options.feature
+- features/nil_body.feature
 - features/print_response.feature
 - features/rest_client.feature
 - features/step_definitions/header_steps.rb
@@ -333,20 +276,21 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 2.0.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.6.0
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.6
+rubygems_version: 2.5.1
 signing_key: 
 specification_version: 4
 summary: Small rest client developed to testing rest services.
 test_files:
 - features/header_options.feature
+- features/nil_body.feature
 - features/print_response.feature
 - features/rest_client.feature
 - features/step_definitions/header_steps.rb
@@ -356,4 +300,3 @@ test_files:
 - features/support/utility.rb
 - features/url_parameter.feature
 - features/xml_message.feature
-has_rdoc: