rest-man 1.0.0

data/lib/restman.rb

@@ -0,0 +1,183 @@
+require 'net/http'
+require 'openssl'
+require 'stringio'
+require 'uri'
+
+require File.dirname(__FILE__) + '/restman/version'
+require File.dirname(__FILE__) + '/restman/platform'
+require File.dirname(__FILE__) + '/restman/exceptions'
+require File.dirname(__FILE__) + '/restman/utils'
+require File.dirname(__FILE__) + '/restman/request'
+require File.dirname(__FILE__) + '/restman/abstract_response'
+require File.dirname(__FILE__) + '/restman/response'
+require File.dirname(__FILE__) + '/restman/raw_response'
+require File.dirname(__FILE__) + '/restman/resource'
+require File.dirname(__FILE__) + '/restman/params_array'
+require File.dirname(__FILE__) + '/restman/payload'
+require File.dirname(__FILE__) + '/restman/windows'
+
+# This module's static methods are the entry point for using the REST client.
+#
+#   # GET
+#   xml = RestMan.get 'http://example.com/resource'
+#   jpg = RestMan.get 'http://example.com/resource', :accept => 'image/jpg'
+#
+#   # authentication and SSL
+#   RestMan.get 'https://user:password@example.com/private/resource'
+#
+#   # POST or PUT with a hash sends parameters as a urlencoded form body
+#   RestMan.post 'http://example.com/resource', :param1 => 'one'
+#
+#   # nest hash parameters
+#   RestMan.post 'http://example.com/resource', :nested => { :param1 => 'one' }
+#
+#   # POST and PUT with raw payloads
+#   RestMan.post 'http://example.com/resource', 'the post body', :content_type => 'text/plain'
+#   RestMan.post 'http://example.com/resource.xml', xml_doc
+#   RestMan.put 'http://example.com/resource.pdf', File.read('my.pdf'), :content_type => 'application/pdf'
+#
+#   # DELETE
+#   RestMan.delete 'http://example.com/resource'
+#
+#   # retrieve the response http code and headers
+#   res = RestMan.get 'http://example.com/some.jpg'
+#   res.code                    # => 200
+#   res.headers[:content_type]  # => 'image/jpg'
+#
+#   # HEAD
+#   RestMan.head('http://example.com').headers
+#
+# To use with a proxy, just set RestMan.proxy to the proper http proxy:
+#
+#   RestMan.proxy = "http://proxy.example.com/"
+#
+# Or inherit the proxy from the environment:
+#
+#   RestMan.proxy = ENV['http_proxy']
+#
+# For live tests of RestMan, try using http://rest-test.heroku.com, which echoes back information about the rest call:
+#
+#   >> RestMan.put 'http://rest-test.heroku.com/resource', :foo => 'baz'
+#   => "PUT http://rest-test.heroku.com/resource with a 7 byte payload, content type application/x-www-form-urlencoded {\"foo\"=>\"baz\"}"
+#
+module RestMan
+
+  def self.get(url, headers={}, &block)
+    Request.execute(:method => :get, :url => url, :headers => headers, &block)
+  end
+
+  def self.post(url, payload, headers={}, &block)
+    Request.execute(:method => :post, :url => url, :payload => payload, :headers => headers, &block)
+  end
+
+  def self.patch(url, payload, headers={}, &block)
+    Request.execute(:method => :patch, :url => url, :payload => payload, :headers => headers, &block)
+  end
+
+  def self.put(url, payload, headers={}, &block)
+    Request.execute(:method => :put, :url => url, :payload => payload, :headers => headers, &block)
+  end
+
+  def self.delete(url, headers={}, &block)
+    Request.execute(:method => :delete, :url => url, :headers => headers, &block)
+  end
+
+  def self.head(url, headers={}, &block)
+    Request.execute(:method => :head, :url => url, :headers => headers, &block)
+  end
+
+  def self.options(url, headers={}, &block)
+    Request.execute(:method => :options, :url => url, :headers => headers, &block)
+  end
+
+  # A global proxy URL to use for all requests. This can be overridden on a
+  # per-request basis by passing `:proxy` to RestMan::Request.
+  def self.proxy
+    @proxy ||= nil
+  end
+
+  def self.proxy=(value)
+    @proxy = value
+    @proxy_set = true
+  end
+
+  # Return whether RestMan.proxy was set explicitly. We use this to
+  # differentiate between no value being set and a value explicitly set to nil.
+  #
+  # @return [Boolean]
+  #
+  def self.proxy_set?
+    @proxy_set ||= false
+  end
+
+  # Setup the log for RestMan calls.
+  # Value should be a logger but can can be stdout, stderr, or a filename.
+  # You can also configure logging by the environment variable RESTCLIENT_LOG.
+  def self.log= log
+    @@log = create_log log
+  end
+
+  # Create a log that respond to << like a logger
+  # param can be 'stdout', 'stderr', a string (then we will log to that file) or a logger (then we return it)
+  def self.create_log param
+    if param
+      if param.is_a? String
+        if param == 'stdout'
+          stdout_logger = Class.new do
+            def << obj
+              STDOUT.puts obj
+            end
+          end
+          stdout_logger.new
+        elsif param == 'stderr'
+          stderr_logger = Class.new do
+            def << obj
+              STDERR.puts obj
+            end
+          end
+          stderr_logger.new
+        else
+          file_logger = Class.new do
+            attr_writer :target_file
+
+            def << obj
+              File.open(@target_file, 'a') { |f| f.puts obj }
+            end
+          end
+          logger = file_logger.new
+          logger.target_file = param
+          logger
+        end
+      else
+        param
+      end
+    end
+  end
+
+  @@env_log = create_log ENV['RESTCLIENT_LOG']
+
+  @@log = nil
+
+  def self.log # :nodoc:
+    @@env_log || @@log
+  end
+
+  @@before_execution_procs = []
+
+  # Add a Proc to be called before each request in executed.
+  # The proc parameters will be the http request and the request params.
+  def self.add_before_execution_proc &proc
+    raise ArgumentError.new('block is required') unless proc
+    @@before_execution_procs << proc
+  end
+
+  # Reset the procs to be called before each request is executed.
+  def self.reset_before_execution_procs
+    @@before_execution_procs = []
+  end
+
+  def self.before_execution_procs # :nodoc:
+    @@before_execution_procs
+  end
+
+end

