ssc.bot 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 73c3de3d7f455e1f201f7285cc76d06a6213b6690566b7875d8770b32b0b7131
+  data.tar.gz: f9c4976dfab3bbb38fa5e5d92d4869c6dd9556b36650b90790fa6efa505d389f
+SHA512:
+  metadata.gz: d602f331f66f4361ed911320b58eeb485a144cc1b12ea921f585a6e9a0a817d1f9fd9780f4512479a4a8e55e13ec8314e9bb77ab250c2dde982881ca01fa4c25
+  data.tar.gz: bed3804f7a441d25e0ec622c1998f181dc18ebe7452d66f8c9dc59d5cd58a7b5194e5a11978ba086d7ca4e71ffc0dd066724129b8b569ca1677059d1a760c960

data/CHANGELOG.md

@@ -0,0 +1,40 @@
+# Changelog | SSC.Bot
+
+All notable changes to this project will be documented in this file.
+
+Format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [[Unreleased]](https://github.com/esotericpig/ssc.bot/compare/v0.1.0...HEAD)
+-
+
+## [v0.1.0] - [2020-08-29](https://github.com/esotericpig/ssc.bot/tree/v0.1.0)
+### Added
+- /
+    - .gitignore
+    - .yardopts
+    - CHANGELOG.md
+    - Gemfile
+    - LICENSE.txt
+    - Rakefile
+    - README.md
+    - ssc.bot.gemspec
+- /lib/
+    - ssc.bot.rb
+- /lib/ssc.bot/
+    - chat_log.rb
+    - chat_log_file.rb
+    - error.rb
+    - ssc_file.rb
+    - util.rb
+    - version.rb
+- /lib/ssc.bot/chat_log/
+    - message.rb
+    - message_parsable.rb
+    - message_parser.rb
+    - messages.rb
+- /lib/ssc.bot/user/
+    - jrobot_message_sender.rb
+    - message_sender.rb
+- /test/
+    - test_helper.rb

data/Gemfile

@@ -0,0 +1,25 @@
+# encoding: UTF-8
+# frozen_string_literal: true
+
+#--
+# This file is part of SSC.Bot.
+# Copyright (c) 2020 Jonathan Bradley Whited (@esotericpig)
+# 
+# SSC.Bot is free software: you can redistribute it and/or modify
+# it under the terms of the GNU Lesser General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+# 
+# SSC.Bot is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU Lesser General Public License for more details.
+# 
+# You should have received a copy of the GNU Lesser General Public License
+# along with SSC.Bot.  If not, see <https://www.gnu.org/licenses/>.
+#++
+
+
+source 'https://rubygems.org'
+
+gemspec

data/LICENSE.txt

@@ -0,0 +1,165 @@
+                   GNU LESSER GENERAL PUBLIC LICENSE
+                       Version 3, 29 June 2007
+
+ Copyright (C) 2007 Free Software Foundation, Inc. <https://fsf.org/>
+ Everyone is permitted to copy and distribute verbatim copies
+ of this license document, but changing it is not allowed.
+
+
+  This version of the GNU Lesser General Public License incorporates
+the terms and conditions of version 3 of the GNU General Public
+License, supplemented by the additional permissions listed below.
+
+  0. Additional Definitions.
+
+  As used herein, "this License" refers to version 3 of the GNU Lesser
+General Public License, and the "GNU GPL" refers to version 3 of the GNU
+General Public License.
+
+  "The Library" refers to a covered work governed by this License,
+other than an Application or a Combined Work as defined below.
+
+  An "Application" is any work that makes use of an interface provided
+by the Library, but which is not otherwise based on the Library.
+Defining a subclass of a class defined by the Library is deemed a mode
+of using an interface provided by the Library.
+
+  A "Combined Work" is a work produced by combining or linking an
+Application with the Library.  The particular version of the Library
+with which the Combined Work was made is also called the "Linked
+Version".
+
+  The "Minimal Corresponding Source" for a Combined Work means the
+Corresponding Source for the Combined Work, excluding any source code
+for portions of the Combined Work that, considered in isolation, are
+based on the Application, and not on the Linked Version.
+
+  The "Corresponding Application Code" for a Combined Work means the
+object code and/or source code for the Application, including any data
+and utility programs needed for reproducing the Combined Work from the
+Application, but excluding the System Libraries of the Combined Work.
+
+  1. Exception to Section 3 of the GNU GPL.
+
+  You may convey a covered work under sections 3 and 4 of this License
+without being bound by section 3 of the GNU GPL.
+
+  2. Conveying Modified Versions.
+
+  If you modify a copy of the Library, and, in your modifications, a
+facility refers to a function or data to be supplied by an Application
+that uses the facility (other than as an argument passed when the
+facility is invoked), then you may convey a copy of the modified
+version:
+
+   a) under this License, provided that you make a good faith effort to
+   ensure that, in the event an Application does not supply the
+   function or data, the facility still operates, and performs
+   whatever part of its purpose remains meaningful, or
+
+   b) under the GNU GPL, with none of the additional permissions of
+   this License applicable to that copy.
+
+  3. Object Code Incorporating Material from Library Header Files.
+
+  The object code form of an Application may incorporate material from
+a header file that is part of the Library.  You may convey such object
+code under terms of your choice, provided that, if the incorporated
+material is not limited to numerical parameters, data structure
+layouts and accessors, or small macros, inline functions and templates
+(ten or fewer lines in length), you do both of the following:
+
+   a) Give prominent notice with each copy of the object code that the
+   Library is used in it and that the Library and its use are
+   covered by this License.
+
+   b) Accompany the object code with a copy of the GNU GPL and this license
+   document.
+
+  4. Combined Works.
+
+  You may convey a Combined Work under terms of your choice that,
+taken together, effectively do not restrict modification of the
+portions of the Library contained in the Combined Work and reverse
+engineering for debugging such modifications, if you also do each of
+the following:
+
+   a) Give prominent notice with each copy of the Combined Work that
+   the Library is used in it and that the Library and its use are
+   covered by this License.
+
+   b) Accompany the Combined Work with a copy of the GNU GPL and this license
+   document.
+
+   c) For a Combined Work that displays copyright notices during
+   execution, include the copyright notice for the Library among
+   these notices, as well as a reference directing the user to the
+   copies of the GNU GPL and this license document.
+
+   d) Do one of the following:
+
+       0) Convey the Minimal Corresponding Source under the terms of this
+       License, and the Corresponding Application Code in a form
+       suitable for, and under terms that permit, the user to
+       recombine or relink the Application with a modified version of
+       the Linked Version to produce a modified Combined Work, in the
+       manner specified by section 6 of the GNU GPL for conveying
+       Corresponding Source.
+
+       1) Use a suitable shared library mechanism for linking with the
+       Library.  A suitable mechanism is one that (a) uses at run time
+       a copy of the Library already present on the user's computer
+       system, and (b) will operate properly with a modified version
+       of the Library that is interface-compatible with the Linked
+       Version.
+
+   e) Provide Installation Information, but only if you would otherwise
+   be required to provide such information under section 6 of the
+   GNU GPL, and only to the extent that such information is
+   necessary to install and execute a modified version of the
+   Combined Work produced by recombining or relinking the
+   Application with a modified version of the Linked Version. (If
+   you use option 4d0, the Installation Information must accompany
+   the Minimal Corresponding Source and Corresponding Application
+   Code. If you use option 4d1, you must provide the Installation
+   Information in the manner specified by section 6 of the GNU GPL
+   for conveying Corresponding Source.)
+
+  5. Combined Libraries.
+
+  You may place library facilities that are a work based on the
+Library side by side in a single library together with other library
+facilities that are not Applications and are not covered by this
+License, and convey such a combined library under terms of your
+choice, if you do both of the following:
+
+   a) Accompany the combined library with a copy of the same work based
+   on the Library, uncombined with any other library facilities,
+   conveyed under the terms of this License.
+
+   b) Give prominent notice with the combined library that part of it
+   is a work based on the Library, and explaining where to find the
+   accompanying uncombined form of the same work.
+
+  6. Revised Versions of the GNU Lesser General Public License.
+
+  The Free Software Foundation may publish revised and/or new versions
+of the GNU Lesser General Public License from time to time. Such new
+versions will be similar in spirit to the present version, but may
+differ in detail to address new problems or concerns.
+
+  Each version is given a distinguishing version number. If the
+Library as you received it specifies that a certain numbered version
+of the GNU Lesser General Public License "or any later version"
+applies to it, you have the option of following the terms and
+conditions either of that published version or of any later version
+published by the Free Software Foundation. If the Library as you
+received it does not specify a version number of the GNU Lesser
+General Public License, you may choose any version of the GNU Lesser
+General Public License ever published by the Free Software Foundation.
+
+  If the Library as you received it specifies that a proxy can decide
+whether future versions of the GNU Lesser General Public License shall
+apply, that proxy's public statement of acceptance of any version is
+permanent authorization for you to choose that version for the
+Library.

