api_frame 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: a8b59e5031b5fee64016e8be08239134686ba0532ea71cdbf8adbd263037b337
+  data.tar.gz: 210dbc213dfa4e0db91a7dd29c1364233a46a4ab00fd854a75c205d7b83003bb
+SHA512:
+  metadata.gz: c599a3bc24d8042a985414f555c072887f58904ed4e67cfa3576c2897a9a2bd9fa602642c8de555afdcb8b65964e660420b88dde25699baa110e8a4d4ad5ec77
+  data.tar.gz: 380fdb32def48ba199a51cfd5af5ac85eca39cb05d77f75d65714654a7871d18473f4c6e2f2f384e37c11902301e04450225c0c1d07f20ce3a0659d629121b85

data/README.adoc

@@ -0,0 +1,13 @@
+== ApiFrame
+
+ApiFrame is a gem that aims to provide an easy-to-use way of implementing high-level and low-level interactions with APIs working over HTTP.
+
+=== Installation
+
+Add the gem `api_frame` as a runtime dependency to your library’s `gemspec`.
+
+=== Development
+
+After checking out the repository, run `bin/setup` to install dependencies.
+For an interactive Pry session, run `bin/console`.
+Run `rake spec` to run the tests.

data/lib/api_frame/endpoint_methods.rb

@@ -0,0 +1,73 @@
+require 'cgi'
+require 'json'
+require 'net/https'
+
+require_relative 'no_success_error'
+require_relative 'utils'
+
+module ApiFrame
+	module EndpointMethods
+		def base_uri
+			raise NotImplementedError
+		end
+		
+		def default_headers
+			{}
+		end
+		
+		def default_content_type
+			'application/json'
+		end
+		
+		def default_response_parser
+			proc do |response|
+				JSON.parse(response.body)
+			end
+		end
+		
+		def perform_request(method, api_path, query: nil, body: nil, headers: nil)
+			uri = self.base_uri + api_path
+			uri.query = URI.encode_www_form(query) if query
+			
+			Net::HTTP.start(uri.host, uri.port, use_ssl: uri.scheme == 'https') do |http|
+				ApiFrame::Utils.request_type_from_method_argument(method).new(uri).tap do |request|
+					default_headers.merge(headers || {}).each do |name, value|
+						request[name] = value
+					end
+					
+					if body
+						request['Content-Type'] = default_content_type
+						request.body            = body
+					end
+				end.then do |request|
+					http.request(request)
+				end
+			end
+		end
+		
+		def self.included(klass)
+			klass.extend(ClassMethods)
+		end
+		
+		module ClassMethods
+			def define_endpoint(name, method:, endpoint:, body: nil)
+				define_method(name) do |*args, **kwargs|
+					uri          = endpoint.respond_to?(:call) ? ApiFrame::Utils.call_proc_without_unknown_keywords(endpoint, *args, **kwargs) : endpoint
+					request_body = body    .respond_to?(:call) ? ApiFrame::Utils.call_proc_without_unknown_keywords(body,     *args, **kwargs) : body
+					
+					perform_request(method, uri, body: request_body, query: kwargs.key?(:query) ? kwargs.fetch(:query) : nil, headers: kwargs.key?(:headers) ? kwargs.fetch(:headers) : nil).then do |response|
+						if !kwargs.key?(:plain_response) || !kwargs.fetch(:plain_response)
+							if response.is_a?(Net::HTTPSuccess)
+								default_response_parser.call(response)
+							else
+								raise ApiFrame::NoSuccessError, response
+							end
+						else
+							response
+						end
+					end
+				end
+			end
+		end
+	end
+end

data/lib/api_frame/no_success_error.rb

@@ -0,0 +1,11 @@
+module ApiFrame
+	class NoSuccessError < StandardError
+		attr_reader :response
+		
+		def initialize(response)
+			super
+			
+			@response = response
+		end
+	end
+end

data/lib/api_frame/utils.rb

@@ -0,0 +1,39 @@
+module ApiFrame
+	module Utils
+		def self.url_escape(string)
+			if !string.nil?
+				CGI.escape(string.to_s)
+			else
+				raise TypeError, 'cannot escape nil'
+			end
+		end
+		
+		def self.call_proc_without_unknown_keywords(proc, *args, **kwargs, &block)
+			params = proc.parameters.group_by(&:first).transform_values! do |m|
+				m.map do |s|
+					s[1]
+				end
+			end
+			
+			proc_keys =
+				if params.key?(:keyrest)
+					kwargs
+				else
+					kwargs.slice(*params.values_at(:key, :keyreq).compact.flatten)
+				end
+			
+			proc.call(*args, **proc_keys, &block)
+		end
+		
+		def self.request_type_from_method_argument(method)
+			if method.instance_of?(Class) && method.ancestors.include?(Net::HTTPRequest)
+				method
+			else
+				{
+					get:  Net::HTTP::Get,
+					post: Net::HTTP::Post,
+				}.fetch(method)
+			end
+		end
+	end
+end

data/lib/api_frame/version.rb

@@ -0,0 +1,3 @@
+module ApiFrame
+	VERSION = '0.1.0'.freeze
+end

data/lib/api_frame.rb

@@ -0,0 +1,6 @@
+require_relative 'api_frame/endpoint_methods'
+require_relative 'api_frame/version'
+
+module ApiFrame
+	
+end

metadata

@@ -0,0 +1,50 @@
+--- !ruby/object:Gem::Specification
+name: api_frame
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- expeehaa
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2023-01-24 00:00:00.000000000 Z
+dependencies: []
+description:
+email:
+- expeehaa@outlook.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- README.adoc
+- lib/api_frame.rb
+- lib/api_frame/endpoint_methods.rb
+- lib/api_frame/no_success_error.rb
+- lib/api_frame/utils.rb
+- lib/api_frame/version.rb
+homepage: https://github.com/expeehaa/api_frame
+licenses: []
+metadata:
+  allowed_push_host: https://rubygems.org
+  rubygems_mfa_required: 'true'
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.6.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.4.1
+signing_key:
+specification_version: 4
+summary: Small framework to define API clients in Ruby
+test_files: []