async-rest 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ce0c7cbe77ef56cba58f5cd57ad1486a9cf9040d70fea765c6300f51e5590ddb
-  data.tar.gz: 167cf326a9f2195cc0482bd7223cfa62a0ea9bdabce42a20076801bbc72ff9ef
+  metadata.gz: 839be8ad4eee0471cff7053c05692ae11178f8ab934c2485c61c09b67cca6cf0
+  data.tar.gz: af6e5721af9c1585fcd03c3e95d886ad639b71b789972ac630ed62c4c7c9c264
 SHA512:
-  metadata.gz: 6cc434bcd3df1f0c4659e189e2d710650bad4a4a954f483173228d6678fda02d97f95391f1c29bcd3b5610ac318464213570d3febb0a0eb560a58028a9ed0b3a
-  data.tar.gz: e231949363b899e5cc5d7739c8a7dcab667e46fd2a4bea91f766cb7c1683d9c27379049e565b4f7016fa5b0149aa92250f96bcf25b792e976e7a2af2ab6dcc50
+  metadata.gz: 32ff875407f491ddf920a8ebe437ca91d7fc2d6bdaa343c61b40aa292a0ca380c7414c146ec16ce3d4125627eb8f21cf21f920ab110d9c23a32fc7c4a9d5e4bf
+  data.tar.gz: 29a11597c7af0851afeb8eef0d053abe854451e4e0c9d3dc41c10f8ea1b36d20a22bcf7261d676d3a1d3a9ef24476133e46e153d8f826a3b7ef134896e0d5b80

data/.travis.yml

@@ -10,6 +10,7 @@ matrix:
     - rvm: 2.3
     - rvm: 2.4
     - rvm: 2.5
+    - rvm: 2.6
     - rvm: jruby-head
       env: JRUBY_OPTS="--debug -X+O"
     - rvm: ruby-head

data/Gemfile

@@ -8,6 +8,5 @@ group :development do
 end
 
 group :test do
-	gem 'simplecov'
-	gem 'coveralls', require: false
+	gem 'covered', require: 'covered/rspec' if RUBY_VERSION >= "2.6.0"
 end

data/async-rest.gemspec

@@ -7,7 +7,7 @@ Gem::Specification.new do |spec|
 	spec.authors       = ["Samuel Williams"]
 	spec.email         = ["samuel.williams@oriontransfer.co.nz"]
 
-	spec.summary       = "A library for RESTful clients and servers."
+	spec.summary       = "A library for RESTful clients (and hopefully servers)."
 	spec.homepage      = "https://github.com/socketry/async-rest"
 
 	spec.files         = `git ls-files -z`.split("\x0").reject do |f|
@@ -16,7 +16,7 @@ Gem::Specification.new do |spec|
 	spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
 	spec.require_paths = ["lib"]
 	
-	spec.add_dependency("async-http", "~> 0.18.0")
+	spec.add_dependency "async-http", "~> 0.27.12"
 	
 	spec.add_development_dependency "async-rspec", "~> 1.1"
 	

data/lib/async/rest.rb

@@ -18,4 +18,6 @@
 # OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 # THE SOFTWARE.
 
-require "async/rest/version"
+require_relative 'rest/version'
+require_relative 'rest/reference'
+require_relative 'rest/resource'

data/lib/async/rest/resource.rb

@@ -18,37 +18,36 @@
 # OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 # THE SOFTWARE.
 
-require_relative 'reference'
-require_relative 'json_body'
+require_relative 'wrapper/json'
 
 require 'async/http/client'
+require 'async/http/accept_encoding'
+require 'async/http/reference'
 require 'async/http/url_endpoint'
 
 module Async
 	module REST
-		class Resource
-			DEFAULT_HEADERS = {
-				'accept-encoding' => 'gzip',
-				'accept' => 'application/json;q=0.9, */*;q=0.8'
-			}
-			
-			def initialize(client, reference = Reference.parse, headers = DEFAULT_HEADERS, max_redirects: 10)
-				@client = client
+		class Resource < HTTP::Middleware
+			def initialize(client, reference = HTTP::Reference.parse, headers = HTTP::Headers.new, wrapper = Wrapper::JSON.new)
+				super(client)
+				
 				@reference = reference
 				@headers = headers
-				
-				@max_redirects = max_redirects
+				@wrapper = wrapper
 			end
 			
-			def close
-				@client.close
+			def self.connect(url)
+				endpoint = HTTP::URLEndpoint.parse(url)
+				
+				reference = HTTP::Reference.parse(endpoint.url.request_uri)
+				
+				return HTTP::AcceptEncoding.new(HTTP::Client.new(endpoint)), reference
 			end
 			