data/matrixeval.yml

@@ -0,0 +1,73 @@
+version: 0.4
+target: ruby
+project_name: rest_man
+parallel_workers: number_of_processors
+commands:
+  - jruby
+#   - ps
+#   - top
+#   - an_additional_command
+# mounts:
+#   - /a/path/need/to/mount:/a/path/mount/to
+matrix:
+  ruby:
+    variants:
+      - key: 2.7
+        container:
+          image: ruby:2.7.6
+      - key: 3.0
+        default: true
+        container:
+          image: ruby:3.0.4
+      - key: 3.1
+        container:
+          image: ruby:3.1.0
+      - key: jruby-9.3
+        container:
+          image: hoppergee/jruby:9.3.7-dev
+        env:
+            PATH: "/opt/jruby/bin:/app/bin:/bundle/bin:$PATH"
+            JRUBY_OPTS: "--dev -X-C --debug"
+            JAVA_OPTS: "-client -XX:+TieredCompilation -XX:TieredStopAtLevel=1"
+      #   mounts:
+      #     - /a/path/need/to/mount:/a/path/mount/to
+
+  # rails:
+  #   variants:
+  #     - key: 6.1
+  #       default: true
+  #       env:
+  #         RAILS_VERSION: "~> 6.1.0"
+  #     - key: 7.0
+  #       env:
+  #         RAILS_VERSION: "~> 7.0.0"
+  # another:
+  #   variants:
+  #     - key: key1
+  #       default: true
+  #       env:
+  #         ENV_KEY: 1
+  #     - key: key2
+  #       env:
+  #         ENV_KEY: 2
+
+exclude:
+  # - ruby: 3.0
+  #   rails: 4.2
+  # - ruby: jruby-9.3
+  #   rails: 7.0
+
+docker-compose-extend:
+  # services:
+  #   postgres:
+  #     image: postgres:12.8
+  #     volumes:
+  #       - postgres12:/var/lib/postgresql/data
+  #     environment:
+  #       POSTGRES_HOST_AUTH_METHOD: trust
+
+  #   redis:
+  #     image: redis:6.2-alpine
+
+  # volumes:
+  #   postgres12:

data/rest-man.gemspec

