thtp 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: f17bdb7ed51a45d7e5dc775bd2cedd63b61aab9b8f4bcd8d23a8df04b4d4efc5
+  data.tar.gz: a6ae6b43a98aaa113eba27f9fbcfd4c6d90f94a729ef55b310dc40bb5e599094
+SHA512:
+  metadata.gz: fccd24ae3db0e6628905d07d4a1b1f707ab571e0cc2b31ba156036ed8e0f411c9655b85d338ff3c6dc39cf1781032ffe2b718f0732b3c8b000bec8debc20476b
+  data.tar.gz: ab7ba5e703ca28e490dbdfa1b62dd9fa9dbe453ee39a6794711107ef5bb0b768f397a16f577f6bbde3288e826f4af8f0a7f3d857df4531666370e771b309a250

data/.gitignore

@@ -0,0 +1,14 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+/Gemfile.lock
+
+.rspec_status
+
+*.gem

data/.rspec

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

data/.rubocop.yml

@@ -0,0 +1,190 @@
+AllCops:
+  TargetRubyVersion: 2.5
+  DisplayCopNames: true
+  UseCache: true
+  CacheRootDirectory: ./tmp/cache
+
+# This is unnecessary since there are already other ways of measuring method
+# size/complexity.
+AbcSize:
+  Enabled: false
+
+AccessModifierIndentation:
+  Enabled: true
+  EnforcedStyle: indent
+
+# This lint prohibits method names starting with `get_`, which is often good
+# advice but wrong too often to be worthwhile.
+AccessorMethodName:
+  Enabled: false
+
+# Allow developers to pass regexes as arguments without enclosing parens, e.g.
+#   response.body.should match /some regex/
+AmbiguousRegexpLiteral:
+  Enabled: false
+
+# Allow the case equality ("threequals") operator, which is often useful,
+# especially for working with RSpec.
+CaseEquality:
+  Enabled: false
+
+ClassLength:
+  Severity: warning
+
+# Don't require use of `collect` over `map`
+CollectionMethods:
+  Enabled: false
+
+CommentAnnotation:
+  Enabled: false
+
+CyclomaticComplexity:
+  Severity: warning
+
+Debugger:
+  Severity: error # binding.pry blocks!
+
+DoubleNegation:
+  Enabled: false
+
+FirstParameterIndentation:
+  Enabled: false
+
+# Don't enforce using if/unless modifiers when you have a single-line body.
+IfUnlessModifier:
+  Enabled: false
+
+# We want to allow multi-line lambdas using the `->` syntax which Rubocop
+# doesn't allow. We're also not too worried about people using `lambda` for
+# single-line lambdas either.
+Lambda:
+  Enabled: false
+
+LineLength:
+  Max: 100
+  IgnoredPatterns:
+    - '\A#' # Allow longer comments
+
+# There are a number of places where it makes sense to chain do...end blocks
+MethodCalledOnDoEndBlock:
+  Enabled: false
+
+MethodLength:
+  Severity: warning
+  Max: 30
+
+Metrics/ModuleLength:
+  Severity: warning
+
+Metrics/BlockLength:
+  Severity: warning
+  Exclude:
+    - spec/**/*
+
+# Because we sometimes use RSpec's implicit subject syntax, we need to be able
+# to format blocks more flexibly than in the main codebase.
+MultilineBlockLayout:
+  Exclude:
+    - spec/**/*
+
+ParameterLists:
+  CountKeywordArgs: false
+
+PerceivedComplexity:
+  Severity: warning
+
+# Prefer curly braces except for %i/%w/%W, since those return arrays.
+PercentLiteralDelimiters:
+  PreferredDelimiters:
+    '%': '{}'
+    '%i': '[]'
+    '%q': '{}'
+    '%Q': '{}'
+    '%r': '{}'
+    '%s': '()'
+    '%w': '[]'
+    '%W': '[]'
+    '%x': '{}'
+
+# Forcing the name of a predicate to `doctor?` makes it difficult to tell if it
+# is a "has-a" or a "is-a" predicate, so disable it.
+PredicateName:
+  Enabled: false
+
+ShadowingOuterLocalVariable:
+  Severity: error
+
+# Forcing the naming of arguments to `reduce` to be `|a, e|` isn't very useful.
+SingleLineBlockParams:
+  Enabled: false
+
+Layout/SpaceBeforeFirstArg:
+  AllowForAlignment: true
+
+# There's no reason to enforce only using ASCII in comments.
+Style/AsciiComments:
+  Enabled: false
+
+Style/ModuleFunction:
+  Enabled: false
+
+Layout/MultilineMethodCallIndentation:
+  EnforcedStyle: indented
+
+Layout/MultilineMethodCallBraceLayout:
+  Enabled: false
+
+Style/NumericLiterals:
+  Exclude:
+    - spec/**/*
+
+# Middlewares have to do this all the time
+Style/RescueStandardError:
+  Enabled: false
+
+# It doesn't seem like .zero? and .nonzero? are more readable than == 0
+Style/NumericPredicate:
+  Enabled: false
+
+Style/TrailingCommaInArrayLiteral:
+  EnforcedStyleForMultiline: comma
+
+Style/TrailingCommaInHashLiteral:
+  EnforcedStyleForMultiline: comma
+
+Style/TrailingCommaInArguments:
+  EnforcedStyleForMultiline: comma
+
+UnreachableCode:
+  Severity: error
+
+UnusedMethodArgument:
+  AllowUnusedKeywordArguments: true
+
+# Wastes CPU time, especially if the right-hand expression is expensive
+UselessAssignment:
+  Severity: error
+
+WhileUntilModifier:
+  Enabled: false
+
+# Two strings in an array is not indicative that the array is likely to have
+# elements added to it in the future, so up the minimum number of elements we
+# warn on to 3.
+WordArray:
+  MinSize: 3
+
+Layout/ClosingParenthesisIndentation:
+  Enabled: false
+
+Style/SpecialGlobalVars:
+  Enabled: false
+
+# Checks for frozen string comment, designed to help upgrade to Ruby 3.0 (where
+# frozen string literals will be default); disabled because we prefer calling `.freeze`
+# on our string literals rather than using a magic comment.
+Style/FrozenStringLiteralComment:
+  Enabled: false
+
+Layout/DotPosition:
+  EnforcedStyle: trailing

