gather_town_ruby 0.0.1.pre

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 20a5d62f8237213d86665d5a0187240d5d8d05cbcf796d9c885acd5614452efa
+  data.tar.gz: 3262ab830fc1225634bf20dfd25415de98e713313f77d44b1ad4b220214d9822
+SHA512:
+  metadata.gz: ac0347d530ec5f87202923ca6280c18fc703fc4ec5f431106a3f9003b4d6fddfa12d16f80f96f199e3ee481e9cfb1f994a3095ab5c193fd7b5a6932301ceed48
+  data.tar.gz: 925ae434ebf393b6b8baf9c69b2232f1c8bf149cdd6f7f4590eced35069f9b01773b31ca473d1b58432a29f57f60b981a125cfc875b657fb48febe4133d91b4e

data/lib/gather_town_ruby.rb

@@ -0,0 +1,85 @@
+require "httparty"
+
+class GatherTown
+  include HTTParty
+  base_uri 'https://gather.town/api'
+
+  attr_reader   :space_id
+  attr_accessor :map_id
+
+  def initialize(web_url, map_id: nil, test_connection: true)
+    validate_web_url(web_url)
+    set_space_id(web_url)
+    set_map_id(map_id)
+    get_map if test_connection
+  end
+
+  def valid_map_ids
+    get_map
+  end
+ 
+  def get_map
+    return_as_response do
+      self.class.get("/getMap", **default_query_params)
+    end
+  end
+
+  private
+
+  def api_key
+    ENV['gather_api_key'] || raise(ArgumentError, "no API key was found (did you set ENV['gather_api_key']?)")
+  end
+
+  def valid_web_url_prefix
+    'https://app.gather.town/app/'
+  end
+
+  def validate_web_url(web_url)
+    raise ArgumentError, "must pass a web URL like 'https://app.gather.town/app/PppGRSubDWjPmcQM/Your%20Office'. You can just copy this from your browser once you're logged in to Gather" unless web_url
+    raise ArgumentError, "web_url must be a String" unless web_url.is_a?(String)
+    raise ArgumentError, "web_url ('#{web_url}') must begin with '#{valid_web_url_prefix}'" unless web_url[0..(valid_web_url_prefix.length - 1)] == valid_web_url_prefix
+  end
+
+  def set_space_id(web_url)
+    raw_space_id_and_name = web_url[valid_web_url_prefix.length..-1]
+    raise ArgumentError, "web_url must end with a space id and a space name, separated by a `/` character" unless raw_space_id_and_name.include?('/') && raw_space_id_and_name.split('/').all?
+    space_id       = raw_space_id_and_name.split('/').first
+    raw_space_name = raw_space_id_and_name.split('/').last
+    space_name = (not_encoded?(raw_space_name) ? encode(raw_space_name) : raw_space_name)
+    @space_id = (space_id + '\ ' + space_name).gsub(' ', '') # as per Gather's API spec, the space ID and space name must be separated by a backslash (not a forward slash, as in the URL)
+  end
+
+  def set_map_id(map_id)
+    raise ArgumentError, "must pass a map ID, like 'office-cozy' (you can find a valid map ID by opening the 'Mapmaker', and looking in the 'Rooms' tab on the right)" unless map_id && map_id.is_a?(String)
+    @map_id = map_id
+  end
+
+  def not_encoded?(string)
+    string == CGI.unescape(string)
+  end
+
+  def encode(string)
+    ERB::Util.url_encode(string)
+  end
+
+  def default_query_params
+    { 
+      apiKey:  api_key, 
+      spaceId: @space_id,
+      mapId:   @map_id 
+    }
+  end
+
+  def return_as_response(&block)
+    response = yield
+    if response.header.is_a?(Net::HTTPSuccess)
+      response.parsed_response
+    else
+      raise ArgumentError, "\nthe request:\n  #{response.request.inspect}\nyielded an unsuccessful response:\n  #{response.header}: #{response.parsed_response}"
+    end
+  end
+
+end
+
+
+

metadata

@@ -0,0 +1,58 @@
+--- !ruby/object:Gem::Specification
+name: gather_town_ruby
+version: !ruby/object:Gem::Version
+  version: 0.0.1.pre
+platform: ruby
+authors:
+- Greg Matthew Crossley
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2022-03-14 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: httparty
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.17'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.17'
+description: Gives you an easy way to read and write to maps and spaces within Gather
+  Town.
+email: greg@neomindlabs.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/gather_town_ruby.rb
+homepage:
+licenses:
+- MIT
+metadata: {}
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.7.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">"
+    - !ruby/object:Gem::Version
+      version: 1.3.1
+requirements: []
+rubygems_version: 3.1.6
+signing_key:
+specification_version: 4
+summary: A Ruby library for interfacing with Gather Town via their API.
+test_files: []