@@ -0,0 +1,41 @@
+# -*- encoding: utf-8 -*-
+
+require File.expand_path('../lib/restman/version', __FILE__)
+
+Gem::Specification.new do |s|
+  s.name = 'rest-man'
+  s.version = RestMan::VERSION
+  s.authors = ['Hopper Gee']
+  s.description = 'A simple HTTP and REST client for Ruby, inspired by the Sinatra microframework style of specifying actions: get, put, post, delete.'
+  s.license = 'MIT'
+  s.email = 'hopper.gee@hey.com'
+  s.extra_rdoc_files = ['README.md', 'CHANGELOG.md']
+  s.files = `git ls-files -z`.split("\0")
+  s.test_files = `git ls-files -z spec/`.split("\0")
+  s.bindir = "exe"
+  s.executables = ['restman']
+
+  s.homepage = 'https://github.com/rest-man/rest-man'
+  s.summary = 'Simple HTTP and REST client for Ruby, inspired by microframework syntax for specifying actions.'
+
+  s.add_development_dependency('webmock', '~> 3.0')
+  s.add_development_dependency('rspec', '~> 3.0', '< 3.10')
+  s.add_development_dependency('pry', '~> 0')
+  s.add_development_dependency('pry-doc', '~> 0')
+  s.add_development_dependency('rdoc', '>= 2.4.2', '< 7.0')
+  s.add_development_dependency('rubocop', '~> 0.49')
+
+  s.add_dependency('http-accept', '>= 1.7.0', '< 3.0')
+  s.add_dependency('http-cookie', '>= 1.0.2', '< 2.0')
+  s.add_dependency('mime-types', '>= 1.16', '< 4.0')
+  s.add_dependency('netrc', '~> 0.8')
+
+  s.required_ruby_version = '>= 2.0.0'
+
+  case ENV['BUILD_PLATFORM'] || RUBY_PLATFORM
+  when /(mingw32|mswin32)/
+    # ffi is needed for RestMan::Windows::RootCerts
+    s.add_dependency('ffi', '~> 1.9')
+    s.platform = platform
+  end
+end

data/spec/cassettes/request_httpbin_with_basic_auth.yml

@@ -0,0 +1,83 @@
+---
+http_interactions:
+- request:
+    method: get
+    uri: https://httpbin.org/basic-auth/user/pass
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers:
+      Accept:
+      - "*/*"
+      User-Agent:
+      - rest-man/1.0.0 (darwin21 arm64) ruby/2.7.6p219
+      Accept-Encoding:
+      - gzip;q=1.0,deflate;q=0.6,identity;q=0.3
+      Host:
+      - httpbin.org
+      Authorization:
+      - Basic dXNlcjpwYXNz
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Date:
+      - Mon, 30 May 2022 12:36:21 GMT
+      Content-Type:
+      - application/json
+      Content-Length:
+      - '47'
+      Connection:
+      - keep-alive
+      Server:
+      - gunicorn/19.9.0
+      Access-Control-Allow-Origin:
+      - "*"
+      Access-Control-Allow-Credentials:
+      - 'true'
+    body:
+      encoding: UTF-8
+      string: "{\n  \"authenticated\": true, \n  \"user\": \"user\"\n}\n"
+  recorded_at: Mon, 30 May 2022 12:36:21 GMT
+- request:
+    method: get
+    uri: https://httpbin.org/basic-auth/user/pass
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers:
+      Accept:
+      - "*/*"
+      User-Agent:
+      - rest-man/1.0.0 (darwin21 arm64) ruby/2.7.6p219
+      Accept-Encoding:
+      - gzip;q=1.0,deflate;q=0.6,identity;q=0.3
+      Host:
+      - httpbin.org
+      Authorization:
+      - Basic dXNlcjpiYWRwYXNz
+  response:
+    status:
+      code: 401
+      message: UNAUTHORIZED
+    headers:
+      Date:
+      - Mon, 30 May 2022 12:36:22 GMT
+      Content-Length:
+      - '0'
+      Connection:
+      - keep-alive
+      Server:
+      - gunicorn/19.9.0
+      Www-Authenticate:
+      - Basic realm="Fake Realm"
+      Access-Control-Allow-Origin:
+      - "*"
+      Access-Control-Allow-Credentials:
+      - 'true'
+    body:
+      encoding: UTF-8
+      string: ''
+  recorded_at: Mon, 30 May 2022 12:36:22 GMT
+recorded_with: VCR 6.1.0

data/spec/cassettes/request_httpbin_with_cookies.yml

