aws_minecraft 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 8b2ac622c911990d68a2392c6e8f5ba779420a40
-  data.tar.gz: 5463cc914cb80dd64576b1984e7e49f2b2eac973
+SHA256:
+  metadata.gz: d6276eb43e3e3d747a509a61cbc3626084fc806f8697563cdc281aa99c3c817c
+  data.tar.gz: 5368e300bb28a07a780b02e3f5a864936c1e0b5321c2ee37c74d6af012d6d428
 SHA512:
-  metadata.gz: e0e76fe8c5691fcb5dc8c541152b5f8acdc8111c1d64bf0d6c19dee444b981590438b875156b0dc650c421269983df4b9021fda9518355b32adf1fd5bbaeb027
-  data.tar.gz: a6016d147a7f053addf791ebb7304cc76fa784935b5de75a98b56314f263a5d7380d9b6e23f8fa00fc40911fcd3e33f891f05a8a73acb246dfc94457405e35b8
+  metadata.gz: 8ceb5ba3fa12f2be2f499465a1fcf72a5669d31db8e5b15791c2b7f537e641526bf49d8a5d7a062c37a24adf8c658df38b774d912e03205d4e16ca1b9ba46dc1
+  data.tar.gz: e606683cf5183c19017919aa85a2536e87826f8a0ed9ed6b45b84e785d2a36a92b162b47508f78bbc5a10a8cb196ea9f0874a1537ff22d81f0b710cec70e3e74

data/.travis.yml

@@ -1,4 +1,6 @@
 rvm:
-  - 2.3.1
+  - 2.5
+  - 2.6
+  - 2.7
 env:
   - AWS_REGION=eu-central-1

data/Gemfile

@@ -1,11 +1,11 @@
 source 'https://rubygems.org'
 
-gem 'rspec', require: 'spec'
-gem 'thor'
 gem 'aws-sdk', '~> 2'
-gem 'rubocop'
+gem 'fakefs', require: 'fakefs/safe'
+gem 'net-scp'
+gem 'net-ssh'
 gem 'rake'
+gem 'rspec', require: 'spec'
+gem 'rubocop'
 gem 'sqlite3'
-gem 'net-ssh'
-gem 'net-scp'
-gem 'fakefs', require: 'fakefs/safe'
+gem 'thor'

data/Gemfile.lock

@@ -1,50 +1,62 @@
 GEM
   remote: https://rubygems.org/
   specs:
-    ast (2.3.0)
-    aws-sdk (2.6.2)
-      aws-sdk-resources (= 2.6.2)
-    aws-sdk-core (2.6.2)
+    ast (2.4.1)
+    aws-eventstream (1.1.0)
+    aws-sdk (2.11.632)
+      aws-sdk-resources (= 2.11.632)
+    aws-sdk-core (2.11.632)
+      aws-sigv4 (~> 1.0)
       jmespath (~> 1.0)
-    aws-sdk-resources (2.6.2)
-      aws-sdk-core (= 2.6.2)
-    diff-lcs (1.2.5)
-    fakefs (0.9.1)
-    jmespath (1.3.1)
-    net-scp (1.2.1)
-      net-ssh (>= 2.6.5)
-    net-ssh (3.2.0)
-    parser (2.3.1.4)
-      ast (~> 2.2)
-    powerpack (0.1.1)
-    rainbow (2.1.0)
-    rake (11.2.2)
-    rspec (3.5.0)
-      rspec-core (~> 3.5.0)
-      rspec-expectations (~> 3.5.0)
-      rspec-mocks (~> 3.5.0)
-    rspec-core (3.5.3)
-      rspec-support (~> 3.5.0)
-    rspec-expectations (3.5.0)
+    aws-sdk-resources (2.11.632)
+      aws-sdk-core (= 2.11.632)
+    aws-sigv4 (1.2.2)
+      aws-eventstream (~> 1, >= 1.0.2)
+    diff-lcs (1.4.4)
+    fakefs (1.3.0)
+    jmespath (1.4.0)
+    net-scp (3.0.0)
+      net-ssh (>= 2.6.5, < 7.0.0)
+    net-ssh (6.1.0)
+    parallel (1.20.1)
+    parser (2.7.2.0)
+      ast (~> 2.4.1)
+    rainbow (3.0.0)
+    rake (13.0.3)
+    regexp_parser (2.0.1)
+    rexml (3.2.4)
+    rspec (3.10.0)
+      rspec-core (~> 3.10.0)
+      rspec-expectations (~> 3.10.0)
+      rspec-mocks (~> 3.10.0)
+    rspec-core (3.10.0)
+      rspec-support (~> 3.10.0)
+    rspec-expectations (3.10.0)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.5.0)
-    rspec-mocks (3.5.0)
+      rspec-support (~> 3.10.0)
+    rspec-mocks (3.10.0)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.5.0)
-    rspec-support (3.5.0)
-    rubocop (0.43.0)
-      parser (>= 2.3.1.1, < 3.0)
-      powerpack (~> 0.1)
-      rainbow (>= 1.99.1, < 3.0)
+      rspec-support (~> 3.10.0)
+    rspec-support (3.10.0)
+    rubocop (1.7.0)
+      parallel (~> 1.10)
+      parser (>= 2.7.1.5)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8, < 3.0)
+      rexml
+      rubocop-ast (>= 1.2.0, < 2.0)
       ruby-progressbar (~> 1.7)
