ruby-development-toolbox 1.3.2 → 1.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 910138d99d7862d7ce2725e50334afc5bbc51565
-  data.tar.gz: 6fe90a88dd79fb5e49ec65b9ffca2836eb3c811d
+  metadata.gz: 5617c949afadb92dd7a3acb8c5505e5eb02c8a52
+  data.tar.gz: 29d5d156a1733866e01b40000c3ea4516c4d31ea
 SHA512:
-  metadata.gz: c2a6894e4d066e35a9fb3963e2b8b03d9f00c7ed79da652f4e3090760d9165776dd39623263dd46619e1588bd823899a04c50214fd48aebdf1c6f1a8a53c2b32
-  data.tar.gz: f91363877803840ded559ef939f2d88298c1ce65e81ceaee7152796ed7c7206e64342f9ab13c2e2e7a0960297bf065410732e8cf0783a6f0091502bafb04008d
+  metadata.gz: 192122294fbc818dd832ad27cd653b17e723a076a1971bace2bccb520fbb9f70834415a3137bd2b53d67ed96b44468a8357282d32112291739d62f286bfddb0a
+  data.tar.gz: 8ddbed2b82ccea569b2373364e33010dae8d6c6732af39a6f68564e0d6fb6ef6b6118620360eed032e13bcab04ed95c3a7bd28c4caddb7266923f26b31e1800c

data/Gemfile

@@ -9,7 +9,10 @@ group :development do
   gem "shoulda", ">= 0"
   gem "rdoc", "~> 3.12"
   gem "bundler", "~> 1.0"
-  gem "jeweler", "~> 2.0.1"
+
+  gem "minitest", "~> 4.0"
+  gem "jeweler", "= 2.0.1"
+
   gem "simplecov", ">= 0"
   gem "yard", ">= 0.8.7.3"
 end

data/Gemfile.lock

@@ -76,7 +76,8 @@ PLATFORMS
 
 DEPENDENCIES
   bundler (~> 1.0)
-  jeweler (~> 2.0.1)
+  jeweler (= 2.0.1)
+  minitest (~> 4.0)
   rdoc (~> 3.12)
   shoulda
   simplecov

data/README.md

