async-rest 0.12.2 → 0.12.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5f56a13cf12e8adad0cd2dd491aadab9bbfc129c5a06fe4d64e53c7753bdf25e
-  data.tar.gz: f8541763a4eae2266c20ac0f721c99f518a67c4e3711b726a97cb46c4128fc07
+  metadata.gz: bc914b22fd6a8a19da71676f835e23a606b8c9e6ebd981f25b17b9452422a791
+  data.tar.gz: d639c6647805c99501b9849ee4ebdc3a1650279b93b5053f00af513cb75c2e6b
 SHA512:
-  metadata.gz: ce9f153981210054fe581d7dc64b06e699a3673aeccdb78a6cd6ed8edeb32aee754828b7736310072c0ada4eb03e4c35c2b1bf64ead4bde84480dc373f1fd27e
-  data.tar.gz: 3a9c2a90dc0e9f9e88523b2f91107c6cf33110f7cd250268eda088e1986f3e0331f24dcef6c27a219f6a8e57fd9b91840ffef176b22d6943ad4a8717baaef78c
+  metadata.gz: 2fe066c918388cd94e92ba167f0910fd189991abb14565172946f74f9d8af3f24f66c18cef586a0b41a87d19c036af08da227404954f5619c313b1273fe64025
+  data.tar.gz: fe5226f20eb31178830ff77f37df8d03c0d3f66c0edc098ed700fcf7f394fee9ba4452cca6190e21c153390915227df23d7e29017e506f9c18f7e19000be33f5

data/lib/async/rest/representation.rb

@@ -31,15 +31,15 @@ module Async
 		# A representation consists of data, metadata describing the data, and, on occasion, metadata to describe the metadata (usually for the purpose of verifying message integrity). Metadata is in the form of name-value pairs, where the name corresponds to a standard that defines the value's structure and semantics. Response messages may include both representation metadata and resource metadata: information about the resource that is not specific to the supplied representation.
 		class Representation
 			def self.[] wrapper
-				klass = Class.new(Representation)
+				klass = Class.new(self)
 				
 				klass.const_set(:WRAPPER, wrapper)
 				
 				return klass
 			end
 			
-			def self.for(*args, **options)
-				representation = self.new(Resource.for(*args), **options)
+			def self.for(*arguments, **options)
+				representation = self.new(Resource.for(*arguments), **options)
 				
 				return representation unless block_given?
 				
@@ -66,8 +66,12 @@ module Async
 				@value = value
 			end
 			
-			def with(klass = self.class, **options)
-				klass.new(@resource.with(**options), wrapper: @wrapper)
+			def with(klass = nil, **options)
+				if klass
+					klass.new(@resource.with(**options), wrapper: klass::WRAPPER.new)
+				else
+					self.new(@resource.with(**options), wrapper: @wrapper)
+				end
 			end
 			
 			def [] **parameters

data/lib/async/rest/resource.rb

@@ -1,5 +1,3 @@
-# frozen_string_literal: true
-
 # Copyright, 2018, by Samuel G. D. Williams. <http://www.codeotaku.com>
 # 
 # Permission is hereby granted, free of charge, to any person obtaining a copy
@@ -48,7 +46,7 @@ module Async
 				return ::Protocol::HTTP::AcceptEncoding.new(HTTP::Client.new(endpoint)), reference
 			end
 			
-			def self.for(endpoint, *args)
+			def self.for(endpoint, *arguments)
 				# TODO This behaviour is deprecated and will probably be removed.
 				if endpoint.is_a? String
 					endpoint = HTTP::Endpoint.parse(endpoint)
@@ -56,7 +54,7 @@ module Async
 				
 				client, reference = connect(endpoint)
 				
-				resource = self.new(client, reference, *args)
+				resource = self.new(client, reference, *arguments)
 				
 				return resource unless block_given?
 				
@@ -72,14 +70,14 @@ module Async
 			attr :reference
 			attr :headers
 			
-			def self.with(parent, *args, headers: {}, **options)
+			def self.with(parent, *arguments, headers: {}, **options)
 				reference = parent.reference.with(**options)
 				