data/.travis.yml

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

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 Anuj Das
+
+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,39 @@
+# THTP
+
+Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/thtp`. To experiment with that code, run `bin/console` for an interactive prompt.
+
+TODO: Delete this and the text above, and describe your gem
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'thtp'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install thtp
+
+## Usage
+
+TODO: Write usage instructions here
+
+## 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/[USERNAME]/thtp.
+
+## 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,7 @@
+#!/usr/bin/env ruby
+
+require 'bundler/setup'
+require 'thtp'
+
+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/lib/thtp.rb

@@ -0,0 +1,10 @@
+require 'thtp/version'
+require 'thtp/client'
+require 'thtp/server'
+
+# THTP implements an alternative paradigm for Thrift-RPC services, using
+# HTTP/1.1 persistent connections to gain many of the same benefits of the
+# low-level Thrift-RPC socket protocol while benefitting from all the tooling
+# available for HTTP. Both server and client implementations are provided.
+module THTP
+end

data/lib/thtp/client.rb

@@ -0,0 +1,123 @@
+# frozen_string_literal: true
+
+require 'connection_pool'
+require 'patron'
+require 'thrift'
+
+require 'thtp/encoding'
+require 'thtp/errors'
+require 'thtp/middleware_stack'
+require 'thtp/status'
+require 'thtp/utils'
+
+require 'thtp/client/instrumentation'
+require 'thtp/client/middleware'
+
+module THTP
+  # A thrift-over-HTTP client library implementing persistent connections and
+  # extensibility via middlewares
+  class Client
+    include Utils
+
+    # RPC-over-HTTP protocol implementation and executor
+    class Dispatcher
+      include Utils
+
+      SUCCESS_FIELD = 'success' # the Thrift result field that's set if everything went fine
+
+      # @param service [Class] The Thrift service whose schema to use for de/serialisation
+      # @parma connection [ConnectionPool<Patron::Session>] The configured HTTP client pool
+      # @param protocol [Thrift::BaseProtocol] The default protocol with which to serialise
+      def initialize(service, connection, protocol)
+        @service = service
+        @connection = connection
+        @protocol = protocol
+        # define RPC proxy methods on this instance
+        extract_rpcs(service).each do |rpc|
+          define_singleton_method(rpc) { |*rpc_args| post_rpc(rpc, *rpc_args) }
+        end
+      end
+
+      private
+
+      def post_rpc(rpc, *args)
+        # send request over persistent HTTP connection
+        response = @connection.with { |c| c.post(rpc, write_call(rpc, args)) }
+        # interpret HTTP status code to determine message type and deserialise appropriately
+        protocol = Encoding.protocol(response.headers['Content-Type']) || @protocol
+        return read_reply(rpc, response.body, protocol) if response.status == Status::REPLY
+        return read_exception(response.body, protocol) if response.status == Status::EXCEPTION
+        # if the HTTP status code was unrecognised, report back
+        raise UnknownMessageType, rpc, response.status, response.body
+      rescue Patron::TimeoutError, Timeout::Error
+        raise RpcTimeoutError, rpc
+      rescue Patron::Error
+        raise ServerUnreachableError
+      end
+
+      def write_call(rpc, args)
+        # args are named methods, but RPC signatures use positional arguments;
+        # convert between the two using struct_fields, which is an ordered hash.
+        args_struct = args_class(@service, rpc).new
+        args_struct.struct_fields.values.zip(args).each do |field, val|
+          args_struct.public_send("#{field[:name]}=", val)
+        end
+        # serialise and return bytestring
+        serialize_buffer(args_struct, @protocol)
+      rescue Thrift::TypeError => e
+        raise ClientValidationError, e.message
+      end
+
+      def read_reply(rpc, reply, protocol)
+        # deserialise reply into result struct
+        result_struct = result_class(@service, rpc).new
+        deserialize_buffer(reply, result_struct, protocol)
+        # results have at most one field set; find it and return/raise it
+        result_struct.struct_fields.each_value do |field|
+          reply = result_struct.public_send(field[:name])
+          next if reply.nil? # this isn't the set field, keep looking
+          return reply if field[:name] == SUCCESS_FIELD # 'success' is special and means no worries
+          raise reply # any other set field must be an exception
+        end
+        # if no field is set and there's no `success` field, the RPC returned `void``
+        return nil unless result_struct.respond_to?(:success)
+        # otherwise, we don't recognise the response (our schema is out of date, or it's invalid)
+        raise BadResponseError, rpc
+      end
+
+      def read_exception(exception, protocol)
+        raise deserialize_buffer(exception, Thrift::ApplicationException.new, protocol)
+      end
+    end
+
+    ###
+
+    # @param service [Class] The Thrift service whose schema to use for de/serialisation
+    def initialize(service, protocol: Thrift::CompactProtocol,
+                   host: '0.0.0.0', port: nil, ssl: false,
+                   open_timeout: 1, rpc_timeout: 15,
+                   pool_size: 5, pool_timeout: 5)
+      uri_class = ssl ? URI::HTTPS : URI::HTTP
+      # set up HTTP connections in a thread-safe pool
+      connection = ConnectionPool.new(size: pool_size, timeout: pool_timeout) do
+        Patron::Session.new(
+          base_url: uri_class.build(host: host, port: port, path: "/#{canonical_name(service)}/"),
+          connect_timeout: open_timeout,
+          timeout: rpc_timeout,
+          headers: {
+            'Content-Type' => Encoding.content_type(protocol),
+            'User-Agent' => self.class.name,
+          },
+        )
+      end
+      # allow middleware insertion for purposes such as instrumentation or validation
+      @stack = MiddlewareStack.new(service, Dispatcher.new(service, connection, protocol))
+      extract_rpcs(service).each { |rpc| define_singleton_method(rpc, &@stack.method(rpc)) }
+    end
+
+    # delegate to RPC dispatcher stack
+    def use(middleware_class, *middleware_args)
+      @stack.use(middleware_class, *middleware_args)
+    end
+  end
+end