RubyGems - sinew - Versions diffs - 2.0.1 → 3.0.0 - Mend

sinew 2.0.1 → 3.0.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (40) hide show

checksums.yaml +4 -4
data/.github/workflows/test.yml +26 -0
data/.rubocop.yml +9 -6
data/.vscode/settings.json +0 -10
data/Gemfile +9 -0
data/LICENSE +1 -1
data/README.md +77 -58
data/Rakefile +33 -18
data/bin/sinew +8 -4
data/lib/sinew.rb +0 -1
data/lib/sinew/connection.rb +52 -0
data/lib/sinew/connection/log_formatter.rb +22 -0
data/lib/sinew/connection/rate_limit.rb +29 -0
data/lib/sinew/core_ext.rb +1 -1
data/lib/sinew/dsl.rb +27 -10
data/lib/sinew/main.rb +7 -54
data/lib/sinew/output.rb +26 -19
data/lib/sinew/request.rb +28 -49
data/lib/sinew/response.rb +25 -55
data/lib/sinew/runtime_options.rb +4 -2
data/lib/sinew/version.rb +1 -1
data/sample.sinew +2 -2
data/sinew.gemspec +16 -17
metadata +41 -81
data/.travis.yml +0 -4
data/lib/sinew/cache.rb +0 -79
data/test/legacy/eu.httpbin.org/head/redirect,3 +0 -51
data/test/legacy/eu.httpbin.org/head/status,500 +0 -1
data/test/legacy/eu.httpbin.org/redirect,3 +0 -11
data/test/legacy/eu.httpbin.org/status,500 +0 -1
data/test/legacy/legacy.sinew +0 -2
data/test/test.html +0 -45
data/test/test_cache.rb +0 -69
data/test/test_helper.rb +0 -113
data/test/test_legacy.rb +0 -21
data/test/test_main.rb +0 -46
data/test/test_nokogiri_ext.rb +0 -18
data/test/test_output.rb +0 -73
data/test/test_requests.rb +0 -135
data/test/test_utf8.rb +0 -39

data/.travis.yml DELETED Viewed

@@ -1,4 +0,0 @@
-language: ruby
-rvm:
-  - 2.3.7
-  - 2.5.1

data/lib/sinew/cache.rb DELETED Viewed

@@ -1,79 +0,0 @@
-require 'fileutils'
-require 'tempfile'
-#
-# This class handles the caching of http responses on disk.
-#
-module Sinew
-  class Cache
-    attr_reader :sinew
-    def initialize(sinew)
-      @sinew = sinew
-    end
-    def get(request)
-      body = read_if_exist(body_path(request))
-      return nil if !body
-      head = read_if_exist(head_path(request))
-      Response.from_cache(request, body, head)
-    end
-    def set(response)
-      body_path = body_path(response.request)
-      head_path = head_path(response.request)
-      FileUtils.mkdir_p(File.dirname(body_path))
-      FileUtils.mkdir_p(File.dirname(head_path))
-      # write body, and head if necessary
-      atomic_write(body_path, response.body)
-      if head_necessary?(response)
-        head = JSON.pretty_generate(response.head_as_json)
-        atomic_write(head_path, head)
-      end
-    end
-    def root_dir
-      sinew.options[:cache]
-    end
-    protected :root_dir
-    def head_necessary?(response)
-      response.error? || response.redirected?
-    end
-    protected :head_necessary?
-    def body_path(request)
-      "#{root_dir}/#{request.cache_key}"
-    end
-    protected :body_path
-    def head_path(request)
-      body_path = body_path(request)
-      dir, base = File.dirname(body_path), File.basename(body_path)
-      "#{dir}/head/#{base}"
-    end
-    protected :head_path
-    def read_if_exist(path)
-      if File.exist?(path)
-        IO.read(path, mode: 'r:UTF-8')
-      end
-    end
-    protected :read_if_exist
-    def atomic_write(path, data)
-      tmp = Tempfile.new('sinew', encoding: 'UTF-8')
-      tmp.write(data)
-      tmp.close
-      FileUtils.chmod(0o644, tmp.path)
-      FileUtils.mv(tmp.path, path)
-    ensure
-      FileUtils.rm(tmp.path, force: true)
-    end
-    protected :atomic_write
-  end
-end