@@ -0,0 +1,49 @@
+---
+http_interactions:
+- request:
+    method: get
+    uri: https://httpbin.org/cookies/set?foo=bar
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers:
+      Accept:
+      - "*/*"
+      User-Agent:
+      - rest-man/1.0.0 (darwin21 arm64) ruby/2.7.6p219
+      Accept-Encoding:
+      - gzip;q=1.0,deflate;q=0.6,identity;q=0.3
+      Host:
+      - httpbin.org
+  response:
+    status:
+      code: 302
+      message: FOUND
+    headers:
+      Date:
+      - Mon, 30 May 2022 12:34:45 GMT
+      Content-Type:
+      - text/html; charset=utf-8
+      Content-Length:
+      - '223'
+      Connection:
+      - keep-alive
+      Server:
+      - gunicorn/19.9.0
+      Location:
+      - "/cookies"
+      Set-Cookie:
+      - foo=bar; Path=/
+      Access-Control-Allow-Origin:
+      - "*"
+      Access-Control-Allow-Credentials:
+      - 'true'
+    body:
+      encoding: UTF-8
+      string: |-
+        <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 3.2 Final//EN">
+        <title>Redirecting...</title>
+        <h1>Redirecting...</h1>
+        <p>You should be redirected automatically to target URL: <a href="/cookies">/cookies</a>.  If not click the link.
+  recorded_at: Mon, 30 May 2022 12:34:45 GMT
+recorded_with: VCR 6.1.0

data/spec/cassettes/request_httpbin_with_cookies_2.yml

@@ -0,0 +1,94 @@
+---
+http_interactions:
+- request:
+    method: get
+    uri: https://httpbin.org/cookies/set?foo=bar
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers:
+      Accept:
+      - "*/*"
+      User-Agent:
+      - rest-man/1.0.0 (darwin21 arm64) ruby/2.7.6p219
+      Accept-Encoding:
+      - gzip;q=1.0,deflate;q=0.6,identity;q=0.3
+      Host:
+      - httpbin.org
+  response:
+    status:
+      code: 302
+      message: FOUND
+    headers:
+      Date:
+      - Mon, 30 May 2022 12:35:37 GMT
+      Content-Type:
+      - text/html; charset=utf-8
+      Content-Length:
+      - '223'
+      Connection:
+      - keep-alive
+      Server:
+      - gunicorn/19.9.0
+      Location:
+      - "/cookies"
+      Set-Cookie:
+      - foo=bar; Path=/
+      Access-Control-Allow-Origin:
+      - "*"
+      Access-Control-Allow-Credentials:
+      - 'true'
+    body:
+      encoding: UTF-8
+      string: |-
+        <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 3.2 Final//EN">
+        <title>Redirecting...</title>
+        <h1>Redirecting...</h1>
+        <p>You should be redirected automatically to target URL: <a href="/cookies">/cookies</a>.  If not click the link.
+  recorded_at: Mon, 30 May 2022 12:35:37 GMT
+- request:
+    method: get
+    uri: https://httpbin.org/cookies
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers:
+      Accept:
+      - "*/*"
+      User-Agent:
+      - rest-man/1.0.0 (darwin21 arm64) ruby/2.7.6p219
+      Cookie:
+      - foo=bar
+      Accept-Encoding:
+      - gzip;q=1.0,deflate;q=0.6,identity;q=0.3
+      Host:
+      - httpbin.org
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Date:
+      - Mon, 30 May 2022 12:35:38 GMT
+      Content-Type:
+      - application/json
+      Content-Length:
+      - '40'
+      Connection:
+      - keep-alive
+      Server:
+      - gunicorn/19.9.0
+      Access-Control-Allow-Origin:
+      - "*"
+      Access-Control-Allow-Credentials:
+      - 'true'
+    body:
+      encoding: UTF-8
+      string: |
+        {
+          "cookies": {
+            "foo": "bar"
+          }
+        }
+  recorded_at: Mon, 30 May 2022 12:35:38 GMT
+recorded_with: VCR 6.1.0

data/spec/cassettes/request_httpbin_with_cookies_3.yml