-				self.new(*args, parent.delegate, reference, parent.headers.merge(headers))
+				self.new(*arguments, parent.delegate, reference, parent.headers.merge(headers))
 			end
 			
-			def with(*args, **options)
-				self.class.with(self, *args, **options)
+			def with(*arguments, **options)
+				self.class.with(self, *arguments, **options)
 			end
 			
 			def get(klass = Representation, **parameters)

data/lib/async/rest/version.rb

@@ -22,6 +22,6 @@
 
 module Async
 	module REST
-		VERSION = "0.12.2"
+		VERSION = "0.12.3"
 	end
 end

data/lib/async/rest/wrapper/json.rb

@@ -40,7 +40,7 @@ module Async
 				
 				attr :content_type
 				
-				def split(*args)
+				def split(*arguments)
 					@content_type.split
 				end
 				

data/lib/async/rest/wrapper/url_encoded.rb

@@ -39,7 +39,7 @@ module Async
 				
 				attr :content_type
 				
-				def split(*args)
+				def split(*arguments)
 					@content_type.split
 				end
 				

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: async-rest
 version: !ruby/object:Gem::Version
-  version: 0.12.2
+  version: 0.12.3
 platform: ruby
 authors:
 - Samuel Williams
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-02-01 00:00:00.000000000 Z
+date: 2021-05-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: async-http
@@ -53,7 +53,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '1.1'
 - !ruby/object:Gem::Dependency
-  name: covered
+  name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -67,7 +67,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: bundler
+  name: covered
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -81,51 +81,39 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: rspec
+  name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '3.6'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '3.6'
+        version: '0'
 - !ruby/object:Gem::Dependency
-  name: rake
+  name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '3.6'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
-description: 
+        version: '3.6'
+description:
 email:
-- samuel.williams@oriontransfer.co.nz
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".editorconfig"
-- ".gitignore"
-- ".rspec"
-- ".travis.yml"
-- Gemfile
-- README.md
-- Rakefile
-- async-rest.gemspec
-- examples/github/feed.rb
-- examples/slack/clean.rb
-- examples/xkcd/comic.rb
 - lib/async/rest.rb
 - lib/async/rest/error.rb
 - lib/async/rest/representation.rb
@@ -139,7 +127,7 @@ homepage: https://github.com/socketry/async-rest
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -154,8 +142,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.6
-signing_key: 
+rubygems_version: 3.3.0.dev
+signing_key:
 specification_version: 4
 summary: A library for RESTful clients (and hopefully servers).
 test_files: []

data/.editorconfig

@@ -1,6 +0,0 @@
-root = true
-
-[*]
-indent_style = tab
-indent_size = 2
-

data/.gitignore

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

data/.rspec

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

data/.travis.yml

@@ -1,20 +0,0 @@
-language: ruby
-dist: xenial
-cache: bundler
-
-matrix:
-  include:
-    - rvm: 2.4
-    - rvm: 2.5
-    - rvm: 2.6
-    - rvm: 2.7
-    - rvm: 2.6
-      env: COVERAGE=PartialSummary,Coveralls
-    - rvm: jruby-head
-      env: JRUBY_OPTS="--debug -X+O"
-    - rvm: truffleruby
-    - rvm: ruby-head
-  allow_failures:
-    - rvm: truffleruby
-    - rvm: ruby-head
-    - rvm: jruby-head

data/Gemfile

@@ -1,10 +0,0 @@
-# frozen_string_literal: true
-
-source 'https://rubygems.org'
-
-# Specify your gem's dependencies in async-io.gemspec
-gemspec
-
-group :development do
-	gem 'pry'
-end

data/README.md

