martilla 0.2.1 → 0.2.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b9d31f371877ecf3b302768977e737291d3d9445b381919c4b16f90103d43748
-  data.tar.gz: 783aff8488c1a399642de09dd09f70fb6f0fc3011542d6f3b1e8de25901d3e83
+  metadata.gz: 7762784e1d316afe26bfa62f739552de6a94fdc53d8891721d147be01bdc0876
+  data.tar.gz: 4ed98cb182476da8481827407ba2a0dff28397d1d417403f0b7e6d07779bdba5
 SHA512:
-  metadata.gz: 93c36f6e9fc9a1e0db8bce2241c87071c26c2a9a40d4bc27b62339427c9c5684c0156afc74dcf023008139e7070cc50b4ad24a5dc808ee0bf91c8ab9d8692aa5
-  data.tar.gz: 7e83cab89dd30200161bb6a13938119847a5d1a78e3843e41bde85cf33dc3f59eaeda086df719087cc9440fe8e9da70065d90c29d6f0428bdda9c298b6c715a5
+  metadata.gz: ebdf212a3b50ad6b9bdf50d81053d037bad5dd8135d9b7c4c7bd6eb1391e81f5d74a875d6760878b9e0b986724a300388c8be0ad0d7a17a634c87012149faa6e
+  data.tar.gz: 6245c7de65d755ae72cab8adc8c3948d9a17124df1ad172a4f162c2f4da2c6f63647180df0fde696c020deed5cd5e5977d0f21da816c226fb28bd043b1892181

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    martilla (0.2.1)
+    martilla (0.2.2)
       aws-sdk-s3 (~> 1.49)
       aws-sdk-ses (~> 1.26)
       memoist (~> 0.16.0)

data/README.md

@@ -20,13 +20,13 @@ gem 'martilla'
 
 Martilla uses a YAML configuration file that specifies the backup to be performed. The gem works by making three main concepts work together, they're listed out with details that should generally be specified in the config file:
 
- - Database
+ - **Database**
    - What database are we going to backup
    - How can we connect to the database
- - Storage
+ - **Storage**
    - Where is this backup going to be stored
    - Credentials needed to persist the backup
- - Notifiers
+ - **Notifiers**
    - How will you get notified of the backup result
    - Can be a list of multiple ways to get notified
 
@@ -53,7 +53,7 @@ From here on you pick the building blocks that work for your specific case:
 
 ### Databases
 
-Currently available DB types to choose from are 'postgres' & 'mysql'. They both have the same available options:
+Currently available DB types to choose from are **postgres** & **mysql**. They both have the same available options:
  - `host`
    - defaults to localhost
    - can be set in ENV variable `PG_HOST` or `MYSQL_HOST`
@@ -73,10 +73,10 @@ Currently available DB types to choose from are 'postgres' & 'mysql'. They both
 ### Storages
 
 The available Storages types are 'local', 'S3' & 'SCP'. They each have different available options:
- - options for type: 'local'
+ - options for type: **local**
    - `filename`
      - The location to where the backup will be stored
- - options for type: 's3'
+ - options for type: **s3**
    - `filename`
      - The location to where the backup will be stored within the S3 bucket
    - `bucket`
@@ -85,7 +85,7 @@ The available Storages types are 'local', 'S3' & 'SCP'. They each have different
      - can be specified with the usual ENV variables or IAM roles
    - `secret_access_key`
      - can be specified with the usual ENV variables or IAM roles
- - options for type: 'scp'
+ - options for type: **scp**
    - `filename`
      - The location to where the backup will be stored within remote server
    - `host`
@@ -97,21 +97,31 @@ All storage types also accept 'suffix' as a boolean that enables or disables a t
 ### Notifiers
 
 The available Notifiers are 'ses', 'sendmail' & 'smtp'. They each have different available options:
-- options for type: 'ses' (email notifier)
+- options for type: **ses** (email notifier)
   - `aws_region`
   - `access_key_id`
     - can be specified with the usual ENV variables or IAM role
   - `secret_access_key`
     - can be specified with the usual ENV variables or IAM roles
-- options for type: 'sendmail' (email notifier)
+- options for type: **sendmail** (email notifier)
   - no custom options
-- options for type: 'smtp' (email notifier)
+- options for type: **smtp** (email notifier)
   - `address`
   - `domain`
   - `user_name`
   - `password`
-
-All of the previous email notifiers also have the following options they all use:
+- options for type: **slack**
+  - `slack_webhook_url`
+    - required
+    - more info [here](https://api.slack.com/messaging/webhooks)
+  - `slack_channel`
+    - defaults to `#general`
+    - the channel to post the backup notifications
+  - `slack_username`
+    - defaults to `Martilla`
+    - the username which backup notifications will be posted with
+
+All of the previous **email notifiers** also have the following options that can be customized:
  - `to`
    - a list of comma separated emails to be notified
  - `from`

data/lib/martilla/cli.rb

@@ -1,4 +1,3 @@
-require 'byebug'
 require 'yaml'
 require 'thor'
 
@@ -25,5 +24,10 @@ module Martilla
       file_path = File.join(Dir.pwd, filename)
       File.write(file_path, Backup.sample_config.to_yaml)
     end
+
+    desc "version", "Prints out the current version"
+    def version
+      puts VERSION
+    end
   end
 end

data/lib/martilla/version.rb

@@ -1,3 +1,3 @@
 module Martilla
-  VERSION = '0.2.1'
+  VERSION = '0.2.2'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: martilla
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.2.2
 platform: ruby
 authors:
 - Fernando Valverde
@@ -181,7 +181,8 @@ dependencies:
 description: ''
 email:
 - fdov88@gmail.com
-executables: []
+executables:
+- martilla
 extensions: []
 extra_rdoc_files: []
 files:
@@ -196,8 +197,8 @@ files:
 - README.md
 - Rakefile
 - bin/console
-- bin/martilla
 - bin/setup
+- exe/martilla
 - lib/martilla.rb
 - lib/martilla/backup.rb
 - lib/martilla/cli.rb