-			def self.for(url, headers = {}, **options)
-				endpoint = HTTP::URLEndpoint.parse(url)
-				client = HTTP::Client.new(endpoint)
+			def self.for(url, *args)
+				client, reference = connect(url)
 				
-				resource = self.new(client, Reference.parse(endpoint.url.request_uri), headers)
+				resource = self.new(client, reference, *args)
 				
 				return resource unless block_given?
 				
@@ -63,76 +62,35 @@ module Async
 			attr :reference
 			attr :headers
 			
-			attr :max_redirects
-			
-			def [] path
-				self.class.new(@client, @reference.nest(path), @headers, max_redirects: @max_redirects)
+			def self.nest(parent, path = nil, *args)
+				self.new(*args, parent.client, parent.reference.dup(path), parent.headers, parent.wrapper)
 			end
 			
 			def with(**headers)
-				self.class.new(@client, @reference, @headers.merge(headers), max_redirects: @max_redirects)
-			end
-			
-			def wrapper_for(content_type)
-				if content_type == 'application/json'
-					return JSONBody
-				end
+				self.class.new(@client, @reference, @headers.merge(headers), @wrapper)
 			end
 			
-			def prepare_body(payload)
-				return [] if payload.nil?
+			def prepare_request(verb, payload = nil, headers = nil, **parameters)
+				headers ||= @headers.dup
+				reference = @reference.dup(nil, parameters)
+				body = @wrapper.prepare_request(payload, headers)
 				
-				content_type = @headers['content-type']
-				
-				if wrapper = wrapper_for(content_type)
-					return wrapper.dump(payload)
-				else
-					raise ArgumentError.new("Unsure how to convert payload to #{content_type}!")
-				end
+				return HTTP::Request[verb, reference, headers, body]
 			end
 			
 			def process_response(response)
-				response.body = HTTP::InflateBody.for_response(response)
-				
-				content_type = response.headers['content-type']
-				
-				if wrapper = wrapper_for(content_type)
-					response.body = wrapper.new(response.body)
-				end
-				
-				return response
+				@wrapper.process_response(response)
 			end
 			
-			HTTP::Client::VERBS.each do |verb|
-				define_method(verb.downcase) do |payload = nil, **parameters, &block|
-					reference = @reference.dup(nil, parameters)
+			HTTP::VERBS.each do |verb|
+				define_method(verb.downcase) do |*args|
+					request = prepare_request(verb, *args)
 					
-					if body = prepare_body(payload)
-						body = HTTP::DeflateBody.for_request(@headers, body)
-					end
+					response = self.call(request)
 					
-					response = self.request(verb, reference.to_str, @headers, body) do |response|
-						process_response(response)
-					end
-					
-					return response
+					process_response(response)
 				end
 			end
-			
-			def request(verb, location, *args)
-				@max_redirects.times do
-					@client.request(verb, location, *args) do |response|
-						if response.redirection?
-							verb = 'GET' unless response.preserve_method?
-							location = response.headers['location']
-						else
-							return yield response
-						end
-					end
-				end
-				
-				raise ArgumentError.new("Too many redirections!")
-			end
 		end
 	end
 end

data/lib/async/rest/version.rb

@@ -20,6 +20,6 @@
 
 module Async
 	module REST
-		VERSION = "0.2.0"
+		VERSION = "0.3.0"
 	end
 end

data/lib/async/rest/{json_body.rb → wrapper/json.rb}

@@ -22,27 +22,45 @@ require 'json'
 
 module Async
 	module REST
-		class JSONBody
-			def initialize(body)
-				@body = body
-			end
-			
-			def close
-				@body = @body.close
+		module Wrapper
+			class JSON
+				CONTENT_TYPE = "application/json".freeze
 				
-				return self
-			end
-			
-			def join
-				JSON.parse(@body.join, symbolize_names: true)
-			end
-			
-			def self.dump(payload)
-				JSON.dump(payload)
-			end
-			
-			def finished?
-				@body.finished?
+				def initialize(content_type = CONTENT_TYPE)
+					@content_type = content_type
+				end
+				
+				def split(*args)
+					@content_type.split
+				end
+				
+				def prepare_request(payload, headers)
+					headers['accept'] ||= @content_type
+					
+					if payload
+						headers['content-type'] = @content_type
+						
+						HTTP::Body::Buffered.new([
+							::JSON.dump(payload)
+						])
+					end
+				end
+				
+				def process_response(response)
+					# We expect all responses to be valid JSON.
+					# I tried inspecting content-type, but too many servers do the wrong thing.
+					if body = response.body
+						response.body = Parser.new(body)
+					end
+					
+					return response
+				end
+				
+				class Parser < HTTP::Body::Wrapper
+					def join
+						::JSON.parse(super, symbolize_names: true)
+					end
+				end
 			end
 		end
 	end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: async-rest
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Samuel Williams
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-04-14 00:00:00.000000000 Z
+date: 2018-07-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: async-http
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.18.0
+        version: 0.27.12
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.18.0
+        version: 0.27.12
 - !ruby/object:Gem::Dependency
   name: async-rspec
   requirement: !ruby/object:Gem::Requirement
