ja 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 84d8b0344c6243bfa25097dff532fcddf4f7740a3e070c63f8d46024f17aeb1c
+  data.tar.gz: 7e35c57cf0ed3256f09435c03708c41ca87092d2ebc710425701f94d5fc229a9
+SHA512:
+  metadata.gz: 766c2be6dc11b4954dc63b814096460833901fb722d332587c26984cd5a971dd8745f855d41257a6ca93befd44db40ef1d3fa1a1dc13264c2574807141a70591
+  data.tar.gz: 95db36417c832d8fa8d4a7eba5fe3386e8dfff79c6ccffd876c80bccbc9d87254b57125c3f630ea25cc617f82737bf8eeb67ef83d857fc6ccee7fbbeb46617d0

data/.gitignore

@@ -0,0 +1,12 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+Gemfile.lock
+
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.4.2
+before_install: gem install bundler -v 1.16.0

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in ja.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 iain
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,124 @@
+# Ja
+
+A wrapper around the [http.rb](https://github.com/httprb/http) gem.
+
+The features so far:
+
+* Logging (with multiple levels, depending on the response status)
+* Automatically raising errors
+* Automatically adding the `X-Request-Id` header (from `Thread.current[:request_id]`)
+
+## Usage
+
+Without options, you will get simple logging as a result:
+
+``` ruby
+response = Ja.api.get("http://example.com/widgets")
+[INFO] (1.12ms) GET http://example.com/widgets responded with 200 OK
+```
+
+You can customize this, for instance by setting part of the url:
+
+``` ruby
+my_service = Ja.api(url: "http://my-service.com")
+respoonse = my_service.get("widgets")
+```
+
+
+Or by setting your own HTTP options:
+
+``` ruby
+client = HTTP.basic_auth(user: "alice", pass: "secret")
+my_authenticated_service = Ja.api(client: client)
+my_authenticated_service.get("my-private-widgets")
+```
+
+### Raising errors
+
+If you want to automatically raise an error when a request fails, you can use `get!`, `post!`, etc instead of the version without a bang.
+
+``` ruby
+my_service = Ja.api(url: "http://my-service.com")
+
+# raises no error:
+my_service.get("not-found")
+
+# raises Ja::Error::NotFound
+my_service.get!("not-found")
+```
+
+Most HTTP status have their own error class. They inherit from `Ja::Error::ClientError` for 4xx responses and `Ja::Error::ServerError` for 5xx responses. All inherit from `Ja::Error`.
+
+### Logging
+
+Requests are automatically logged. We detect Rails.logger, Hanami.logger or SemanticLogger by default.
+
+If the request is successful (i.e. 2xx), the log level is `info`. If the response is a redirect (i.e. 3xx), it will use the `warn` log level. For client errors (4xx) and server errors (5xx) the `error` log level is used.
+
+You can set a logger per service:
+
+``` ruby
+my_service = Ja.api(logger: Logger.new("log/my-service.log"))
+```
+
+Or configure a logger globally (it will automatically recognize Rails, Hanami and SemanticLogger):
+
+```
+Ja.logger = Logger.new("log/http.log")
+```
+
+To log the full request and full response, we need to do some monkey patching, so it is disabled by default. To enable it, call `Ja.enable_debug_logging!`. You may want to do this only for development/test but not on production, because it might mess with streaming responses. Full request logging will always log in `debug` log level and will always use the globally configered logger.
+
+### Request ID
+
+One very helpful way to manage multiple services is to pass along a "request id". If you tag your logs with that value, you can use a centralized logging service to track a request as it propagates through your fleet of microservices.
+
+You are responsible for making sure it gets set, but if you set `Thread.current[:request_id]` it will automatically be added as a header.
+
+Here's an example in Rack middleware:
+
+``` ruby
+class RequestIdMiddleware
+
+  def initialize(app)
+    @app = app
+  end
+
+  def call(env)
+    request_id = (env["HTTP_X_REQUEST_ID"] || SecureRandom.uuid.delete("-"))
+    Thread.current[:request_id] = request_id
+    @app.call(env)
+  end
+
+end
+```
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'ja'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install ja
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/iain/ja.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "ja"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/ja.gemspec

@@ -0,0 +1,31 @@
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "ja/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "ja"
+  spec.version       = Ja::VERSION
+  spec.authors       = ["iain"]
+  spec.email         = ["iain@iain.nl"]
+  spec.summary       = "Opinionated helpers for making JSON calls with the http.rb gem"
+  spec.description   = "Opinionated helpers for making JSON calls with the http.rb gem"
+  spec.homepage      = "https://github.com/iain/ja"
+  spec.license       = "MIT"
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.16"
+  spec.add_development_dependency "rake", "~> 12.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+
+  spec.add_development_dependency "pry"
+  spec.add_development_dependency "semantic_logger"
+  spec.add_development_dependency "nokogiri"
+  spec.add_development_dependency "webmock"
+
+  spec.add_dependency "http", "~> 3.0"
+end

data/lib/ja.rb

@@ -0,0 +1,71 @@
+require "http"
+require "logger"
+
+require "ja/version"
+
+require "ja/methods"
+require "ja/error"
+require "ja/api"
+require "ja/debug_logger"
+
+module Ja
+
+  def self.logger
+    @logger ||= default_logger
+  end
+
+  def self.logger=(logger)
+    @logger = logger
+  end
+
+  def self.api(*args, &block)
+    API.new(*args, &block)
+  end
+
+  def self.default_logger
+    if defined?(Rails) && Rails.logger
+      Rails.logger
+    elsif defined?(Hanami) && Hanami.logger
+      Hanami.logger
+    elsif defined?(SemanticLogger)
+      SemanticLogger[self]
+    else
+      Logger.new($stdout)
+    end
+  end
+
+  # TODO detect streaming
+  def self.format_body(headers, &body)
+    mime_type = parse_mime_type(headers)
+    case mime_type
+    when /\bjson$/
+      str = body.call
+      begin
+        JSON.pretty_generate(JSON.parse(str))
+      rescue JSON::ParserError
+        str
+      end
+    when /\bhtml$/, /\bxml$/
+      str = body.call
+      if defined?(Nokogiri)
+        Nokogiri::XML(str).to_xhtml.chomp
+      else
+        str
+      end
+    when /\bplain$/
+      body.call
+    else
+      "«body ommitted: unsupported Content-Type: #{mime_type.inspect}»"
+    end
+  end
+
+  def self.parse_mime_type(headers)
+    HTTP::ContentType.parse(headers[HTTP::Headers::CONTENT_TYPE]).mime_type
+  end
+
+  def self.enable_debug_logging!
+    return if HTTP::Client.ancestors.include?(DebugLogger)
+    HTTP::Client.prepend(DebugLogger)
+  end
+
+end

data/lib/ja/api.rb

@@ -0,0 +1,78 @@
+module Ja
+  class API
+
+    LOG_LINE = "%{verb} %{url} responded with %{status} %{reason}"
+
+    include Methods
+
+    def initialize(client:   HTTP,
+                   url:      nil,
+                   logger:   Ja.logger,
+                   log_line: LOG_LINE)
+
+      @client = client
+      @logger = logger
+      @log_line = log_line
+      @url = url
+    end
+
+    attr_reader :client, :logger, :log_line, :url
+
+    def request(verb, uri, options = {})
+      full_uri = full_url(uri)
+      start_time = Time.now
+      client_with_request_id = client.headers("X-Request-Id" => Thread.current[:request_id])
+      response = client_with_request_id.request(verb, full_uri, options)
+      log_response(response, start_time, verb, full_uri, options)
+      response
+    end
+
+    def request!(verb, uri, options = {})
+      response = request(verb, uri, options)
+      if (100..399).cover?(response.status)
+        response
+      else
+        fail Error.to_exception(verb, full_url(uri), response)
+      end
+    end
+
+    def full_url(path)
+      if url
+        File.join(url, path)
+      else
+        path
+      end
+    end
+
+    private
+
+    def log_response(response, start_time, verb, uri, _options)
+      duration = (Time.now - start_time) * 1000.0
+
+      log_level = case response.status
+                  when 100..299
+                    :info
+                  when 300..399
+                    :warn
+                  else
+                    :error
+                  end
+
+      payload = {
+        verb:    verb.to_s.upcase,
+        url:     uri.to_s,
+        status:  response.status.to_i,
+        reason:  response.status.reason.to_s,
+      }
+
+      message = log_line % payload
+
+      if defined?(SemanticLogger) && logger.is_a?(SemanticLogger::Logger)
+        logger.public_send(log_level, message: message, duration: duration, payload: payload)
+      else
+        logger.public_send(log_level, "(%.2fms) %s" % [ duration, message ])
+      end
+    end
+
+  end
+end

data/lib/ja/debug_logger.rb

@@ -0,0 +1,33 @@
+module Ja
+  module DebugLogger
+
+    def perform(req, options)
+      Ja.logger.debug {
+        lines = ["Sending #{req.verb.to_s.upcase} to #{req.uri.to_s.inspect}"]
+        lines << "\e[36m"
+        lines << req.headline
+        lines += req.headers.map { |key, value| "#{key}: #{value}" }
+        body = Ja.format_body(req.headers) {
+          buffer = ""
+          req.body.each { |chunk| buffer << chunk }
+          buffer
+        }
+        lines.join("\n") + "\n\n" + body + "\n\e[0m\n"
+      }
+
+      res = super
+
+      Ja.logger.debug {
+        lines = ["Response from #{req.verb.to_s.upcase} to #{req.uri.to_s.inspect}"]
+        lines << "\e[35m"
+        lines << "HTTP/#{res.instance_variable_get(:@version)} #{res.status}"
+        lines += res.headers.map { |key, value| "#{key}: #{value}" }
+        body = Ja.format_body(res.headers) { res.body.to_s }
+        lines.join("\n") + "\n\n" + body + "\n\e[0m\n"
+      }
+
+      res
+    end
+
+  end
+end

data/lib/ja/error.rb

@@ -0,0 +1,53 @@
+module Ja
+  class Error < StandardError
+
+    def self.to_exception(verb, uri, response)
+      Error.fetch_error_class(response.status).new(verb, uri, response)
+    end
+
+    def self.fetch_error_class(status)
+      const_get(HTTP::Response::Status::REASONS.fetch(status, "ResponseError").gsub(/\W/, ""))
+    end
+
+    attr_reader :response, :verb, :uri
+
+    def initialize(verb, uri, response)
+      @response = response
+      @verb = verb
+      @uri = uri
+
+      @headline = "%{verb} %{url} responded with %{status}" % {
+        status:  response.status,
+        verb:    verb.to_s.upcase,
+        url:     uri.to_s,
+      }
+
+      @response_body = Ja.format_body(response.headers) { response.body.to_s }
+
+      @message = @response_body ? "#{@headline}\n\n#{@response_body}" : @headline
+    end
+
+    attr_reader :message, :response_body, :headline
+
+    alias_method :to_s, :message
+
+    def status
+      response.status
+    end
+
+    # Base class for all errors
+    ResponseError = Class.new(Error)
+
+    # Base class for errors in the 4xx range
+    ClientError = Class.new(ResponseError)
+
+    # Base class for errors in the 5xx range
+    ServerError = Class.new(ResponseError)
+
+    HTTP::Response::Status::REASONS.each do |status, name|
+      parent = status >= 500 ? ServerError : ClientError
+      const_set(name.gsub(/\W/, ""), Class.new(parent))
+    end
+
+  end
+end

data/lib/ja/methods.rb

@@ -0,0 +1,19 @@
+module Ja
+  module Methods
+
+    verbs = %i[head get post put delete trace options connect patch]
+
+    verbs.each do |verb|
+
+      define_method verb do |*args, &block|
+        request verb, *args, &block
+      end
+
+      define_method "#{verb}!" do |*args, &block|
+        request! verb, *args, &block
+      end
+
+    end
+
+  end
+end

data/lib/ja/version.rb

@@ -0,0 +1,3 @@
+module Ja
+  VERSION = "0.1.0"
+end

metadata

@@ -0,0 +1,172 @@
+--- !ruby/object:Gem::Specification
+name: ja
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- iain
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-11-30 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: semantic_logger
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: nokogiri
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: http
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: Opinionated helpers for making JSON calls with the http.rb gem
+email:
+- iain@iain.nl
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- ja.gemspec
+- lib/ja.rb
+- lib/ja/api.rb
+- lib/ja/debug_logger.rb
+- lib/ja/error.rb
+- lib/ja/methods.rb
+- lib/ja/version.rb
+homepage: https://github.com/iain/ja
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.7.2
+signing_key: 
+specification_version: 4
+summary: Opinionated helpers for making JSON calls with the http.rb gem
+test_files: []