@@ -0,0 +1,49 @@
+---
+http_interactions:
+- request:
+    method: get
+    uri: https://httpbin.org/cookies/set?foo=%22bar:baz%22
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers:
+      Accept:
+      - "*/*"
+      User-Agent:
+      - rest-man/1.0.0 (darwin21 arm64) ruby/2.7.6p219
+      Accept-Encoding:
+      - gzip;q=1.0,deflate;q=0.6,identity;q=0.3
+      Host:
+      - httpbin.org
+  response:
+    status:
+      code: 302
+      message: FOUND
+    headers:
+      Date:
+      - Mon, 30 May 2022 12:39:05 GMT
+      Content-Type:
+      - text/html; charset=utf-8
+      Content-Length:
+      - '223'
+      Connection:
+      - keep-alive
+      Server:
+      - gunicorn/19.9.0
+      Location:
+      - "/cookies"
+      Set-Cookie:
+      - foo="\"bar:baz\""; Path=/
+      Access-Control-Allow-Origin:
+      - "*"
+      Access-Control-Allow-Credentials:
+      - 'true'
+    body:
+      encoding: UTF-8
+      string: |-
+        <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 3.2 Final//EN">
+        <title>Redirecting...</title>
+        <h1>Redirecting...</h1>
+        <p>You should be redirected automatically to target URL: <a href="/cookies">/cookies</a>.  If not click the link.
+  recorded_at: Mon, 30 May 2022 12:39:05 GMT
+recorded_with: VCR 6.1.0

data/spec/cassettes/request_httpbin_with_encoding_deflate.yml

@@ -0,0 +1,45 @@
+---
+http_interactions:
+- request:
+    method: get
+    uri: https://httpbin.org/deflate
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers:
+      Accept:
+      - "*/*"
+      User-Agent:
+      - rest-man/1.0.0 (darwin21 arm64) ruby/2.7.6p219
+      Accept-Encoding:
+      - gzip;q=1.0,deflate;q=0.6,identity;q=0.3
+      Host:
+      - httpbin.org
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Date:
+      - Mon, 30 May 2022 12:32:00 GMT
+      Content-Type:
+      - application/json
+      Content-Length:
+      - '254'
+      Connection:
+      - keep-alive
+      Server:
+      - gunicorn/19.9.0
+      Access-Control-Allow-Origin:
+      - "*"
+      Access-Control-Allow-Credentials:
+      - 'true'
+    body:
+      encoding: ASCII-8BIT
+      string: "{\n  \"deflated\": true, \n  \"headers\": {\n    \"Accept\": \"*/*\",
+        \n    \"Accept-Encoding\": \"gzip;q=1.0,deflate;q=0.6,identity;q=0.3\", \n
+        \   \"Host\": \"httpbin.org\", \n    \"User-Agent\": \"rest-man/1.0.0 (darwin21
+        arm64) ruby/2.7.6p219\", \n    \"X-Amzn-Trace-Id\": \"Root=1-6294b940-009eaf8d5d374cf75292eff2\"\n
+        \ }, \n  \"method\": \"GET\", \n  \"origin\": \"159.65.106.225\"\n}\n"
+  recorded_at: Mon, 30 May 2022 12:32:00 GMT
+recorded_with: VCR 6.1.0

data/spec/cassettes/request_httpbin_with_encoding_deflate_and_accept_headers.yml

@@ -0,0 +1,44 @@
+---
+http_interactions:
+- request:
+    method: get
+    uri: https://httpbin.org/deflate
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers:
+      Accept:
+      - "*/*"
+      User-Agent:
+      - rest-man/1.0.0 (darwin21 arm64) ruby/2.7.6p219
+      Accept-Encoding:
+      - gzip, deflate
+      Host:
+      - httpbin.org
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Date:
+      - Mon, 30 May 2022 12:41:31 GMT
+      Content-Type:
+      - application/json
+      Content-Length:
+      - '235'
+      Connection:
+      - keep-alive
+      Server:
+      - gunicorn/19.9.0
+      Content-Encoding:
+      - deflate
+      Access-Control-Allow-Origin:
+      - "*"
+      Access-Control-Allow-Credentials:
+      - 'true'
+    body:
+      encoding: ASCII-8BIT
+      string: !binary |-
+        eJw9j01rwyAcxu/5FOJpLdVGTQwZ9JBD2XYdHeyq8d9EaDQYy1hLv/tMOnJ8fs8LPPcMIWzgfFERDH5FMVxhh2bYgzIQpsTuSSbQtC2MMWm83W/xElopObrWG+u62e5udtyh/9E1+O6npdzHOGrrqA/d6n1NEEjTgVsSAaZI2otNcs8pozl6MSr8WMcZUmGQxQaFq/5NXkXlyFm97nyTZrg5cgqqBfIx/8Gf3scDI5LXhdaVJvJsZF5zw5koBQghqqLgnBmcFh7P5wPE3i/lt+PpuY19sJ11M2NlTWVJWS4p5yXOHtkfO+dVfg==
+  recorded_at: Mon, 30 May 2022 12:41:31 GMT
+recorded_with: VCR 6.1.0