@@ -1,106 +0,0 @@
-# Async::REST
-
-Roy Thomas Fielding's thesis [Architectural Styles and the Design of Network-based Software Architectures](https://www.ics.uci.edu/~fielding/pubs/dissertation/top.htm) describes [Representational State Transfer](https://www.ics.uci.edu/~fielding/pubs/dissertation/rest_arch_style.htm) which comprises several core concepts:
-
-- `Resource`: A conceptual mapping to one or more entities.
-- `Representation`: An instance of a resource at a given point in time.
-
-This gem models these abstractions as closely and practically as possible and serves as a basis for building asynchronous web clients.
-
-[![Build Status](https://travis-ci.com/socketry/async-rest.svg?branch=master)](https://travis-ci.com/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
-
-Generally speaking, you want to create a representation class for each remote resource. This class is responsible for negotiating content type and processing the response, and traversing related resources.
-
-### DNS over HTTP
-
-This simple example shows how to use a custom representation to access DNS over HTTP.
-
-```ruby
-require 'async/http/server'
-require 'async/http/endpoint'
-
-require 'async/rest/resource'
-require 'async/rest/representation'
-
-module DNS
-	class Query < Async::REST::Representation
-		def initialize(*args)
-			# This is the old/weird content-type used by Google's DNS resolver. It's obsolete.
-			super(*args, wrapper: Async::REST::Wrapper::JSON.new("application/x-javascript"))
-		end
-		
-		def question
-			value[:Question]
-		end
-		
-		def answer
-			value[:Answer]
-		end
-	end
-end
-
-URL = 'https://dns.google.com/resolve'
-Async::REST::Resource.for(URL) do |resource|
-	# Specify the representation class as the first argument (client side negotiation):
-	query = resource.get(DNS::Query, name: 'example.com', type: 'AAAA')
-
-	pp query.metadata
-	pp query.value
-end
-```
-
-## 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

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

data/async-rest.gemspec

@@ -1,29 +0,0 @@
-# coding: utf-8
-require_relative 'lib/async/rest/version'
-
-Gem::Specification.new do |spec|
-	spec.name          = "async-rest"
-	spec.version       = Async::REST::VERSION
-	spec.licenses      = ["MIT"]
-	spec.authors       = ["Samuel Williams"]
-	spec.email         = ["samuel.williams@oriontransfer.co.nz"]
-
-	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|
-		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.42"
-	spec.add_dependency "protocol-http", "~> 0.7"
-	
-	spec.add_development_dependency "async-rspec", "~> 1.1"
-	
-	spec.add_development_dependency "covered"
-	spec.add_development_dependency "bundler"
-	spec.add_development_dependency "rspec", "~> 3.6"
-	spec.add_development_dependency "rake"
-end

data/examples/github/feed.rb

@@ -1,112 +0,0 @@
-#!/usr/bin/env ruby
-# frozen_string_literal: true
-
-require 'async'
-require 'async/rest'
-require 'async/rest/wrapper/form'
-
-require 'date'
-
-URL = "https://api.github.com"
-ENDPOINT = Async::HTTP::Endpoint.parse(URL)
-
-module GitHub
-	class Wrapper < Async::REST::Wrapper::Form
-		DEFAULT_CONTENT_TYPES = {
-			"application/vnd.github.v3+json" => Async::REST::Wrapper::JSON::Parser
-		}
-		
-		def initialize
-			super(DEFAULT_CONTENT_TYPES)
-		end
-		
-		def parser_for(response)
-			if content_type = response.headers['content-type']
-				if content_type.start_with? "application/json"
-					return Async::REST::Wrapper::JSON::Parser
-				end
-			end
-			
-			return super
-		end
-	end
-	
-	class Representation < Async::REST::Representation[Wrapper]
-	end
-	
-	class User < Representation
-	end
-	
-	class Client < Representation
-		def user(name)
-			self.with(User, path: "users/#{name}")
-		end
-	end
-	
-	module Paginate
-		include Enumerable
-		
-		def represent(metadata, attributes)
-			resource = @resource.with(path: attributes[:id])
-			
-			representation.new(resource, metadata: metadata, value: attributes)
-		end
-		
-		def each(page: 1, per_page: 50, **parameters)
-			return to_enum(:each, page: page, per_page: per_page, **parameters) unless block_given?
-			
-			while true
-				items = @resource.get(self.class, page: page, per_page: per_page, **parameters)
-				
-				break if items.empty?
-				
-				Array(items.value).each do |item|
-					yield represent(items.metadata, item)
-				end
-				
-				page += 1
-				
-				# Was this the last page?
-				break if items.value.size < per_page
-			end
-		end
-		
-		def empty?
-			self.value.empty?
-		end
-	end
-	
-	class Event < Representation
-		def created_at
-			DateTime.parse(value[:created_at])
-		end
-	end
-	
-	class Events < Representation
-		include Paginate
-		
-		def representation
-			Event
-		end
-	end
-	
-	class User < Representation
-		def public_events
-			self.with(Events, path: "events/public")
-		end
-	end
-end
-
-puts "Connecting..."
-headers = Protocol::HTTP::Headers.new
-headers['user-agent'] = "async-rest/GitHub v#{Async::REST::VERSION}"
-
-GitHub::Client.for(ENDPOINT, headers) do |client|
-	user = client.user("ioquatix")
-	
-	events = user.public_events.to_a
-	pp events.first.created_at
-	pp events.last.created_at
-end
-
-puts "done"

data/examples/slack/clean.rb

@@ -1,57 +0,0 @@
-#!/usr/bin/env ruby
-# frozen_string_literal: true
-
-require 'pry'
-require 'set'
-
-def rate_limited?(response)
-	pp response
-	
-	response[:error] == "ratelimited"
-end
-
-require 'async/rest'
-
-URL = "https://slack.com/api"
-TOKEN = "xoxp-your-api-token"
-
-Async::REST::Resource.for(URL) do |resource|
-	authenticated = resource.with(parameters: {token: TOKEN})
-	delete = authenticated.with(path: "chat.delete")
-	
-	page = 1
-	while true
-		search = authenticated.with(path: "search.messages", parameters: {page: page, count: 100, query: "from:@username before:2019-02-15"})
-		representation = search.get
-		
-		messages = representation.value[:messages]
-		matches = messages[:matches]
-		
-		puts "Found #{matches.size} messages on page #{page} out of #{messages[:total]}..."
-		
-		break if matches.empty?
-		
-		matches.each do |message|
-			text = message[:text]
-			channel_id = message[:channel][:id]
-			channel_name = message[:channel][:name]
-			timestamp = message[:ts]
-		
-			pp [timestamp, channel_name, text]
-		
-			message_delete = Async::REST::Representation.new(
-				delete.with(parameters: {channel: channel_id, ts: timestamp})
-			)
-		
-			response = message_delete.post
-			if rate_limited?(response.read)
-				puts "Rate limiting..."
-				Async::Task.current.sleep 10
-			end
-		end
-		
-		page += 1
-	end
-end
-
-puts "Done"

data/examples/xkcd/comic.rb

@@ -1,65 +0,0 @@
-#!/usr/bin/env ruby
-# frozen_string_literal: true
-
-require_relative '../../lib/async/rest'
-require_relative '../../lib/async/rest/wrapper/url_encoded'
-
-require 'nokogiri'
-
-Async.logger.debug!
-
-module XKCD
-	module Wrapper
-		# This defines how we interact with the XKCD service.
-		class HTML < Async::REST::Wrapper::URLEncoded
-			TEXT_HTML = "text/html"
-			
-			# How to process the response body.
-			class Parser < ::Protocol::HTTP::Body::Wrapper
-				def join
-					Nokogiri::HTML(super)
-				end
-			end
-			
-			# We wrap the response body with the parser (it could incrementally parse the body).
-			def wrap_response(response)
-				if body = response.body
-					response.body = Parser.new(body)
-				end
-			end
-			
-			def process_response(request, response)
-				if content_type = response.headers['content-type']
-					if content_type.start_with? TEXT_HTML
-						wrap_response(response)
-					else
-						raise Error, "Unknown content type: #{content_type}!"
-					end
-				end
-				
-				return response
-			end
-		end
-	end
-	
-	# A comic representation.
-	class Comic < Async::REST::Representation[Wrapper::HTML]
-		def image_url
-			self.value.css("#comic img").attribute("src").text
-		end
-	end
-end
-
-Async do
-	URL = 'https://xkcd.com/'
-	
-	Async::REST::Resource.for(URL) do |resource|
-		(2000..2010).each do |id|
-			Async do
-				representation = resource.with(path: "/#{id}/").get(XKCD::Comic)
-				
-				p representation.image_url
-			end
-		end
-	end
-end