data/test/legacy/eu.httpbin.org/head/redirect,3 DELETED Viewed

@@ -1,51 +0,0 @@
-HTTP/1.1 302 FOUND
-Connection: keep-alive
-Server: gunicorn/19.7.1
-Date: Wed, 02 May 2018 20:55:20 GMT
-Content-Type: text/html; charset=utf-8
-Content-Length: 247
-Location: /relative-redirect/2
-Access-Control-Allow-Origin: *
-Access-Control-Allow-Credentials: true
-X-Powered-By: Flask
-X-Processed-Time: 0
-Via: 1.1 vegur
-HTTP/1.1 302 FOUND
-Connection: keep-alive
-Server: gunicorn/19.7.1
-Date: Wed, 02 May 2018 20:55:20 GMT
-Content-Type: text/html; charset=utf-8
-Content-Length: 0
-Location: /relative-redirect/1
-Access-Control-Allow-Origin: *
-Access-Control-Allow-Credentials: true
-X-Powered-By: Flask
-X-Processed-Time: 0
-Via: 1.1 vegur
-HTTP/1.1 302 FOUND
-Connection: keep-alive
-Server: gunicorn/19.7.1
-Date: Wed, 02 May 2018 20:55:20 GMT
-Content-Type: text/html; charset=utf-8
-Content-Length: 0
-Location: /get
-Access-Control-Allow-Origin: *
-Access-Control-Allow-Credentials: true
-X-Powered-By: Flask
-X-Processed-Time: 0
-Via: 1.1 vegur
-HTTP/1.1 200 OK
-Connection: keep-alive
-Server: gunicorn/19.7.1
-Date: Wed, 02 May 2018 20:55:20 GMT
-Content-Type: application/json
-Access-Control-Allow-Origin: *
-Access-Control-Allow-Credentials: true
-X-Powered-By: Flask
-X-Processed-Time: 0
-Content-Length: 220
-Via: 1.1 vegur

data/test/legacy/eu.httpbin.org/head/status,500 DELETED Viewed

	@@ -1 +0,0 @@
1	- CURLER_ERROR curl error (22)

data/test/legacy/eu.httpbin.org/redirect,3 DELETED Viewed

@@ -1,11 +0,0 @@
-{
-  "args": {},
-  "headers": {
-    "Accept": "*/*",
-    "Connection": "close",
-    "Host": "eu.httpbin.org",
-    "User-Agent": "sinew/1.0.4"
-  },
-  "origin": "104.36.46.249",
-  "url": "http://eu.httpbin.org/get"
-}

data/test/legacy/eu.httpbin.org/status,500 DELETED Viewed

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

data/test/legacy/legacy.sinew DELETED Viewed

	@@ -1,2 +0,0 @@
1	- get 'http://eu.httpbin.org/status/500'
2	- get 'http://eu.httpbin.org/redirect/3'

data/test/test.html DELETED Viewed

@@ -1,45 +0,0 @@
-<html>
-<head>
-  <title>Title</title>
-  <script>
-    alert("alert 1");
-    alert("alert 2");
-  </script>
-</head>
-<body>
-  <div id="main">
-    <span class="class1"> text1 </span>
-    <span class="class2"> text2 </span>
-    <!-- for test_normalize -->
-    <div id="element"> text </div>
-    <div class="e"> text1 </div>
-    <div class="e"> text2 </div>
-  </div>
-  <div id="nokogiri_ext">
-    <ul>
-      <li>hello</li>
-      <li>world</li>
-    </ul>
-    <div>
-      a
-      <p>b
-        <span>c</span>
-      </p>
-      <p>b
-        <span>c</span>
-      </p>
-    </div>
-  </div>
-  <div id="text_util">
-    <!-- a comment that should be removed -->
-    <div class="will_be_removed" />
-    <a class="will_be_preserved" />
-  </div>
-</body>
-</html>

data/test/test_cache.rb DELETED Viewed

