async-rest 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 980a446f72bdda0d1c784191fcb21212584d96bd7ea7f677559789d2dc982668
+  data.tar.gz: edfd0ce4873aea371c007a40ab982aa677f891f199ddf14f9fe0a75f8853668b
+SHA512:
+  metadata.gz: 3c34905a2dc51ddf5068adb1107b04c7c7e43c4530d6fac4469c888610303921677346eeccfe5d772d3647343c7b04494fa698ef5cff4ddb460bf0c7c9b97f50
+  data.tar.gz: 3647e473eb28edc8f229b5be613e0a068496ac704e617159afd34103405015214df2687a93752f62ef4bfde9b7f970f3fbf57b92d5ca21756220f4f6e500d383

data/.gitignore

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

data/.rspec

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

data/.travis.yml

@@ -0,0 +1,20 @@
+language: ruby
+cache: bundler
+
+before_script:
+  - gem update --system
+  - gem install bundler
+
+matrix:
+  include:
+    - rvm: 2.3
+    - rvm: 2.4
+    - rvm: 2.5
+    - rvm: jruby-head
+      env: JRUBY_OPTS="--debug -X+O"
+    - rvm: ruby-head
+    - rvm: rbx-3
+  allow_failures:
+    - rvm: ruby-head
+    - rvm: jruby-head
+    - rvm: rbx-3

data/Gemfile

@@ -0,0 +1,13 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in async-io.gemspec
+gemspec
+
+group :development do
+	gem 'pry'
+end
+
+group :test do
+	gem 'simplecov'
+	gem 'coveralls', require: false
+end

data/README.md

@@ -0,0 +1,63 @@
+# Async::REST
+
+An asynchronous client and server implementation of RESTful interfaces.
+
+[![Build Status](https://secure.travis-ci.org/socketry/async-rest.svg)](http://travis-ci.org/socketry/async-rest)
+[![Code Climate](https://codeclimate.com/github/socketry/async-rest.svg)](https://codeclimate.com/github/socketry/async-rest)
+[![Coverage Status](https://coveralls.io/repos/socketry/async-rest/badge.svg)](https://coveralls.io/r/socketry/async-rest)
+
+[async]: https://github.com/socketry/async
+[async-io]: https://github.com/socketry/async-io
+[falcon]: https://github.com/socketry/falcon
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'async-rest'
+```
+
+And then execute:
+
+	$ bundle
+
+Or install it yourself as:
+
+	$ gem install async-rest
+
+## Usage
+
+...
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request
+
+## License
+
+Released under the MIT license.
+
+Copyright, 2015, by [Samuel G. D. Williams](http://www.codeotaku.com/samuel-williams).
+
+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/Rakefile

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

data/async-rest.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+require_relative 'lib/async/rest/version'
+
+Gem::Specification.new do |spec|
+	spec.name          = "async-rest"
+	spec.version       = Async::REST::VERSION
+	spec.authors       = ["Samuel Williams"]
+	spec.email         = ["samuel.williams@oriontransfer.co.nz"]
+
+	spec.summary       = "A library for RESTful clients and servers."
+	spec.homepage      = "https://github.com/socketry/async-rest"
+
+	spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+		f.match(%r{^(test|spec|features)/})
+	end
+	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_development_dependency "async-rspec", "~> 1.1"
+	
+	spec.add_development_dependency "bundler", "~> 1.3"
+	spec.add_development_dependency "rspec", "~> 3.6"
+	spec.add_development_dependency "rake"
+end

data/lib/async/rest/reference.rb

@@ -0,0 +1,141 @@
+# Copyright, 2017, 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 << '&' << query_parameters if @parameters
+				else
+					buffer << escape_path(@path)
+					buffer << '?' << query_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
+			
+			# According to https://tools.ietf.org/html/rfc3986#section-3.3, we escape non-pchar.
+			NON_PCHAR = /([^a-zA-Z0-9_\-\.~!$&'()*+,;=:@\/]+)/.freeze
+			
+			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
+			
+			# 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
+			
+			def query_parameters
+				build_nested_query(@parameters)
+			end
+			
+			def build_nested_query(value, prefix = nil)
+				case value
+				when Array
+					value.map { |v|
+						build_nested_query(v, "#{prefix}[]")
+					}.join("&")
+				when Hash
+					value.map { |k, v|
+						build_nested_query(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

data/lib/async/rest/resource.rb

@@ -0,0 +1,125 @@
+# Copyright, 2017, 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.
+
+require_relative 'reference'
+
+require 'async/http/client'
+require 'json'
+
+module Async
+	module REST
+		class JSONBody
+			def initialize(body)
+				@body = body
+			end
+			
+			def close
+				@body = @body.close
+				
+				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?
+			end
+		end
+		
+		class Resource
+			def initialize(client, reference = Reference.parse, headers = {}, max_redirects: 10)
+				@client = client
+				@reference = reference
+				@headers = headers
+				
+				@max_redirects = max_redirects
+			end
+			
+			def [] path
+				self.class.new(@client, @reference.nest(path), @headers, max_redirects: @max_redirects)
+			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
+			end
+			
+			def prepare_body(payload)
+				return [] if payload.nil?
+				
+				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
+			end
+			
+			def process_response(response)
+				content_type = response.headers['content-type']
+				
+				if wrapper = wrapper_for(content_type)
+					response.body = wrapper.new(response.body)
+				end
+				
+				return response
+			end
+			
+			HTTP::Client::VERBS.each do |verb|
+				define_method(verb.downcase) do |payload = nil, **parameters, &block|
+					reference = @reference.dup(nil, parameters)
+					
+					response = self.request(verb, reference.to_str, @headers, prepare_body(payload)) do |response|
+						process_response(response)
+					end
+					
+					return 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

@@ -0,0 +1,25 @@
+# Copyright, 2017, 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
+		VERSION = "0.1.0"
+	end
+end

data/lib/async/rest.rb

@@ -0,0 +1,21 @@
+# Copyright, 2017, 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.
+
+require "async/rest/version"

metadata

@@ -0,0 +1,124 @@
+--- !ruby/object:Gem::Specification
+name: async-rest
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Samuel Williams
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2018-04-13 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: async-http
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.18.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.18.0
+- !ruby/object:Gem::Dependency
+  name: async-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.6'
+- !ruby/object:Gem::Dependency
+  name: rake
+  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'
+description: 
+email:
+- samuel.williams@oriontransfer.co.nz
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- README.md
+- Rakefile
+- async-rest.gemspec
+- lib/async/rest.rb
+- lib/async/rest/reference.rb
+- lib/async/rest/resource.rb
+- lib/async/rest/version.rb
+homepage: https://github.com/socketry/async-rest
+licenses: []
+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.6
+signing_key: 
+specification_version: 4
+summary: A library for RESTful clients and servers.
+test_files: []