@@ -38,6 +38,66 @@ This is to support operations like the following:
 
 The projects homepage can be found [here](https://github.com/gradeawarrior/ruby-development-toolbox). You can also refer to the [Rubydoc YARD Server](http://rubydoc.info/github/gradeawarrior/ruby-development-toolbox/frames)
 
+In summary, the following modules are available currently in this gem:
+
+### 1. toolbox/array
+
+This is to implement equivalence check for arrays. In the context of arrays, we use =~ as a means of checking if array1 is contained in array2; or if object is contained in array1
+  
+### 2. toolbox/boolean
+
+The main application of the Boolean module is to support reading boolean values from a String (e.g. while reading a configuration value) and having the ability to convert it back to a boolean true/false for easier evaluation in your Ruby code
+
+### 3. toolbox/gem_specification
+
+Extends the functionality of a Gem::Specification to be able to retrieve the latest version of gems currently on your system.
+
+### 4. toolbox/hash_diff
+
+Extends the functionality of a Hash to be able to perform (i) diff and (ii) similarity operations. For implementation details, see the Hash class for the extended functions
+
+### 5. toolbox/http
+
+A simple testing client based on the Perl version found in: [QA-Perl-Lib.git](https://github.com/gradeawarrior/QA-Perl-Lib/blob/master/QA/Test/WebService.pm)
+  
+An example usage would be the following:
+
+       require 'toolbox/http'
+  
+       response = Toolbox::Http.request(:method => 'GET', :url => 'http://www.google.com')
+       if response.code == 200.to_s
+         puts "Yay! It worked!"
+       else
+         puts "Boo! Something broke!" unless response.code == 200.to_s
+       end
+
+### 6. toolbox/integer
+
+Extends the functionality of String to support checking if a String can be converted to an Integer
+
+       require 'toolbox/integer'
+       
+       ['-1', '0', '1', '1.0', 'one', '1 too many'].each do |test|
+         puts "This can be converted to an Integer" if test.is_i?
+         puts "This cannot be converted to an Integer" unless test.is_i?
+       end
+
+### 7. toolbox/json
+
+Extends the functionality of String to support pretty_printing json. This is really a natural extension of the basic String type to support JSON.pretty_generate(string).
+
+### 8. toolbox/uuid
+
+A generic UUID class:
+
+		$ irb
+		     require 'toolbox/uuid'
+		       => true
+		     UUID.generate
+		       => "0a391631-22ba-40ea-af2e-65a64de4a42b"
+		     UUID.generate
+		       => "092516ba-a2f4-45cf-9e1d-c5e63342aaa4"
+
 # Development
 
 The project is built by [jeweler](https://github.com/technicalpickles/jeweler). See the project's page for more details about how to manage this gem. However, I will list out quick guidance on a typical release.

data/Rakefile

@@ -2,6 +2,9 @@
 
 require 'rubygems'
 require 'bundler'
+require 'rake'
+require 'jeweler'
+
 begin
   Bundler.setup(:default, :development)
 rescue Bundler::BundlerError => e
@@ -9,9 +12,7 @@ rescue Bundler::BundlerError => e
   $stderr.puts "Run `bundle install` to install missing gems"
   exit e.status_code
 end
-require 'rake'
 
-require 'jeweler'
 Jeweler::Tasks.new do |gem|
   # gem is a Gem::Specification... see http://guides.rubygems.org/specification-reference/ for more options
   gem.name = "ruby-development-toolbox"

data/VERSION

@@ -1 +1 @@
-1.3.2
+1.4.0

data/lib/toolbox/array.rb

@@ -23,17 +23,17 @@ module Toolbox
   # we use =~ as a means of checking if array1 is contained in array2; or if
   # object is contained in array1
   #
-  #   sample_array = [1, 2, 3]
-  #   puts sample_array =~ 3    ## This prints true
-  #   puts sample_array =~ 4    ## This prints false
+  #     sample_array = [1, 2, 3]
+  #     puts sample_array =~ 3    ## This prints true
+  #     puts sample_array =~ 4    ## This prints false
   #
   # The other way is the following:
   #
-  #   sample_array1 = [1, 2, 3]
-  #   sample_array2 = [1, 2, 3, 4]
-  #
-  #   puts sample_array2 =~ sample_array1   ## This prints true, because everything in array1 is in array2
-  #   puts sample_array1 =~ sample_array2   ## This prints false, because not everything in array2 is in array1
+  #     sample_array1 = [1, 2, 3]
+  #     sample_array2 = [1, 2, 3, 4]
+  #     
+  #     puts sample_array2 =~ sample_array1   ## This prints true, because everything in array1 is in array2
+  #     puts sample_array1 =~ sample_array2   ## This prints false, because not everything in array2 is in array1
   #
   module Array
   end

data/lib/toolbox/http.rb

@@ -0,0 +1,208 @@
+require 'net/http'
+require 'toolbox/boolean'
+require 'toolbox/json'
+require 'uri'
+
+begin
+  $SSL_AVAILABLE = true
+  require 'net/https'
+rescue Exception
+  $SSL_AVAILABLE = false
+end
+
+module Toolbox
+
+  ##
+  # A simple testing client based on the Perl version found in:
+  #
+  #     https://github.com/gradeawarrior/QA-Perl-Lib/blob/master/QA/Test/WebService.pm
+  #
+  # An example usage would be the following:
+  #
+  #     require 'toolbox/http'
+  #
+  #     response = Toolbox::Http.request(:method => 'GET', :url => 'http://www.google.com')
+  #     if response.code == 200.to_s
+  #       puts "Yay! It worked!"
+  #     else
+  #       puts "Boo! Something broke!" unless response.code == 200.to_s
+  #     end
+  #
+  class Http
+
+    ##
+    # Generate and display curl request
+    #
+    # == Parameters
+    #     uri           : The URI you are performing the request on
+    #     request       : The Net::HTTP Request object
+    #
+    # == Returns
+    #     curl_request    : String representing the curl request
+    #
+    def self.generate_curl_request(uri, request)
+      curl_request_str = "curl -v -X #{request.method} \"#{uri.scheme}://#{uri.host}:#{uri.port}#{request.path}\""
+
+      # Generate headers
+      request.each_header do |name, value|
+        curl_request_str += " -H '#{name}: #{value}'" if (name !~ /user-agent/i && name !~ /accept/i)
+      end
+
+      curl_request_str += " -k" if (uri.scheme.to_s == "https")
+      curl_request_str += " -d 'YOUR_REQUEST_BODY'" if state.nil? && state.get(:curl_file).nil?
+      curl_request_str += " -d @#{state.get(:curl_file)}" if !state.nil? && !state.get(:curl_file).nil?
+      curl_request_str
+    end
+
+    ##
+    # Show details about request
+    #
+    # == Parameters
+    #     uri                 : The URI you are performing the request on
+    #     request             : The Net::HTTP Request object
+    #     disable_print_body  : Disables printing body
+    #
+    def self.show_req(uri, request, disable_print_body=false)
+
+      ## Print verbose output from RESTest
+      puts "$ #{generate_curl_request(uri, request)}"
+      puts '---[ Request ]----------------------------------------------------'
+      puts "URI: #{uri.scheme}://#{uri.host}:#{uri.port}"
+      puts "#{request.method} #{request.path}"
+
+      request.each_header { |name, value| puts "#{name}: #{value}" }
+      if disable_print_body
+        puts "\n<!-- Disabled print body for Content-Type: #{request.content_type}-->\n"
+      else
+        puts "\n#{request.body}\n"
+      end
+      puts '------------------------------------------------------------------'
+
+    end
+
+    ##
+    # Show details about response received
+    #
+    # == Parameters
+    #     response            : The Net::HTTPResponse object
+    #     disable_print_body  : Disables printing body
+    #
+    def self.show_response(response, disable_print_body=false)
+
+      puts '---[ Response ]---------------------------------------------------'
+      if response
+        puts "#{response.code} #{response.message}"
+        if (response.code.to_i > 0)
+          response.each_header { |name, value| puts "#{name}: #{value}" }
+        end
+        if disable_print_body
+          puts "\n<!-- Disabled print body for Content-Type: #{request.content_type}-->\n"
+        else
+          puts "\n#{response.body}\n"
+        end
+      else
+        puts 'response object is nil!'
+      end
+      puts '------------------------------------------------------------------'
+
+    end
+
+    ##
+    # A simple testing client based on the Perl version found in:
+    #
+    #     https://github.com/gradeawarrior/QA-Perl-Lib/blob/master/QA/Test/WebService.pm
+    #
+    # == Parameters
+    #     :method                => (Required) Sets the request method to perform. The valid methods are GET, POST, PUT, & DELETE
+    #     :url                   => (Required) This should be set to the exact service API (e.g. 'http://www.google.com'). Port,
+    #                                          path, and query parameters should also be specified. NOTE: If you specified the
+    #                                          :request option, then the URI path and query parameters will be configured there.
+    #     :request               => (Optional) Default: nil - You can optionally setup your Net::HTTP::[Get|Post|Put|Delete]
+    #                                                         operation here. Other request could also be specified here if
+    #                                                         not supported via :method parameter.
+    #     :timeout               => (Optional) Default: 60 - This is the default request timeout
+    #     :basic_auth            => (Optional) Default: nil - This should be a hash containing 'user' and 'password' keys
+    #     :headers               => (Optional) Default: {} - A Hash containing all the Request headers that need to be set
+    #     :request_body          => (Optional) Default: nil - The request body for PUT and POST requests
+    #     :content_type          => (Optional) Default: nil - Sets the 'Content-Type' header
+    #     :debug                 => (Optional) Default: false - Enables debug output
+    #     :disable_print_body    => (Optional) Default: false - This will hide the request/response body output
+    #
+    # == Returns
+    #
+    # A Net::HTTPResponse object is returned. This is the standard object returned from Net::HTTP
+    #
+    # == Throws (Exceptions)
+    #
+    # Any of the standard Net::HTTP::Exceptions could be returned if there is an error connecting
+    # to the downstream server.
+    #
+    # Additionally, The method could return:
+    # - ArgumentError
+    # - URI parse error
+    #
+    def self.request(*args)
+
+      args = args.nil? || args.empty? ? {} : args.pop
+      args = {} unless args.is_a?(::Hash)
+      raise ArgumentError, 'method is required!' if args[:method].nil? && args[:request].nil?
+      raise ArgumentError, 'url is required!' if args[:url].nil?
+
+      ## Options and defaults
+      request = args[:request]
+      args[:method] = request.method if request
+      args[:timeout] = args[:timeout] ? args[:timeout] : 60
+      args[:headers] = args[:headers] ? args[:headers] : {}
+      args[:headers]['Content-Type'] = args[:content_type] if args[:content_type]
+      args[:debug] = args[:debug].nil? ? false : args[:debug].to_bool
+      args[:disable_print_body] = args[:disable_print_body].nil? ? false : args[:disable_print_body].to_bool
+
+      puts "Requesting: #{args[:method]} #{uri.to_s}" if args[:debug]
+
+      ## Set the request based on the URL
+      if args[:url]
+        uri = args[:url].is_a?(::URI) ? args[:url] : URI(args[:url])
+        request_path = "#{uri.path}#{uri.query || ''}"
+        request_path = request_path.empty? ? '/' : request_path
+
+        if args[:method]
+          request = case args[:method]
+                      when 'GET'
+                        Net::HTTP::Get.new(request_path, args[:headers])
+                      when 'POST'
+                        req = Net::HTTP::Post.new(request_path, args[:headers])
+                        req.body = args[:request_body] if args[:request_body]
+                        req
+                      when 'PUT'
+                        req = Net::HTTP::Put.new(request_path, args[:headers])
+                        req.body = args[:request_body] if args[:request_body]
+                        req
+                      when 'DELETE'
+                        Net::HTTP::Delete.new(request_path, args[:headers])
+                      else
+                        raise ArgumentError, "Invalid method #{args[:method]}!"
+                    end
+        end
+      end
+
+      ## Set Auth
+      req.basic_auth(args[:basic_auth]['user'], args[:basic_auth]['password']) if args[:basic_auth]
+
+      http = Net::HTTP.new(uri.host, uri.port)
+      http.read_timeout = args[:timeout]
+
+      if uri.scheme == 'https'
+        raise RuntimeError, 'SSL required but not available!' unless $SSL_AVAILABLE
+        http.use_ssl = true
+        http.verify_mode = OpenSSL::SSL::VERIFY_NONE
+      end
+
+      show_req(uri, request, state) if args[:debug]
+      response = http.request(request)
+      show_response(response) if args[:debug]
+      response
+
+    end
+
+  end
+end

data/ruby-development-toolbox.gemspec

@@ -2,16 +2,16 @@
 # DO NOT EDIT THIS FILE DIRECTLY
 # Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
 # -*- encoding: utf-8 -*-
-# stub: ruby-development-toolbox 1.3.2 ruby lib
+# stub: ruby-development-toolbox 1.4.0 ruby lib
 
 Gem::Specification.new do |s|
   s.name = "ruby-development-toolbox"
-  s.version = "1.3.2"
+  s.version = "1.4.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.require_paths = ["lib"]
   s.authors = ["Peter Salas"]
-  s.date = "2014-12-17"
+  s.date = "2015-02-04"
   s.description = "A collection of useful utilities and libraries for Ruby development (not Rails)"
   s.email = "psalas+github@gmail.com"
   s.extra_rdoc_files = [
@@ -33,6 +33,7 @@ Gem::Specification.new do |s|
     "lib/toolbox/boolean.rb",
     "lib/toolbox/gem_specification.rb",
     "lib/toolbox/hash_diff.rb",
+    "lib/toolbox/http.rb",
     "lib/toolbox/integer.rb",
     "lib/toolbox/json.rb",
     "lib/toolbox/uuid.rb",
@@ -42,11 +43,12 @@ Gem::Specification.new do |s|
     "test/representations/person.rb",
     "test/test_toolbox-integer.rb",
     "test/test_toolbox_array.rb",
+    "test/test_toolbox_http.rb",
     "test/test_toolbox_json.rb"
   ]
   s.homepage = "http://github.com/gradeawarrior/ruby-development-toolbox"
   s.licenses = ["MIT"]
-  s.rubygems_version = "2.2.2"
+  s.rubygems_version = "2.4.3"
   s.summary = "Useful Ruby Development Toolbox"
 
   if s.respond_to? :specification_version then
@@ -56,14 +58,16 @@ Gem::Specification.new do |s|
       s.add_development_dependency(%q<shoulda>, [">= 0"])
       s.add_development_dependency(%q<rdoc>, ["~> 3.12"])
       s.add_development_dependency(%q<bundler>, ["~> 1.0"])
-      s.add_development_dependency(%q<jeweler>, ["~> 2.0.1"])
+      s.add_development_dependency(%q<minitest>, ["~> 4.0"])
+      s.add_development_dependency(%q<jeweler>, ["= 2.0.1"])
       s.add_development_dependency(%q<simplecov>, [">= 0"])
       s.add_development_dependency(%q<yard>, [">= 0.8.7.3"])
     else
       s.add_dependency(%q<shoulda>, [">= 0"])
       s.add_dependency(%q<rdoc>, ["~> 3.12"])
       s.add_dependency(%q<bundler>, ["~> 1.0"])
-      s.add_dependency(%q<jeweler>, ["~> 2.0.1"])
+      s.add_dependency(%q<minitest>, ["~> 4.0"])
+      s.add_dependency(%q<jeweler>, ["= 2.0.1"])
       s.add_dependency(%q<simplecov>, [">= 0"])
       s.add_dependency(%q<yard>, [">= 0.8.7.3"])
     end
@@ -71,7 +75,8 @@ Gem::Specification.new do |s|
     s.add_dependency(%q<shoulda>, [">= 0"])
     s.add_dependency(%q<rdoc>, ["~> 3.12"])
     s.add_dependency(%q<bundler>, ["~> 1.0"])
-    s.add_dependency(%q<jeweler>, ["~> 2.0.1"])
+    s.add_dependency(%q<minitest>, ["~> 4.0"])
+    s.add_dependency(%q<jeweler>, ["= 2.0.1"])
     s.add_dependency(%q<simplecov>, [">= 0"])
     s.add_dependency(%q<yard>, [">= 0.8.7.3"])
   end

data/test/test_toolbox_http.rb

@@ -0,0 +1,18 @@
+require 'helper'
+require 'toolbox/http'
+require 'net/http'
+
+class TestToolboxHttp < Test::Unit::TestCase
+
+  should 'be able to make a simple request to google' do
+    response = Toolbox::Http.request(:method => 'GET', :url => 'http://www.google.com')
+    assert_equal(200.to_s, response.code)
+  end
+
+  should 'be able to make a simple request to google using Net::Http::Get Request' do
+    req = Net::HTTP::Get.new("/", {})
+    response = Toolbox::Http.request(:url => 'http://www.google.com', :request => req)
+    assert_equal(200.to_s, response.code)
+  end
+
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ruby-development-toolbox
 version: !ruby/object:Gem::Version
-  version: 1.3.2
+  version: 1.4.0
 platform: ruby
 authors:
 - Peter Salas
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-12-17 00:00:00.000000000 Z
+date: 2015-02-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: shoulda
@@ -53,17 +53,31 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '1.0'
 - !ruby/object:Gem::Dependency
-  name: jeweler
+  name: minitest
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 2.0.1
+        version: '4.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ~>
+      - !ruby/object:Gem::Version
+        version: '4.0'
+- !ruby/object:Gem::Dependency
+  name: jeweler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 2.0.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
       - !ruby/object:Gem::Version
         version: 2.0.1
 - !ruby/object:Gem::Dependency
@@ -117,6 +131,7 @@ files:
 - lib/toolbox/boolean.rb
 - lib/toolbox/gem_specification.rb
 - lib/toolbox/hash_diff.rb
+- lib/toolbox/http.rb
 - lib/toolbox/integer.rb
 - lib/toolbox/json.rb
 - lib/toolbox/uuid.rb
@@ -126,6 +141,7 @@ files:
 - test/representations/person.rb
 - test/test_toolbox-integer.rb
 - test/test_toolbox_array.rb
+- test/test_toolbox_http.rb
 - test/test_toolbox_json.rb
 homepage: http://github.com/gradeawarrior/ruby-development-toolbox
 licenses:
@@ -147,7 +163,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.2
+rubygems_version: 2.4.3
 signing_key: 
 specification_version: 4
 summary: Useful Ruby Development Toolbox