@@ -1,69 +0,0 @@
-require_relative 'test_helper'
-class TestCache < MiniTest::Test
-  def test_get
-    2.times do
-      sinew.dsl.get('http://httpbin.org/get', c: 3, d: 4)
-    end
-    if !test_network?
-      assert_requested :get, 'http://httpbin.org/get?c=3&d=4', times: 1
-    end
-    assert_equal 1, sinew.request_count
-    assert_equal({ c: '3', d: '4' }, sinew.dsl.json[:args])
-    assert File.exist?("#{TMP}/httpbin.org/get,c=3,d=4")
-    assert !File.exist?("#{TMP}/httpbin.org/head/get,c=3,d=4")
-  end
-  def test_post
-    2.times do
-      sinew.dsl.post('http://httpbin.org/post', c: 5, d: 6)
-    end
-    if !test_network?
-      assert_requested :post, 'http://httpbin.org/post', times: 1
-    end
-    assert_equal 1, sinew.request_count
-    assert_equal({ c: '5', d: '6' }, sinew.dsl.json[:form])
-  end
-  def test_redirect
-    2.times do
-      sinew.dsl.get('http://httpbin.org/redirect/2')
-    end
-    if !test_network?
-      assert_requested :get, 'http://httpbin.org/redirect/2', times: 1
-      assert_requested :get, 'http://httpbin.org/redirect/1', times: 1
-      assert_requested :get, 'http://httpbin.org/get', times: 1
-    end
-    assert_equal 1, sinew.request_count
-    assert_equal 'http://httpbin.org/get', sinew.dsl.url
-  end
-  def test_error
-    # gotta set this or the retries mess up our request counts
-    sinew.runtime_options.retries = 0
-    assert_output(/failed with 500/) do
-      2.times do
-        sinew.dsl.get('http://httpbin.org/status/500')
-      end
-    end
-    if !test_network?
-      assert_requested :get, 'http://httpbin.org/status/500', times: 1
-      assert_equal '500', sinew.dsl.raw
-    end
-    assert_equal 1, sinew.request_count
-  end
-  def test_timeout
-    return if test_network?
-    # gotta set this or the retries mess up our request counts
-    sinew.runtime_options.retries = 0
-    assert_output(/failed with 999/) do
-      2.times do
-        sinew.dsl.get('http://httpbin.org/delay/1')
-      end
-    end
-    assert_requested :get, 'http://httpbin.org/delay/1', times: 1
-    assert_equal 'timeout', sinew.dsl.raw
-  end
-end

data/test/test_helper.rb DELETED Viewed

