lhc 9.4.0 → 9.4.1

data/gh-md-toc

@@ -0,0 +1,228 @@
+#!/usr/bin/env bash
+
+#
+# Steps:
+#
+#  1. Download corresponding html file for some README.md:
+#       curl -s $1
+#
+#  2. Discard rows where no substring 'user-content-' (github's markup):
+#       awk '/user-content-/ { ...
+#
+#  3.1 Get last number in each row like ' ... </span></a>sitemap.js</h1'.
+#      It's a level of the current header:
+#       substr($0, length($0), 1)
+#
+#  3.2 Get level from 3.1 and insert corresponding number of spaces before '*':
+#       sprintf("%*s", substr($0, length($0), 1)*3, " ")
+#
+#  4. Find head's text and insert it inside "* [ ... ]":
+#       substr($0, match($0, /a>.*<\/h/)+2, RLENGTH-5)
+#
+#  5. Find anchor and insert it inside "(...)":
+#       substr($0, match($0, "href=\"[^\"]+?\" ")+6, RLENGTH-8)
+#
+
+gh_toc_version="0.5.0"
+
+gh_user_agent="gh-md-toc v$gh_toc_version"
+
+#
+# Download rendered into html README.md by its url.
+#
+#
+gh_toc_load() {
+    local gh_url=$1
+
+    if type curl &>/dev/null; then
+        curl --user-agent "$gh_user_agent" -s "$gh_url"
+    elif type wget &>/dev/null; then
+        wget --user-agent="$gh_user_agent" -qO- "$gh_url"
+    else
+        echo "Please, install 'curl' or 'wget' and try again."
+        exit 1
+    fi
+}
+
+#
+# Converts local md file into html by GitHub
+#
+# ➥ curl -X POST --data '{"text": "Hello world github/linguist#1 **cool**, and #1!"}' https://api.github.com/markdown
+# <p>Hello world github/linguist#1 <strong>cool</strong>, and #1!</p>'"
+gh_toc_md2html() {
+    local gh_file_md=$1
+    URL=https://api.github.com/markdown/raw
+    TOKEN="$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)/token.txt"
+    if [ -f "$TOKEN" ]; then
+        URL="$URL?access_token=$(cat $TOKEN)"
+    fi
+    curl -s --user-agent "$gh_user_agent" \
+        --data-binary @"$gh_file_md" -H "Content-Type:text/plain" \
+        $URL
+}
+
+#
+# Is passed string url
+#
+gh_is_url() {
+    case $1 in
+        https* | http*)
+            echo "yes";;
+        *)
+            echo "no";;
+    esac
+}
+
+#
+# TOC generator
+#
+gh_toc(){
+    local gh_src=$1
+    local gh_src_copy=$1
+    local gh_ttl_docs=$2
+    local need_replace=$3
+
+    if [ "$gh_src" = "" ]; then
+        echo "Please, enter URL or local path for a README.md"
+        exit 1
+    fi
+
+
+    # Show "TOC" string only if working with one document
+    if [ "$gh_ttl_docs" = "1" ]; then
+
+        echo "Table of Contents"
+        echo "================="
+        echo ""
+        gh_src_copy=""
+
+    fi
+
+    if [ "$(gh_is_url "$gh_src")" == "yes" ]; then
+        gh_toc_load "$gh_src" | gh_toc_grab "$gh_src_copy"
+        if [ "$need_replace" = "yes" ]; then
+            echo
+            echo "!! '$gh_src' is not a local file"
+            echo "!! Can't insert the TOC into it."
+            echo
+        fi
+    else
+        local toc=`gh_toc_md2html "$gh_src" | gh_toc_grab "$gh_src_copy"`
+        echo "$toc"
+        if [ "$need_replace" = "yes" ]; then
+            local ts="<\!--ts-->"
+            local te="<\!--te-->"
+            local dt=`date +'%F_%H%M%S'`
+            local ext=".orig.${dt}"
+            local toc_path="${gh_src}.toc.${dt}"
+            local toc_footer="<!-- Added by: `whoami`, at: `date --iso-8601='minutes'` -->"
+            # http://fahdshariff.blogspot.ru/2012/12/sed-mutli-line-replacement-between-two.html
+            # clear old TOC
+            sed -i${ext} "/${ts}/,/${te}/{//!d;}" "$gh_src"
+            # create toc file
+            echo "${toc}" > "${toc_path}"
+            echo -e "\n${toc_footer}\n" >> "$toc_path"
+            # insert toc file
+            if [[ "`uname`" == "Darwin" ]]; then
+                sed -i "" "/${ts}/r ${toc_path}" "$gh_src"
+            else
+                sed -i "/${ts}/r ${toc_path}" "$gh_src"
+            fi
+            echo
+            echo "!! TOC was added into: '$gh_src'"
+            echo "!! Origin version of the file: '${gh_src}${ext}'"
+            echo "!! TOC added into a separate file: '${toc_path}'"
+            echo
+        fi
+    fi
+}
+
+#
+# Grabber of the TOC from rendered html
+#
+# $1 — a source url of document.
+# It's need if TOC is generated for multiple documents.
+#
+gh_toc_grab() {
+	# if closed <h[1-6]> is on the new line, then move it on the prev line
+	# for example:
+	# 	was: The command <code>foo1</code>
+	# 		 </h1>
+	# 	became: The command <code>foo1</code></h1>
+    sed -e ':a' -e 'N' -e '$!ba' -e 's/\n<\/h/<\/h/g' |
+    # find strings that corresponds to template
+    grep -E -o '<a.*id="user-content-[^"]*".*</h[1-6]' |
+    # remove code tags
+    sed 's/<code>//' | sed 's/<\/code>//' |
+    # now all rows are like:
+    #   <a id="user-content-..." href="..."><span ...></span></a> ... </h1
+    # format result line
+    #   * $0 — whole string
+    echo -e "$(awk -v "gh_url=$1" '{
+    print sprintf("%*s", substr($0, length($0), 1)*3, " ") "* [" substr($0, match($0, /a>.*<\/h/)+2, RLENGTH-5)"](" gh_url substr($0, match($0, "href=\"[^\"]+?\" ")+6, RLENGTH-8) ")"}' | sed 'y/+/ /; s/%/\\x/g')"
+}
+
+#
+# Returns filename only from full path or url
+#
+gh_toc_get_filename() {
+    echo "${1##*/}"
+}
+
+#
+# Options hendlers
+#
+gh_toc_app() {
+    local app_name="gh-md-toc"
+    local need_replace="no"
+
+    if [ "$1" = '--help' ] || [ $# -eq 0 ] ; then
+        echo "GitHub TOC generator ($app_name): $gh_toc_version"
+        echo ""
+        echo "Usage:"
+        echo "  $app_name [--insert] src [src]  Create TOC for a README file (url or local path)"
+        echo "  $app_name -                     Create TOC for markdown from STDIN"
+        echo "  $app_name --help                Show help"
+        echo "  $app_name --version             Show version"
+        return
+    fi
+
+    if [ "$1" = '--version' ]; then
+        echo "$gh_toc_version"
+        return
+    fi
+
+    if [ "$1" = "-" ]; then
+        if [ -z "$TMPDIR" ]; then
+            TMPDIR="/tmp"
+        elif [ -n "$TMPDIR" -a ! -d "$TMPDIR" ]; then
+            mkdir -p "$TMPDIR"
+        fi
+        local gh_tmp_md
+        gh_tmp_md=$(mktemp $TMPDIR/tmp.XXXXXX)
+        while read input; do
+            echo "$input" >> "$gh_tmp_md"
+        done
+        gh_toc_md2html "$gh_tmp_md" | gh_toc_grab ""
+        return
+    fi
+
+    if [ "$1" = '--insert' ]; then
+        need_replace="yes"
+        shift
+    fi
+
+    for md in "$@"
+    do
+        echo ""
+        gh_toc "$md" "$#" "$need_replace"
+    done
+
+    echo ""
+    echo "Created by [gh-md-toc](https://github.com/ekalinin/github-markdown-toc)"
+}
+
+#
+# Entry point
+#
+gh_toc_app "$@"

data/lhc.gemspec

@@ -8,10 +8,10 @@ Gem::Specification.new do |s|
   s.name        = "lhc"
   s.version     = LHC::VERSION
   s.authors     = ['https://github.com/local-ch/lhc/contributors']
-  s.email       = ['ws-operations@local.ch']
+  s.email       = ['web@localsearch.ch']
   s.homepage    = 'https://github.com/local-ch/lhc'
-  s.summary     = 'LocalHttpClient'
-  s.description = 'Rails gem for HTTP: Wraps typhoeus and provides additional features (like interceptors)'
+  s.summary     = 'Advanced HTTP Client for Ruby, fueled with interceptors'
+  s.description = 'Advanced HTTP Client for Ruby, fueled with interceptors'
 
   s.files        = `git ls-files`.split("\n")
   s.test_files   = `git ls-files -- spec/*`.split("\n")

data/lib/lhc/version.rb

@@ -1,3 +1,3 @@
 module LHC
-  VERSION ||= '9.4.0'
+  VERSION ||= '9.4.1'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: lhc
 version: !ruby/object:Gem::Version
-  version: 9.4.0
+  version: 9.4.1
 platform: ruby
 authors:
 - https://github.com/local-ch/lhc/contributors
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-07-20 00:00:00.000000000 Z
+date: 2018-07-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -164,10 +164,9 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description: 'Rails gem for HTTP: Wraps typhoeus and provides additional features
-  (like interceptors)'
+description: Advanced HTTP Client for Ruby, fueled with interceptors
 email:
-- ws-operations@local.ch
+- web@localsearch.ch
 executables: []
 extensions: []
 extra_rdoc_files: []
@@ -189,20 +188,7 @@ files:
 - cider-ci/task_components/rspec.yml
 - cider-ci/task_components/rubocop.yml
 - cider-ci/task_components/ruby.yml
-- docs/configuration.md
-- docs/exceptions.md
-- docs/interceptors.md
-- docs/interceptors/authentication.md
-- docs/interceptors/caching.md
-- docs/interceptors/default_timeout.md
-- docs/interceptors/logging.md
-- docs/interceptors/monitoring.md
-- docs/interceptors/prometheus.md
-- docs/interceptors/retry.md
-- docs/interceptors/rollbar.md
-- docs/interceptors/zipkin.md
-- docs/request.md
-- docs/response.md
+- gh-md-toc
 - lhc.gemspec
 - lib/lhc.rb
 - lib/lhc/concerns/lhc/basic_methods_concern.rb
@@ -377,7 +363,7 @@ rubyforge_project:
 rubygems_version: 2.7.6
 signing_key: 
 specification_version: 4
-summary: LocalHttpClient
+summary: Advanced HTTP Client for Ruby, fueled with interceptors
 test_files:
 - spec/basic_methods/delete_spec.rb
 - spec/basic_methods/get_spec.rb

data/docs/configuration.md

@@ -1,57 +0,0 @@
-Configuration
-===
-
-## Configure LHC on initialization
-
-If you want to configure LHC on initialization (like in a Rails initializer, `environment.rb` or `application.rb`), you could run into the problem that certain configurations can only be set once.
-You can use `LHC.configure` to prevent the initialization problem.
-Take care that you only use `LHC.configure` once, because it is actually reseting previously made configurations and applies the new once.
-
-```ruby
-
-  LHC.configure do |c|
-    c.placeholder :datastore, 'http://datastore/v2'
-    c.endpoint :feedbacks, '{+datastore}/feedbacks'
-    c.interceptors = [CachingInterceptor, MonitorInterceptor, TrackingIdInterceptor]
-  end
-
-```
-
-## Endpoints
-
-You can configure endpoints, for later use, by giving them a name, an url and some parameters (optional).
-
-```ruby
-  url = 'http://datastore/v2/feedbacks'
-  options = { params: { has_reviews: true } }
-  LHC.config.endpoint(:feedbacks, url, options)
-  LHC.get(:feedbacks)
-```
-
-Explicit request options override configured options.
-
-```ruby
-  LHC.get(:feedbacks, params: { has_reviews: false }) # Overrides configured params
-```
-
-## Placeholders
-
-You can configure global placeholders, that are used when generating urls from url-templates.
-
-```ruby
-  LHC.config.placeholder(:datastore, 'http://datastore/v2')
-  options = { params: { has_reviews: true } }
-  LHC.config.endpoint(:feedbacks, '{+datastore}/feedbacks', options)
-  LHC.get(:feedbacks)
-```
-
-## Interceptors
-
-To enable interceptors you have to configure LHC's interceptors for http communication.
-The global default interceptors are processed in the order you provide them.
-
-```ruby
-  LHC.config.interceptors = [CachingInterceptor, MonitorInterceptor, TrackingIdInterceptor]
-```
-
-You can only set the list of global interceptors once and you can not alter it after you set it.

data/docs/exceptions.md

@@ -1,68 +0,0 @@
-Exceptions
-===
-
-Anything but a response code indicating success (2**) raises an exception.
-
-```ruby
-
-  LHC.get('localhost') # UnknownError: 0
-  LHC.get('http://localhost:3000') # LHC::Timeout: 0
-
-```
-
-You can access the response object that was causing the error.
-
-```ruby
-LHC.get('local.ch')
-rescue => e
-  e.response #<LHC:Response>
-  e.response.code # 403
-  e.response.timeout? # false
-  Rails.logger.error e
-  # LHC::UnknownError: get http://local.cac
-  # Params: {:url=>"http://local.cac", :method=>:get}
-  # Response Code: 0
-  # <Response Body>
-```
-
-All errors that are raise by LHC inherit from `LHC::Error`.
-They are divided into `LHC::ClientError`, `LHC::ServerError`, `LHC::Timeout` and `LHC::UnkownError` and mapped according to the following status code.
-
-```ruby
-400 => LHC::BadRequest
-401 => LHC::Unauthorized
-402 => LHC::PaymentRequired
-403 => LHC::Forbidden
-403 => LHC::Forbidden
-404 => LHC::NotFound
-405 => LHC::MethodNotAllowed
-406 => LHC::NotAcceptable
-407 => LHC::ProxyAuthenticationRequired
-408 => LHC::RequestTimeout
-409 => LHC::Conflict
-410 => LHC::Gone
-411 => LHC::LengthRequired
-412 => LHC::PreconditionFailed
-413 => LHC::RequestEntityTooLarge
-414 => LHC::RequestUriToLong
-415 => LHC::UnsupportedMediaType
-416 => LHC::RequestedRangeNotSatisfiable
-417 => LHC::ExpectationFailed
-422 => LHC::UnprocessableEntity
-423 => LHC::Locked
-424 => LHC::FailedDependency
-426 => LHC::UpgradeRequired
-
-500 => LHC::InternalServerError
-501 => LHC::NotImplemented
-502 => LHC::BadGateway
-503 => LHC::ServiceUnavailable
-504 => LHC::GatewayTimeout
-505 => LHC::HttpVersionNotSupported
-507 => LHC::InsufficientStorage
-510 => LHC::NotExtended
-
-timeout? => LHC::Timeout
-
-anything_else => LHC::UnknownError
-```

data/docs/interceptors.md

@@ -1,98 +0,0 @@
-Interceptors
-===
-
-## Quick Start Guide
-
-```ruby
-  class TrackingIdInterceptor < LHC::Interceptor
-
-    def before_request
-      request.params[:tid] = 123
-    end
-  end
-```
-
-```ruby
-  LHC.config.interceptors = [TrackingIdInterceptor] # global list of default interceptors
-```
-
-```ruby
-  LHC.request({url: 'http://local.ch', interceptors: []}) # no interceptor for this request
-```
-
-## Core Interceptors
-
-There are some interceptors that are part of LHC already, that cover some basic usecases:
-
-[Available Core Interceptors](/docs/interceptors)
-
-## Callbacks
-
-`before_raw_request` is called before the raw typhoeus request is prepared/created.
-
-`before_request` is called when the request is prepared and about to be executed.
-
-`after_request` is called after request was started.
-
-`before_response` is called when response started to arrive.
-
-`after_response` is called after the response arrived completely.
-
-
-## Attributes: Request/Response
-
-Every interceptor can directly access their instance `request` or `response`.
-
-→ [Read more about the request object](request.md)
-
-→ [Read more about the response object](response.md)
-
-## Global default interceptors
-
-Set the list of global default interceptors.
-The global default interceptors are processed in the order you provide them.
-
-```ruby
-  LHC.config.interceptors = [CachingInterceptor, MonitorInterceptor, TrackingIdInterceptor]
-```
-
-You can only set the list of global interceptors once and you cannot alter them later.
-
-## Interceptors on request level
-
-You can override the global default interceptors on request level:
-
-```ruby
-  interceptors = LHC.config.interceptors
-  interceptors -= [CachingInterceptor] # remove caching
-  interceptors += [RetryInterceptor] # add retry
-  LHC.request({url: 'http://local.ch', retry: 2, interceptors: interceptors})
-```
-
-## Provide Response
-
-Inside an interceptor, you are able to provide a response, rather then doing a real request.
-This is useful for implementing an interceptor for caching.
-
-```ruby
-class LHC::Cache < LHC::Interceptor
-
-  def before_request(request)
-    cached_response = Rails.cache.fetch(request.url)
-    return LHC::Response.new(cached_response) if cached_response
-  end
-end
-```
-
-Take care that having more than one interceptor trying to return a response will cause an exception.
-You can access the request.response to identify if a response was already provided by another interceptor.
-
-```ruby
-  class RemoteCacheInterceptor < LHC::Interceptor
-
-    def before_request(request)
-      return unless request.response.nil?
-      return LHC::Response.new(remote_cache)
-    end
-  end
-```