pgbackups-archive 0.2.4 → 0.3.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (5) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +24 -7
  3. data/lib/pgbackups-archive/storage.rb +1 -1
  4. data/lib/pgbackups-archive/version.rb +1 -1
  5. metadata +12 -12
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA1:
3
- metadata.gz: f806f78dfc8d3856f64c3c4b4cbb2656b7e7d41d
4
- data.tar.gz: 57b146e34300a139c189c5d7381af3796432c600
3
+ metadata.gz: 0b1dfe7b8843a859e5eff6c7bac691d919a647d0
4
+ data.tar.gz: 506782bd0780f16a5a2ea1c9729aa74d8065b486
5
5
  SHA512:
6
- metadata.gz: 40efaa65e3b52c11be88c7cf7f51d19df733d5f9ee9a6c62a0e3918be4e60b7cb6d9841ac1ae14865f1963f1d0e31b1d487ffef851a39f31807bb57aa4b6d30e
7
- data.tar.gz: df8ce9a6232c89fd6c22f592b522b23e6674904df791d95f35193d05744446b389280e626d1be0135640c24cb9830904f79284e3d518fe4bac43d8937beee540
6
+ metadata.gz: 0edd75f6f73cbd37b5fd5be1e6c78a2c517c7c28841cead96a6c4489951cdd806c5d04792ec5bd4f05a97018c2aa685bef884b6617bad32a808d5e0a806f3c13
7
+ data.tar.gz: a7e4855f4e3f3541457d7cc0356b9972bdd4f710d013caf9aa35e460f46964d5b99eb4e5b24b0fee3fd8232486abd6b20777c52748e7cc1928b7fe79f969fc34
data/README.md CHANGED
@@ -3,7 +3,7 @@
3
3
  [![Gem Version](https://badge.fury.io/rb/pgbackups-archive.svg)](http://badge.fury.io/rb/pgbackups-archive)
4
4
  [![Code Climate](https://codeclimate.com/github/kjohnston/pgbackups-archive/badges/gpa.svg)](https://codeclimate.com/github/kjohnston/pgbackups-archive)
5
5
 
6
- A means of automating Heroku's pgbackups and archiving them to Amazon S3 via the `fog` gem.
6
+ A means of automating Heroku's pgbackups and archiving them to Amazon S3.
7
7
 
8
8
  ## Overview
9
9
 
@@ -19,6 +19,8 @@ You can configure retention settings at the Amazon S3 bucket level from within t
19
19
 
20
20
  #### Option 1 - Add `pgbackups-archive` to your existing application
21
21
 
22
+ Recommended for apps with light memory usage.
23
+
22
24
  Add the gem to your Gemfile and bundle:
23
25
 
24
26
  gem "pgbackups-archive"
@@ -26,11 +28,23 @@ Add the gem to your Gemfile and bundle:
26
28
 
27
29
  #### Option 2 - Add `pgbackups-archive` to a standalone application
28
30
 
29
- * Create a new Heroku application to dedicate to backing up your database.
30
- * Clone [pgackups-archive-app](https://github.com/kbaum/pgbackups-archive-app) push to your new Heroku app.
31
- * Add a `PGBACKUPS_DATABASE_URL` environment variable to your backup app that points to your main app's `DATABASE_URL`, or other follower URL, so that `pgbackups-archive` knows which database to backup.
31
+ Recommended for apps with heavier memory usage.
32
+
33
+ * Create a new repo with `pgackups-archive` added to that app's Gemfile and push
34
+ it to a new Heroku app.
35
+ * Ensure the `PGBACKUPS_DATABASE_URL` environment variable you set for your
36
+ backup app points to your main app's `DATABASE_URL`, or other follower URL, so
37
+ that `pgbackups-archive` in your backup app knows to backup your real app's
38
+ database.
32
39
 
33
- This option is generally recommended over Option 1, particularly if your application has larger slug size and therefore higher memory requirements. This is because the streaming download & upload of the backup file will utilize a certain amount of memory beyond what an instance of your application uses and if you're close to the threshold of your Dyno size as it is, this increment could put the instance over the limit and cause it to encounter a memory allocation error. By running a dedicated Heroku app to run `pgbackups-archive` the task will have ample room at the 1X Dyno level to stream the backup files.
40
+ This option exists because the streaming download & upload of the backup file
41
+ will utilize a certain amount of memory beyond what an instance of your
42
+ application uses and if you're close to the threshold of your Dyno size as it
43
+ is, this increment could put the instance over the limit and cause it to
44
+ encounter [memory allocation errors](https://devcenter.heroku.com/articles/error-codes#r14-memory-quota-exceeded).
45
+ By running a dedicated Heroku app to run
46
+ `pgbackups-archive` the task will have ample room at the 1X Dyno level to stream
47
+ the backup files.
34
48
 
35
49
  ### Install Heroku addons
36
50
 
@@ -68,7 +82,7 @@ require "pgbackups-archive"
68
82
 
69
83
  ## Testing
70
84
 
71
- This gem uses [thincloud-test](https://github.com/newleaders/thincloud-test) to manage its test suite configuration. This provides MiniTest, Guard and friends. To run the test suite, use the `guard` command and save a file or hit enter to run the full suite.
85
+ To run the test suite, use the `guard` command and save a file or hit enter to run the full suite.
72
86
 
73
87
  Use the [pgbackups-archive-dummy](https://github.com/kjohnston/pgbackups-archive-dummy) test harness to setup a dummy database on Heroku to test against.
74
88
 
@@ -97,8 +111,11 @@ Many thanks go to the following who have contributed to making this gem even bet
97
111
  * Streaming support to handle large backup files.
98
112
  * [Conroy Whitney (@conroywhitney)](https://github.com/conroywhitney)
99
113
  * Use S3 server-side encryption by default
114
+ * [Chris Gaffney (@gaffneyc)](https://github.com/gaffneyc)
115
+ * Switch from fog to fog-aws.
116
+ * Gem config improvements.
100
117
 
101
118
  ## License
102
119
 
103
120
  * Freely distributable and licensed under the [MIT license](http://kjohnston.mit-license.org/license.html).
104
- * Copyright (c) 2012-2013 Kenny Johnston [![endorse](http://api.coderwall.com/kjohnston/endorsecount.png)](http://coderwall.com/kjohnston)
121
+ * Copyright (c) 2012-2015 Kenny Johnston [![endorse](http://api.coderwall.com/kjohnston/endorsecount.png)](http://coderwall.com/kjohnston)
data/lib/pgbackups-archive/storage.rb CHANGED
@@ -1,4 +1,4 @@
1
- require "fog"
1
+ require "fog/aws"
2
2
  require "open-uri"
3
3
 
4
4
  class PgbackupsArchive::Storage
data/lib/pgbackups-archive/version.rb CHANGED
@@ -1,3 +1,3 @@
1
1
  module PgbackupsArchive
2
- VERSION = "0.2.4"
2
+ VERSION = "0.3.0"
3
3
  end
metadata CHANGED
@@ -1,17 +1,17 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: pgbackups-archive
3
3
  version: !ruby/object:Gem::Version
4
- version: 0.2.4
4
+ version: 0.3.0
5
5
  platform: ruby
6
6
  authors:
7
7
  - Kenny Johnston
8
8
  autorequire:
9
9
  bindir: bin
10
10
  cert_chain: []
11
- date: 2014-11-22 00:00:00.000000000 Z
11
+ date: 2015-01-20 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
- name: bundler
14
+ name: fog-aws
15
15
  requirement: !ruby/object:Gem::Requirement
16
16
  requirements:
17
17
  - - ">="
@@ -25,41 +25,41 @@ dependencies:
25
25
  - !ruby/object:Gem::Version
26
26
  version: '0'
27
27
  - !ruby/object:Gem::Dependency
28
- name: fog
28
+ name: heroku
29
29
  requirement: !ruby/object:Gem::Requirement
30
30
  requirements:
31
31
  - - ">="
32
32
  - !ruby/object:Gem::Version
33
- version: '0'
33
+ version: 2.34.0
34
34
  type: :runtime
35
35
  prerelease: false
36
36
  version_requirements: !ruby/object:Gem::Requirement
37
37
  requirements:
38
38
  - - ">="
39
39
  - !ruby/object:Gem::Version
40
- version: '0'
40
+ version: 2.34.0
41
41
  - !ruby/object:Gem::Dependency
42
- name: heroku
42
+ name: rake
43
43
  requirement: !ruby/object:Gem::Requirement
44
44
  requirements:
45
45
  - - ">="
46
46
  - !ruby/object:Gem::Version
47
- version: 2.34.0
47
+ version: '0'
48
48
  type: :runtime
49
49
  prerelease: false
50
50
  version_requirements: !ruby/object:Gem::Requirement
51
51
  requirements:
52
52
  - - ">="
53
53
  - !ruby/object:Gem::Version
54
- version: 2.34.0
54
+ version: '0'
55
55
  - !ruby/object:Gem::Dependency
56
- name: rake
56
+ name: bundler
57
57
  requirement: !ruby/object:Gem::Requirement
58
58
  requirements:
59
59
  - - ">="
60
60
  - !ruby/object:Gem::Version
61
61
  version: '0'
62
- type: :runtime
62
+ type: :development
63
63
  prerelease: false
64
64
  version_requirements: !ruby/object:Gem::Requirement
65
65
  requirements:
@@ -190,7 +190,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
190
190
  version: '0'
191
191
  requirements: []
192
192
  rubyforge_project:
193
- rubygems_version: 2.4.2
193
+ rubygems_version: 2.4.5
194
194
  signing_key:
195
195
  specification_version: 4
196
196
  summary: Automates archival of Heroku's pgbackups to S3