-      unicode-display_width (~> 1.0, >= 1.0.1)
-    ruby-progressbar (1.8.1)
-    sqlite3 (1.3.11)
-    thor (0.19.1)
-    unicode-display_width (1.1.1)
+      unicode-display_width (>= 1.4.0, < 2.0)
+    rubocop-ast (1.3.0)
+      parser (>= 2.7.1.5)
+    ruby-progressbar (1.10.1)
+    sqlite3 (1.4.2)
+    thor (1.0.1)
+    unicode-display_width (1.7.0)
 
 PLATFORMS
   ruby
+  x86_64-darwin-20
 
 DEPENDENCIES
   aws-sdk (~> 2)
@@ -58,4 +70,4 @@ DEPENDENCIES
   thor
 
 BUNDLED WITH
-   1.13.1
+   2.2.3

data/README.md

@@ -1,6 +1,8 @@
 Minecraft Server In The Cloud
 =============================
 
+[![Build Status](https://travis-ci.org/Skarlso/aws_minecraft.svg?branch=master)](https://travis-ci.org/Skarlso/aws_minecraft)
+
 This is a fully provisinable Minecraft server on a configurable EC2 instance under AWS. This Gem
 provides the ability to manage both, an EC2 instance and a Minecraft server which is executed on
 that EC2 instance.
@@ -41,13 +43,42 @@ Test your CLI by running an AWS command like this one: `aws ec2 describe-instanc
 
 ## AWS Minecraft Gem
 
+### Install
+
+Version 0.1.0 is deployed as a gem.
+
+```
+gem install aws_minecraft
+```
+
+Or, in a Gemfile
+
+```
+gem 'aws_minecraft'
+```
+
+You can also build it yourself. Just clone this repository and use rake.
+
+```
+rake install
+```
+
+Or
+
+```
+bundle exec rake install
+```
+
+This will create a gem which will be used under `pkg`. Just bare in mind, that there is a key which needs to be present. The `minecraft.key` file. Without it, you won't be able to build the gem.
+
 ### Instance
 
 The instance configuration that is used can be found here: [ec2_config](cfg/ec2_config.json). This
 will configure and create an EC2 instance for you. Couple of things to note here. The instance uses
 an ssh key import which is than used to execute commands on the instance. So in order for this to work
 you'll have to create an SSH key with `ssh-keygen`. Enter your **PUBLIC** key, something like `/Users/youruser/.ssh/ida_rsa.pub`,
-into the file called `Minecraft.key` as a *base64* encoded string.
+into the file called `minecraft.key` as a *base64* encoded string. You can use a public encoder, since
+this is your public key. [Base64Encode](https://www.base64encode.org/).
 
 AWS Minecraft uses tmux to run a Minecraft server in the background. The tmux is a multiplexer client
 and will allow us to attach to it later on, if the user would like to run some commands on the server.
@@ -62,13 +93,13 @@ query amazon for information about the instance.
 
 The [config.yml](cfg/config.yml) file configures this gem. Currently, two settings are available. A
 Logger level setting information which can be overridden any time. And second, it's the location from
-where files will be uploaded to the instance like, Minecraft.jar or craftbukkit.jar. These than will
+where files will be uploaded to the instance like, minecraft.jar or craftbukkit.jar. These than will
 be executed during starting a Minecraft server.
 
 ### DB
 
 The database also needs to be initialised, for this, there is a cli command called init-db. To
-initialise the database, run `bundle exec ./bin/aws_Minecraft.rb init-db`. This will create a
+initialise the database, run `bundle exec ./bin/aws_minecraft.rb init-db`. This will create a
 Minecraft.db file. In case there is anything wrong and you would like to create a new instance, and
 you are sure that the one which is saved, is not the correct one, just delete this file and run
 `init-db` again.
@@ -131,6 +162,14 @@ When you are done playing, don't forget to issue a `stop-server` command.
 If you would like to resume playing on the same server, you would call `start-server` and again,
 enjoy a nice session of Minecraft.
 
+## Using an existing server configuration with plugins
+
+If you happen to have a server with configured plugins and all that jazz, and you would like to just
+continue that on an instance, it's easy to do that. Simply point, in the config.yml file `upload_path:`
+to that folder in which your server, world, minecraft jar, craftbukkit jar, sit and upload_file will
+upload the contents of that folder to EC2. Start your minecraft jar, and log in to your old world with
+everything in tact.
+
 # Examples
 
 Created the instance

data/ROADMAP.md

@@ -7,17 +7,17 @@ Roadmap for aws_minecraft
 * Working on coverage is important. Adding unit tests for ssh, uploader and negative scenarios for
 aws_helper would be Next.
 * Some of the error cases are not handled really well at the moment. They just raise an error.
-* Upload world is not working yet.
 * Everything Minecraft related could be extracted.
 * Would be nice if it wouldn't re-upload.
 * start-server doesn't tell you if starting the tmux session was successful or not.
+* World backup isn't there yet.
+ * Could be to an S3 or, even downloaded.
 
 0.1.0
 -----
 
 * This is an MVP at this stage, with everything working and the most important parts have unit tests.
 
-
 0.0.4
 -----
 

data/aws_minecraft.gemspec

@@ -13,20 +13,18 @@ Gem::Specification.new do |s|
   s.email = 'skarlso777@gmail.com'
   s.extra_rdoc_files = ['README.md']
   s.files = `git ls-files`.split("\n")
-  s.files << './cfg/minecraft.key'
   s.homepage = 'https://github.com/Skarlso/aws_minecraft'
   s.rdoc_options = ['--charset=UTF-8']
   s.require_paths = ['lib']
   s.rubygems_version = '2.6.6'
   s.test_files = `git ls-files`.split("\n").select { |f| f =~ /^specs/ }
-  s.rubyforge_project = 'aws_minecraft'
   s.executables = `git ls-files -- bin/*`.split("\n")
                                          .map { |f| File.basename(f) }
   s.licenses    = ['MIT']
 
   # dependencies
+  s.add_development_dependency 'bundler'
   s.add_development_dependency 'code_stats'
   s.add_development_dependency 'rake'
   s.add_development_dependency 'rspec'
-  s.add_development_dependency 'bundler'
 end

data/bin/aws_minecraft.rb

@@ -61,7 +61,7 @@ class AWSMineCli < Thor
     @aws_mine.upload_files
   end
 
-  desc 'init-db', 'Initialize the databse.'
+  desc 'init-db', 'Initialize the database.'
   def init_db
     @aws_mine.init_db
   end

data/cfg/config.yml

@@ -1,2 +1,2 @@
 loglevel: INFO
-upload_path: /Users/hannibal/RubyProjects/aws_minecraft/drop
+upload_path: /Users/<youruser>/aws_minecraft/drop

data/cfg/ec2_conf.json

@@ -4,7 +4,7 @@
     "key_name": "minecraft_keys",
     "min_count": 1,
     "max_count": 1,
-    "instance_type": "t2.nano",
+    "instance_type": "t2.large",
     "monitoring": {
         "enabled": true
     }

data/lib/aws_minecraft.rb

@@ -10,12 +10,13 @@ module AWSMine
   class AWSMine
     MINECRAFT_SESSION_NAME = 'minecraft'.freeze
     attr_accessor :aws_helper, :db_helper, :upload_helper, :ssh_helper
+
     def initialize
       @aws_helper = AWSHelper.new
       @db_helper = DBHelper.new
       @upload_helper = UploadHelper.new
       @ssh_helper = SSHHelper.new
-      @logger = Logger.new(STDOUT)
+      @logger = Logger.new($stdout)
       @logger.level = Logger.const_get(MineConfig.new.loglevel)
     end
 

data/lib/aws_minecraft/aws_helper.rb

@@ -23,8 +23,7 @@ module AWSMine
     # rubocop:disable Metrics/AbcSize
     def create_ec2
       @logger.info('Creating new EC2 instance.')
-      config = File.open(File.join(__dir__, '../../cfg/ec2_conf.json'),
-                         'rb', &:read).chop
+      config = File.read(File.join(__dir__, '../../cfg/ec2_conf.json'))
       @logger.debug("Configuration loaded: #{config}.")
       ec2_config = symbolize(JSON.parse(config))
       @logger.debug("Configuration symbolized: #{ec2_config}.")
@@ -110,8 +109,7 @@ module AWSMine
     end
 
     def import_keypair
-      key = Base64.decode64(File.open(File.join(__dir__, '../../cfg/minecraft.key'),
-                                      'rb', &:read).chop)
+      key = Base64.decode64(File.read(File.join(__dir__, '../../cfg/minecraft.key')))
       begin
         @ec2_client.describe_key_pairs(key_names: ['minecraft_keys'])
         key_exists = true
@@ -126,8 +124,7 @@ module AWSMine
     end
 
     def create_security_group
-      config = File.open(File.join(__dir__, '../../cfg/sg_config.json'),
-                         'rb', &:read).chop
+      config = File.read(File.join(__dir__, '../../cfg/sg_config.json'))
       sg_config = symbolize(JSON.parse(config))
       begin
         sg = @ec2_resource.create_security_group(dry_run: false,
@@ -142,8 +139,7 @@ module AWSMine
     end
 
     def retrieve_user_data
-      user_data = File.open(File.join(__dir__, '../../cfg/user_data.sh'),
-                            'rb', &:read).chop
+      user_data = File.read(File.join(__dir__, '../../cfg/user_data.sh'))
       Base64.encode64(user_data)
     end
   end

data/lib/aws_minecraft/db_helper.rb

@@ -19,8 +19,7 @@ module AWSMine
 
     def init_db
       @tables.each do |table|
-        sql = File.open(File.join(__dir__, "../../cfg/#{table}.sql"),
-                        'rb', &:read).chop
+        sql = File.read(File.join(__dir__, "../../cfg/#{table}.sql"))
         @db.execute sql unless table_exists? table
       end
     end

data/lib/aws_minecraft/upload_helper.rb

@@ -6,7 +6,7 @@ module AWSMine
   class UploadHelper
     def initialize
       @config = MineConfig.new
-      @logger = Logger.new(STDOUT)
+      @logger = Logger.new($stdout)
       @logger.level = Logger.const_get(@config.loglevel)
     end
 

data/lib/aws_minecraft/version.rb

@@ -1,5 +1,5 @@
 module AWSMine
   class AWSMine
-    VERSION = '0.1.0'.freeze
+    VERSION = '0.2.0'.freeze
   end
 end

data/spec/aws_helper_spec.rb

@@ -41,10 +41,10 @@ describe AWSMine::AWSHelper do
               key_name: 'minecraft_keys',
               min_count: 1,
               max_count: 1,
-              instance_type: 't2.nano',
+              instance_type: 't2.large',
               monitoring: { enabled: true },
               security_group_ids: ['sg-1'],
-              user_data: "ICAgICAgICAgICEjL2Jpbi9iYXNo\n")
+              user_data: "ISMvYmluL2Jhc2g=\n")
         .and_return([ec2])
       expect(ec2_resource).to receive(:client).and_return(client)
       expect(ec2).to receive(:id).exactly(4).times.and_return('ec2-id')

data/spec/spec_helper.rb

@@ -20,81 +20,15 @@ shared_examples 'with aws minecraft' do
 
   before :each do
     FakeFS.activate!
-    FakeFS::FileSystem.clone(__dir__)
+    FakeFS::FileSystem.clone(File.join(File.dirname(__FILE__), '../cfg'))
     FakeFS do
-      FileUtils.mkdir_p(File.join(__dir__, '../cfg'))
+      # FileUtils.mkdir_p(File.join(__dir__, '../cfg'))
       File.open(File.join(__dir__, '../cfg/config.yml'), 'w') do |f|
         f.puts('loglevel: ERROR')
         f.puts('upload_path: /drop')
       end
-
-      FileUtils.mkdir_p(File.join(__dir__, '../cfg'))
-      File.open(File.join(__dir__, '../cfg/ec2_conf.json'), 'w') do |f|
-        f.puts <<-FILE
-          {
-              "dry_run": false,
-              "image_id": "ami-ea26ce85",
-              "key_name": "minecraft_keys",
-              "min_count": 1,
-              "max_count": 1,
-              "instance_type": "t2.nano",
-              "monitoring": {
-                  "enabled": true
-              }
-          }
-        FILE
-      end
-
-      FileUtils.mkdir_p(File.join(__dir__, '../cfg'))
-      File.open(File.join(__dir__, '../cfg/instances.sql'), 'w') do |f|
-        f.puts <<-FILE
-          create table instances (
-                ip varchar(100),
-                id varchar(100),
-                PRIMARY KEY (id)
-          );
-        FILE
-      end
-
-      FileUtils.mkdir_p(File.join(__dir__, '../cfg'))
-      File.open(File.join(__dir__, '../cfg/sg_config.json'), 'w') do |f|
-        f.puts <<-FILE
-          {
-            "ip_permissions": [
-              {
-                "ip_protocol": "tcp",
-                "from_port": 22,
-                "to_port": 22,
-                "ip_ranges": [{
-                  "cidr_ip": "0.0.0.0/0"
-                }]
-              },
-              {
-                "ip_protocol": "tcp",
-                "from_port": 25565,
-                "to_port": 25565,
-                "ip_ranges": [{
-                  "cidr_ip": "0.0.0.0/0"
-                }]
-              }
-            ]
-          }
-        FILE
-      end
-
-      FileUtils.mkdir_p(File.join(__dir__, '../cfg'))
-      File.open(File.join(__dir__, '../cfg/user_data.sh'), 'w') do |f|
-        f.puts <<-FILE
-          !#/bin/bash
-        FILE
-      end
-
-      FileUtils.mkdir_p(File.join(__dir__, '../cfg'))
-      File.open(File.join(__dir__, '../cfg/minecraft.key'), 'w') do |f|
-        f.puts <<-FILE
-          somekey
-        FILE
-      end
+      File.write(File.join(__dir__, '../cfg/user_data.sh'), '!#/bin/bash')
+      File.write(File.join(__dir__, '../cfg/minecraft.key'), 'mykey')
     end
   end
 end

metadata

@@ -1,17 +1,17 @@
 --- !ruby/object:Gem::Specification
 name: aws_minecraft
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Gergely Brautigam
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2016-10-03 00:00:00.000000000 Z
+date: 2020-12-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: code_stats
+  name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -25,7 +25,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: rake
+  name: code_stats
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -39,7 +39,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: rspec
+  name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -53,7 +53,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: bundler
+  name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -74,7 +74,6 @@ extensions: []
 extra_rdoc_files:
 - README.md
 files:
-- "./cfg/minecraft.key"
 - ".gitignore"
 - ".rspec"
 - ".travis.yml"
@@ -116,7 +115,7 @@ homepage: https://github.com/Skarlso/aws_minecraft
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options:
 - "--charset=UTF-8"
 require_paths:
@@ -132,9 +131,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: aws_minecraft
-rubygems_version: 2.5.1
-signing_key: 
+rubygems_version: 3.1.2
+signing_key:
 specification_version: 4
 summary: A minecraft server provisioner on an AWS EC2 instance.
 test_files: []