@@ -95,10 +95,9 @@ files:
 - Rakefile
 - async-rest.gemspec
 - lib/async/rest.rb
-- lib/async/rest/json_body.rb
-- lib/async/rest/reference.rb
 - lib/async/rest/resource.rb
 - lib/async/rest/version.rb
+- lib/async/rest/wrapper/json.rb
 homepage: https://github.com/socketry/async-rest
 licenses: []
 metadata: {}
@@ -121,5 +120,5 @@ rubyforge_project:
 rubygems_version: 2.7.6
 signing_key: 
 specification_version: 4
-summary: A library for RESTful clients and servers.
+summary: A library for RESTful clients (and hopefully servers).
 test_files: []

data/lib/async/rest/reference.rb

@@ -1,139 +0,0 @@
-# Copyright, 2018, by Samuel G. D. Williams. <http://www.codeotaku.com>
-# 
-# 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.
-
-module Async
-	module REST
-		# A relative reference, excluding any authority.
-		class Reference
-			def initialize(path, query_string, fragment, parameters)
-				@path = path
-				@query_string = query_string
-				@fragment = fragment
-				@parameters = parameters
-			end
-			
-			# Generate a reference from a path and user parameters. The path may contain a `#fragment` or `?query=parameters`.
-			def self.parse(path = '/', parameters = nil)
-				base, fragment = path.split('#', 2)
-				path, query_string = base.split('?', 2)
-				
-				self.new(path, query_string, fragment, parameters)
-			end
-			
-			# The path component, e.g. /foo/bar/index.html
-			attr :path
-			
-			# The un-parsed query string, e.g. 'x=10&y=20'
-			attr :query_string
-			
-			# A fragment, the part after the '#'
-			attr :fragment
-			
-			# User supplied parameters that will be appended to the query part.
-			attr :parameters
-			
-			def append(buffer)
-				if @query_string
-					buffer << escape_path(@path) << '?' << query_string
-					buffer << '&' << encode(@parameters) if @parameters
-				else
-					buffer << escape_path(@path)
-					buffer << '?' << encode(@parameters) if @parameters
-				end
-				
-				if @fragment
-					buffer << '#' << escape(@fragment)
-				end
-				
-				return buffer
-			end
-			
-			def to_str
-				append(String.new)
-			end
-			
-			alias to_s to_str
-			
-			def + path
-				self.dup(path)
-			end
-			
-			def [] parameters
-				self.dup(nil, parameters)
-			end
-			
-			def dup(path = nil, parameters = nil)
-				if parameters and @parameters
-					parameters = @parameters.merge(parameters)
-				else
-					parameters = @parameters
-				end
-				
-				if path
-					path = @path + '/' + path
-				else
-					path = @path
-				end
-				
-				self.class.new(path, @query_string, @fragment, parameters)
-			end
-			
-			private
-			
-			# Escapes a generic string, using percent encoding.
-			def escape(string)
-				encoding = string.encoding
-				string.b.gsub(/([^a-zA-Z0-9_.\-]+)/) do |m|
-					'%' + m.unpack('H2' * m.bytesize).join('%').upcase
-				end.force_encoding(encoding)
-			end
-			
-			# According to https://tools.ietf.org/html/rfc3986#section-3.3, we escape non-pchar.
-			NON_PCHAR = /([^a-zA-Z0-9_\-\.~!$&'()*+,;=:@\/]+)/.freeze
-			
-			# Escapes a path
-			def escape_path(path)
-				encoding = path.encoding
-				path.b.gsub(NON_PCHAR) do |m|
-					'%' + m.unpack('H2' * m.bytesize).join('%').upcase
-				end.force_encoding(encoding)
-			end
-			
-			# Encodes a hash or array into a query string
-			def encode(value, prefix = nil)
-				case value
-				when Array
-					value.map { |v|
-						encode(v, "#{prefix}[]")
-					}.join("&")
-				when Hash
-					value.map { |k, v|
-						encode(v, prefix ? "#{prefix}[#{escape(k.to_s)}]" : escape(k.to_s))
-					}.reject(&:empty?).join('&')
-				when nil
-					prefix
-				else
-					raise ArgumentError, "value must be a Hash" if prefix.nil?
-					"#{prefix}=#{escape(value.to_s)}"
-				end
-			end
-		end
-	end
-end