@@ -1,113 +0,0 @@
-require 'minitest/autorun'
-require 'minitest/pride'
-require 'webmock/minitest' unless ENV['SINEW_TEST_NETWORK']
-# a hint to sinew, so that it'll do things like set rate limit to zero
-ENV['SINEW_TEST'] = '1'
-# Normally the Rakefile takes care of this, but it's handy to have it here when
-# running tests individually.
-$LOAD_PATH.unshift("#{__dir__}/../lib")
-require 'sinew'
-class MiniTest::Test
-  TMP = '/tmp/_test_sinew'.freeze
-  RECIPE = "#{TMP}/test.sinew".freeze
-  CSV = "#{TMP}/test.csv".freeze
-  HTML = File.read("#{__dir__}/test.html")
-  def setup
-    super
-    # prepare TMP
-    FileUtils.rm_rf(TMP)
-    FileUtils.mkdir_p(TMP)
-    stub_network unless test_network?
-  end
-  def sinew
-    @sinew ||= Sinew::Main.new(cache: TMP, quiet: true, recipe: RECIPE)
-  end
-  protected :sinew
-  def run_recipe(recipe)
-    File.write(RECIPE, recipe)
-    sinew.run
-  end
-  protected :run_recipe
-  def test_network?
-    !!ENV['SINEW_TEST_NETWORK']
-  end
-  protected :test_network?
-  # mock requests, patterned on httpbin
-  def stub_network
-    stub_request(:get, %r{http://[^/]+/html}).to_return(method(:respond_html))
-    stub_request(:get, %r{http://[^/]+/get\b}).to_return(method(:respond_echo))
-    stub_request(:post, %r{http://[^/]+/post\b}).to_return(method(:respond_echo))
-    stub_request(:get, %r{http://[^/]+/status/\d+}).to_return(method(:respond_status))
-    stub_request(:get, %r{http://[^/]+/(relative-)?redirect/\d+}).to_return(method(:respond_redirect))
-    stub_request(:get, %r{http://[^/]+/delay/\d+}).to_timeout
-  end
-  protected :stub_network
-  #
-  # respond_xxx helpers
-  #
-  def respond_html(_request)
-    # this html was carefully chosen to match httpbin.org/html
-    html = <<~EOF
-      <body>
-        <h1>Herman Melville - Moby-Dick</h1>
-      </body>
-    EOF
-    { body: html }
-  end
-  protected :respond_html
-  def respond_echo(request)
-    response = {}
-    response[:headers] = request.headers
-    # args
-    response[:args] = if request.uri.query
-      CGI.parse(request.uri.query).map { |k, v| [k, v.first] }.to_h
-    else
-      {}
-    end
-    # form
-    if request.headers['Content-Type'] == 'application/x-www-form-urlencoded'
-      response[:form] = CGI.parse(request.body).map { |k, v| [k, v.first] }.to_h
-    end
-    # json
-    if request.headers['Content-Type'] == 'application/json'
-      response[:json] = JSON.parse(request.body)
-    end
-    {
-      headers: { 'Content-Type' => 'application/json' },
-      body: response.to_json,
-    }
-  end
-  protected :respond_echo
-  def respond_status(request)
-    status = request.uri.to_s.split('/').last.to_i
-    { body: status.to_s, status: status }
-  end
-  protected :respond_status
-  def respond_redirect(request)
-    parts = request.uri.to_s.split('/')
-    path, count = parts[-2], parts[-1].to_i
-    url = count == 1 ? '/get' : "/#{path}/#{count - 1}"
-    url = "http://example#{url}" if path =~ /absolute/
-    { status: 302, headers: { 'Location' => url } }
-  end
-  protected :respond_redirect
-end

data/test/test_legacy.rb DELETED Viewed

@@ -1,21 +0,0 @@
-require_relative 'test_helper'
-class TestLegacy < MiniTest::Test
-  def setup
-    super
-    # These are legacy cache files, pulled from an older version of sinew. We
-    # use them to test our legacy head parsing.
-    src = 'legacy/eu.httpbin.org'
-    dst = "#{TMP}/eu.httpbin.org"
-    FileUtils.cp_r(File.expand_path(src, __dir__), dst)
-  end
-  def test_legacy
-    sinew.dsl.get('http://eu.httpbin.org/status/500')
-    assert_equal "\n", sinew.dsl.raw
-    sinew.dsl.get('http://eu.httpbin.org/redirect/3')
-    assert_equal 'http://eu.httpbin.org/get', sinew.dsl.url
-  end
-end

data/test/test_main.rb DELETED Viewed

@@ -1,46 +0,0 @@
-require_relative 'test_helper'
-class TestMain < MiniTest::Test
-  def test_noko
-    run_recipe <<~'EOF'
-      get 'http://httpbin.org/html'
-      noko.css("h1").each do |h1|
-        csv_emit(h1: h1.text)
-      end
-    EOF
-    assert_equal("h1\nHerman Melville - Moby-Dick\n", File.read(CSV))
-  end
-  def test_raw
-    run_recipe <<~'EOF'
-      get "http://httpbin.org/html"
-      raw.scan(/<h1>([^<]+)/) do
-        csv_emit(h1: $1)
-      end
-    EOF
-    assert_equal("h1\nHerman Melville - Moby-Dick\n", File.read(CSV))
-  end
-  def test_rate_limit
-    # true network requests call sleep for timeouts, which interferes with our
-    # instrumentation of Kernel#sleep
-    skip if test_network?
-    slept = false
-    # change Kernel#sleep to not really sleep!
-    Kernel.send(:alias_method, :old_sleep, :sleep)
-    Kernel.send(:define_method, :sleep) do |_duration|
-      slept = true
-    end
-    sinew.runtime_options.rate_limit = 1
-    sinew.dsl.get('http://httpbin.org/html')
-    sinew.dsl.get('http://httpbin.org/get')
-    assert(slept)
-    # restore old Kernel#sleep
-    Kernel.send(:alias_method, :sleep, :old_sleep)
-    Kernel.send(:undef_method, :old_sleep)
-  end
-end