data/README.md

@@ -0,0 +1,115 @@
+# SSC.Bot
+
+[![Gem Version](https://badge.fury.io/rb/ssc.bot.svg)](https://badge.fury.io/rb/ssc.bot)
+
+[![Source Code](https://img.shields.io/badge/source-github-%23211F1F.svg)](https://github.com/esotericpig/ssc.bot)
+[![Changelog](https://img.shields.io/badge/changelog-md-%23A0522D.svg)](CHANGELOG.md)
+[![License](https://img.shields.io/github/license/esotericpig/ssc.bot.svg)](LICENSE.txt)
+
+*SSC.Bot* is a simple user bot library for the game [Subspace Continuum](https://store.steampowered.com/app/352700/Subspace_Continuum/).
+
+It's currently in development and only offers limited functionality.
+
+## Contents
+
+- [Setup](#-setup)
+- [Using](#-using)
+- [Hacking](#-hacking)
+- [License](#-license)
+
+## [//](#contents) Setup
+
+Pick your poison...
+
+In your Gemspec (*<project>*.gemspec):
+
+```Ruby
+  # Pick one...
+  spec.add_runtime_dependency 'ssc.bot', '~> X.X'
+  spec.add_development_dependency 'ssc.bot', '~> X.X'
+```
+
+In your Gemfile:
+
+```Ruby
+  # Pick one...
+  gem 'ssc.bot', '~> X.X'
+  gem 'ssc.bot', '~> X.X', group: :development
+  gem 'ssc.bot', git: 'https://github.com/esotericpig/ssc.bot.git', tag: 'vX.X.X'
+```
+
+With the RubyGems package manager:
+
+```
+  $ gem install ssc.bot
+```
+
+Manually:
+
+```
+  $ git clone 'https://github.com/esotericpig/ssc.bot.git'
+  $ cd ssc.bot
+  $ bundle install
+  $ bundle exec rake install:local
+```
+
+## [//](#contents) Using
+
+TODO: readme.using
+
+## [//](#contents) Hacking
+
+```
+$ git clone 'https://github.com/esotericpig/ssc.bot.git'
+$ cd ssc.bot
+$ bundle install
+$ bundle exec rake -T
+```
+
+### Testing
+
+```
+$ bundle exec rake test
+```
+
+### Generating Doc
+
+```
+$ bundle exec rake doc
+```
+
+### Installing Locally
+
+```
+$ bundle exec rake install:local
+```
+
+### Releasing
+
+1. Update *CHANGELOG.md* & *version.rb*
+    - `$ raketary bump -v`
+2. Check for updates
+    - `$ bundle update`
+    - `$ bundle outdated`
+    - `$ git pull`
+3. `$ bundle exec rake release`
+
+## [//](#contents) License
+
+[GNU LGPL v3+](LICENSE.txt)
+
+> SSC.Bot (<https://github.com/esotericpig/ssc.bot>)  
+> Copyright (c) 2020 Jonathan Bradley Whited (@esotericpig)  
+> 
+> SSC.Bot is free software: you can redistribute it and/or modify  
+> it under the terms of the GNU Lesser General Public License as published by  
+> the Free Software Foundation, either version 3 of the License, or  
+> (at your option) any later version.  
+> 
+> SSC.Bot is distributed in the hope that it will be useful,  
+> but WITHOUT ANY WARRANTY; without even the implied warranty of  
+> MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the  
+> GNU Lesser General Public License for more details.  
+> 
+> You should have received a copy of the GNU Lesser General Public License  
+> along with SSC.Bot.  If not, see <https://www.gnu.org/licenses/>.  

data/Rakefile

@@ -0,0 +1,52 @@
+# encoding: UTF-8
+# frozen_string_literal: true
+
+#--
+# This file is part of SSC.Bot.
+# Copyright (c) 2020 Jonathan Bradley Whited (@esotericpig)
+# 
+# SSC.Bot is free software: you can redistribute it and/or modify
+# it under the terms of the GNU Lesser General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+# 
+# SSC.Bot is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU Lesser General Public License for more details.
+# 
+# You should have received a copy of the GNU Lesser General Public License
+# along with SSC.Bot.  If not, see <https://www.gnu.org/licenses/>.
+#++
+
+
+require 'bundler/gem_tasks'
+
+require 'rake/clean'
+require 'rake/testtask'
+require 'yard'
+
+require 'ssc.bot/version'
+
+
+CLEAN.exclude('{.git,stock}/**/*')
+CLOBBER.include('doc/')
+
+task default: [:test]
+
+desc 'Generate documentation'
+task :doc => [:yard] do |task|
+end
+
+Rake::TestTask.new() do |task|
+  task.libs = ['lib','test']
+  task.pattern = File.join('test','**','*_test.rb')
+  task.description += ": '#{task.pattern}'"
+  task.verbose = false
+  task.warning = true
+end
+
+YARD::Rake::YardocTask.new() do |task|
+  #task.options.push('--template-path',File.join('yard','templates'))
+  task.options.push('--title',"SSC.Bot v#{SSCBot::VERSION} Doc")
+end

data/lib/ssc.bot.rb

@@ -0,0 +1,44 @@
+#!/usr/bin/env ruby
+# encoding: UTF-8
+# frozen_string_literal: true
+
+#--
+# This file is part of SSC.Bot.
+# Copyright (c) 2020 Jonathan Bradley Whited (@esotericpig)
+# 
+# SSC.Bot is free software: you can redistribute it and/or modify
+# it under the terms of the GNU Lesser General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+# 
+# SSC.Bot is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU Lesser General Public License for more details.
+# 
+# You should have received a copy of the GNU Lesser General Public License
+# along with SSC.Bot.  If not, see <https://www.gnu.org/licenses/>.
+#++
+
+
+require 'ssc.bot/chat_log'
+require 'ssc.bot/chat_log_file'
+require 'ssc.bot/error'
+require 'ssc.bot/ssc_file'
+require 'ssc.bot/util'
+require 'ssc.bot/version'
+
+require 'ssc.bot/chat_log/message'
+require 'ssc.bot/chat_log/message_parsable'
+require 'ssc.bot/chat_log/message_parser'
+require 'ssc.bot/chat_log/messages'
+
+require 'ssc.bot/user/message_sender'
+
+
+###
+# @author Jonathan Bradley Whited (@esotericpig)
+# @since  0.1.0
+###
+module SSCBot
+end