safety_net_heroku 1.0.1 → 1.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3d980c0aecf55ecccff0fe9699cadb2df3fa403923c68509fea4b0b4294ff847
-  data.tar.gz: 17bed72bc17641f432ec2f70e87f4b614674ba734000a51c46b4705472673183
+  metadata.gz: 0bde90f66614acbce4d3b9b7e8a0ee25e31275c0b624bfa04f0186b7a14a464b
+  data.tar.gz: 6e022e24f351c98211fbdce14205ff5f0c0551b810215ec9069f1a7f5c660c3f
 SHA512:
-  metadata.gz: aee358e251a00bfb6372333ca5a71f3687ecb803ca431100b4da5c7636711c04bf214247b9a8a887485b981a6610963fb993e253a5c43c01967f81d3844b5ab1
-  data.tar.gz: 47a8567c08419e1f8779c76cae1bd1267052659c42d8511fc1676add7bc0a13843c2e2af06a6aec9c22e1f5f7dfdd11965c67fa50f72c1d4f9174eb69a84b467
+  metadata.gz: 460ad3c85f4d4dbad723eb75dc953e65100c2f53bdfba25a1ad641ff7143305602f5658367eed1cc1c6063d2c685a53c08297fbdf68a8a7c6087f2da637b7345
+  data.tar.gz: 10a6b195697c9518fcbcd44625187febd919365f23838465334e022d44bf1715af28a054b2f88b38ddbf3e7a0d1fe9f4caf04d6503636e5ed115d6f1cf0fafe1

data/README.md

@@ -1,39 +1,48 @@
-# SafetyNetHeroku
-
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/safety_net_heroku`. To experiment with that code, run `bin/console` for an interactive prompt.
-
-TODO: Delete this and the text above, and describe your gem
+A simple gem for backing up a MongoDB database to AWS when hosted on Heroku using a Sidekiq worker.
 
 ## Installation
 
-Add this line to your application's Gemfile:
-
 ```ruby
 gem 'safety_net_heroku'
 ```
 
-And then execute:
+## Usage
 
-    $ bundle
+Create a new Safety Net Heroku initializer:
 
-Or install it yourself as:
+```ruby
+# safety_net_heroku.rb
 
-    $ gem install safety_net_heroku
+SafetyNetHeroku.config[:database_name] = 'database_name'
+SafetyNetHeroku.config[:aws_region] = 's3_region'
+SafetyNetHeroku.config[:aws_bucket] = 's3_bucket'
+SafetyNetHeroku.config[:aws_backups_directory] = s3_directory'
 
-## Usage
+```
 
-TODO: Write usage instructions here
+In your sidekiq initializer, import the Sidekiq worker:
 
-## Development
+```ruby
+# sidekiq.rb
+
+require 'safety_net_heroku/backup_database_worker'
+```
+Add the worker to your sidekiq schedule as a cron job:
 
-After checking out the repo, run `bin/setup` to install dependencies. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+```ruby
+# sidekiq_schedule.yml
+
+backup_database:
+  cron: "0 3 * * *"
+  class: "SafetyNetHeroku::BackupDatabaseWorker"
+```
 
-To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+#### Your database will now be backed up to the AWS directory specified periodically based on your cron settings! 🎉
 
-## Contributing
+## Author
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/safety_net_heroku.
+Dalton Hinterscher, daltonhint4@gmail.com
 
 ## License
 
-The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+Safety Net Heroku is available under the MIT license. See the LICENSE file for more info.

data/lib/safety_net_heroku.rb

@@ -1,5 +1,4 @@
 require "safety_net_heroku/version"
-#require "safety_net_heroku/backup_database_worker"
 
 module SafetyNetHeroku
   def self.config

data/lib/safety_net_heroku/version.rb

@@ -1,3 +1,3 @@
 module SafetyNetHeroku
-  VERSION = "1.0.1"
+  VERSION = "1.0.2"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: safety_net_heroku
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 1.0.2
 platform: ruby
 authors:
 - daltron