ratal 0.1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 1043e9c45d1f92b0d4255cf019347a210b616165
+  data.tar.gz: 4408d9af846093e8760e1c2c76f629101867f749
+SHA512:
+  metadata.gz: 19e8bfed7790597bae216048f0eef6a34f7db66ea7cde6f026f984cdbde72803074a15f202d9d10192966e87d65bd6a30dd24e7f936fc654becf31340aadad62
+  data.tar.gz: 2c9137df84a62fd4534463bc66f664a0aa808f98ca318d742a54c482a41ce342367cf495e0d1ca39c56bd21ee74ab42741127be322c8815c50f18a937132e3af

data/lib/ratal.rb

@@ -0,0 +1,91 @@
+require 'ratal/request_provider'
+require 'ratal/nethttp_provider'
+
+class Ratal
+	USER_AGENT = 'KAMAR/1455 CFNetwork/758.4.3 Darwin/15.5.0'
+	CONTENT_TYPE = 'application/x-www-form-urlencoded'
+
+	@api_base = nil
+	@api_target = nil
+	@provider = nil
+
+	def initialize(api_base, provider = NetHTTPProvider.new)
+		@api_base = api_base
+		@provider = provider
+
+		api_string = 'api/api.php'
+
+		@api_target = @api_base
+
+		# Make sure it starts with http://
+		@api_base.prepend 'http://' unless @api_target =~ /^[a-z]+:\/\//
+
+		# If it already has the api string on it, skip it
+		return if @api_target.end_with? api_string
+
+		# Make sure it ends with '/'
+		@api_base.concat '/' unless @api_target.end_with? '/'
+
+		# Make sure it ends with api/api.php
+		@api_base.concat api_string
+	end
+
+	def settings
+		call_method 'GetSettings', 'ServerSettings', 'vtku'
+	end
+
+	def connect(username, password)
+		call_method 'Logon', 'Logon', 'vtku', Username: username, Password: password
+	end
+
+	attr_reader :api_base
+	attr_reader :api_target
+
+	protected
+	def call_method(command, target, key, options = {})
+		params = {'Command': command, 'FileName': target, 'Key': key}
+		str = call params.merge(options)
+
+		doc = REXML::Document.new(str)
+
+		result = process_element(doc.root)
+
+		result
+	end
+
+	def call(data)
+		# noinspection RubyStringKeysInHashInspection
+		headers = {
+				'User-Agent': USER_AGENT,
+				'Content-Type': CONTENT_TYPE
+		}
+
+		uri = URI(api_target)
+		@provider.request(uri, headers, data)
+	end
+
+	def process_element(elem)
+		result = {}
+
+		children = elem.elements
+		if children.empty?
+			return elem.text
+		else
+			children.each do |e|
+				result[symbolize e.name] = process_element(e)
+			end
+		end
+
+		result
+	end
+
+	# http://stackoverflow.com/a/1509939
+	def symbolize(str)
+		str.gsub(/::/, '/').
+				gsub(/([A-Z]+)([A-Z][a-z])/, '\1_\2').
+				gsub(/([a-z\d])([A-Z])/, '\1_\2').
+				tr('- ', '_').
+				downcase.
+				to_sym
+	end
+end

data/lib/ratal/nethttp_provider.rb

@@ -0,0 +1,24 @@
+class NetHTTPProvider < RequestProvider
+	def request(uri, headers, data)
+		# Convert the symbol keys to strings for the headers
+		headers_mapped = {}
+		headers.each { |k, v| headers_mapped[k.to_s] = v }
+
+		# Convert the symbol keys to strings for the data
+		data_mapped = {}
+		data.each { |k, v| data_mapped[k.to_s] = v }
+
+		# Make the connection
+		http = Net::HTTP.new(uri.hostname, uri.port)
+
+		# Build the request
+		req = Net::HTTP::Post.new(uri.request_uri, headers_mapped)
+		req.set_form_data(data_mapped)
+
+		# Run the request
+		response = http.request(req)
+
+		# Return the result
+		response.body
+	end
+end

data/lib/ratal/request_provider.rb

@@ -0,0 +1,12 @@
+class RequestProvider
+	METHOD = 'Method not implemented!'
+
+	# Fire a HTTP request.
+	# @param [URI] uri The URI to send the request to
+	# @param [Hash] headers The headers to be sent
+	# @param [Hash] data The parameters to be used on this request
+	# @return [String] The result, as a string, of this request
+	def request(uri, headers, data)
+		raise METHOD
+	end
+end

metadata

@@ -0,0 +1,47 @@
+--- !ruby/object:Gem::Specification
+name: ratal
+version: !ruby/object:Gem::Version
+  version: 0.1.0.0
+platform: ruby
+authors:
+- Campbell Suter
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-03-10 00:00:00.000000000 Z
+dependencies: []
+description: A ruby port of Project Katal, an unofficial interface to the undocumented
+  Kamar API
+email: znix@znix.xyz
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/ratal.rb
+- lib/ratal/nethttp_provider.rb
+- lib/ratal/request_provider.rb
+homepage: https://gitlab.com/EasywaysNZ/ratal
+licenses:
+- GPL-3.0+
+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.5.2
+signing_key: 
+specification_version: 4
+summary: Ruby port of Project Katal
+test_files: []