heroku-postgres 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 108013517e3988f1fa34af6d42c0120fa5d4f42e
+  data.tar.gz: 56fec2f6854e863a0a46e46f88e220d72ed8a004
+SHA512:
+  metadata.gz: de79699b8a7b51ad3c2d4b465bdba091dbdd40ba9aa5d661617c586f00a33b789356360bd4b464b29cc52d7b92054ebb44c6169f1899a9b118258f71965eb252
+  data.tar.gz: 39972ea78c1130c093ba6959da344443196c5abcfb4fa91d1d3133e0b84f4ff6ae72a89d723da53e306189b0e90d9d356044af855a495ce9977b3815996e154a

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.ruby-version

@@ -0,0 +1 @@
+ruby-2.2.2

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,28 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, we pledge to respect all
+people who contribute through reporting issues, posting feature requests,
+updating documentation, submitting pull requests or patches, and other
+activities.
+
+We are committed to making participation in this project a harassment-free
+experience for everyone, regardless of level of experience, gender, gender
+identity and expression, sexual orientation, disability, personal appearance,
+body size, race, age, or religion.
+
+Examples of unacceptable behavior by participants include the use of sexual
+language or imagery, derogatory comments or personal attacks, trolling, public
+or private harassment, insults, or other unprofessional conduct.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct. Project maintainers who do not
+follow the Code of Conduct may be removed from the project team.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by opening an issue or contacting one or more of the project
+maintainers.
+
+This Code of Conduct is adapted from the [Contributor
+Covenant](http:contributor-covenant.org), version 1.0.0, available at
+[http://contributor-covenant.org/version/1/0/0/](http://contributor-covenant.org/version/1/0/0/)

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in heroku-postgres.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Nick Charlton
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,69 @@
+# heroku-postgres
+
+This provides a Ruby client to [Heroku][]'s [Postgres][] service. It's been
+partially extracted from the [Heroku command line client][heroku-cli] as it's
+otherwise not documented.
+
+It was primarily built to automate creating backups for usage elsewhere. It's
+initially limited to just being able to do this, so if there's something
+missing, open an issue. It's also pretty lacking in tests for similar reasons.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'heroku-postgres'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install heroku-postgres
+
+## Usage
+
+```ruby
+require 'heroku/postgres'
+
+# login (return a client object, but you don't need that directly)
+Heroku::Postgres.login('username', 'password')
+
+# find the database by app name and database name
+db = Heroku::Postgres.find('app-name', 'db-name')
+
+# have a look at the current backups
+db.backups
+# => [<Heroku::Postgres::Backup id=abc>]
+
+# capture a backup, waiting for completion
+# optionally, pass true to poll until complete
+backup = db.capture_backup(true)
+
+# or, pass a block to monitor the response whilst it's created
+backup = db.capture_backup(true) do |backup|
+  puts backup
+end
+
+# generate a public url so you can fetch the file
+backup.public_url
+```
+
+## Contributing
+
+1. Fork it ( https://github.com/nickcharlton/heroku-postgres/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request
+
+## Author
+
+Copyright (c) 2015 Nick Charlton <nick@nickcharlton.net>.
+
+[Heroku]: https://www.heroku.com/home
+[Postgres]: https://www.heroku.com/postgres
+[heroku-cli]: https://github.com/heroku/heroku

data/Rakefile

@@ -0,0 +1,6 @@
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/bin/console

@@ -0,0 +1,7 @@
+#!/usr/bin/env ruby
+
+require 'bundler/setup'
+require 'heroku/postgres'
+
+require 'pry'
+Pry.start

data/bin/setup

@@ -0,0 +1,5 @@
+#!/bin/bash
+set -euo pipefail
+IFS=$'\n\t'
+
+bundle install

data/heroku-postgres.gemspec

@@ -0,0 +1,29 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'heroku/postgres/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'heroku-postgres'
+  spec.version       = Heroku::Postgres::VERSION
+  spec.authors       = ['Nick Charlton']
+  spec.email         = ['nick@nickcharlton.net']
+
+  spec.summary       = 'Ruby library for interacting with Heroku Postgres.'
+  spec.description   = 'Ruby library for interacting with Heroku Postgres.'
+  spec.homepage      = 'https://github.com/nickcharlton/heroku-postgres'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.require_paths = ['lib']
+
+  spec.add_dependency 'excon', '~> 0.45'
+  spec.add_dependency 'json', '~> 1.8'
+
+  spec.add_development_dependency 'bundler', '~> 1.8'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.2'
+  spec.add_development_dependency 'pry', '~> 0.10'
+end

data/lib/heroku-postgres.rb

@@ -0,0 +1 @@
+require 'heroku/postgres'

data/lib/heroku/postgres.rb

@@ -0,0 +1,45 @@
+require 'excon'
+require 'json'
+require 'base64'
+
+require 'heroku/postgres/version'
+require 'heroku/postgres/client'
+require 'heroku/postgres/resource'
+require 'heroku/postgres/backup'
+require 'heroku/postgres/database'
+
+# A container for Heroku extensions.
+module Heroku
+  # A container for Postgres.
+  module Postgres
+    attr_accessor :client, :pg_client
+
+    def self.client
+      @client
+    end
+
+    def self.pg_client
+      @pg_client
+    end
+
+    # Login to Heroku Postgres.
+    #
+    # This also configures the clients for both of the APIs we're talking to.
+    def self.login(username, password)
+      @client = Client.new(username: username, password: password)
+      @client.login
+
+      # setup the Heroku Postgres client
+      @pg_client = Client.new(url: 'https://postgres-api.heroku.com',
+                              username: username, password: password)
+      @pg_client.token = @client.token
+
+      @client
+    end
+
+    # A shortcut for finding databases.
+    def self.find(app_name, db_name)
+      Database.find(app_name, db_name)
+    end
+  end
+end

data/lib/heroku/postgres/backup.rb

@@ -0,0 +1,77 @@
+module Heroku
+  module Postgres
+    # Representation and handling of Backup objects
+    class Backup < Resource
+      attr_accessor :app
+
+      attr_accessor :uuid, :num, :from_name, :from_type, :from_url, :to_name,
+                    :to_type, :to_url, :options, :source_bytes,
+                    :processed_bytes, :succeeded, :created_at, :started_at,
+                    :canceled_at, :updated_at, :finished_at, :deleted_at,
+                    :purged_at, :num_keep
+
+      def self.find(app_name, backup_name)
+        response = Postgres.pg_client.get("/apps/#{app_name}/transfers/"\
+                                          "#{backup_name}?verbose=true")
+
+        backup = new(JSON.parse(response.body))
+        backup.app = app_name
+
+        backup
+      end
+
+      def self.all_for_app(app_name)
+        response = Postgres.pg_client.get("/apps/#{app_name}/transfers")
+
+        # build backup objects, but only those generated with pg_dump
+        backups = JSON.parse(response.body).collect do |c|
+          next if c['from_type'] != 'pg_dump'
+
+          backup = new(c)
+          backup.app = app_name
+
+          backup
+        end.compact!
+
+        backups
+      end
+
+      def self.capture(app_name, db_name, poll = false, &block)
+        response = Postgres.pg_client.post("/databases/#{db_name}/backups")
+
+        backup = new(JSON.parse(response.body))
+        backup.app = app_name
+
+        if poll
+          finished_at = nil
+
+          until finished_at
+            sleep(5) # stop for 5s
+            backup.reload
+            finished_at = backup.finished_at
+
+            yield backup if block_given?
+          end
+        end
+
+        backup
+      end
+
+      def reload
+        response = Postgres.pg_client.get("/apps/#{app}/transfers/#{uuid}")
+        update_with_response(response.body)
+
+        self
+      end
+
+      # Generate a public URL for accessing this backup.
+      def public_url
+        response = Postgres.pg_client.post("/apps/#{app}/transfers/#{num}"\
+                                           '/actions/public-url')
+
+        hash = JSON.parse(response.body)
+        hash['url']
+      end
+    end
+  end
+end

data/lib/heroku/postgres/client.rb

@@ -0,0 +1,74 @@
+module Heroku
+  module Postgres
+    # Client for interacting with Heroku & Heroku's Postgres API.
+    class Client
+      DEFAULT_HEADERS = { 'User-Agent' => 'Heroku-Postgres/v' \
+                                          "#{Heroku::Postgres::VERSION}" }
+
+      attr_accessor :url, :username, :password, :token
+
+      def initialize(opts = {})
+        @url = opts.fetch(:url, 'https://api.heroku.com')
+        @username = opts.fetch(:username, {})
+        @password = opts.fetch(:password, {})
+      end
+
+      # Login on behalf of the user.
+      #
+      # This is necessary to setup the class correctly so that the API key can
+      # be used.
+      #
+      # @return [String] the Heroku API key
+      def login
+        response = login_request(username, password)
+
+        hash = JSON.parse(response.body)
+        @token = hash['api_key']
+      end
+
+      %w(get post put delete).each do |m|
+        define_method m do |path, opts = {}|
+          request(m.to_sym, path, opts)
+        end
+      end
+
+      private
+
+      def login_request(username, password)
+        Excon.post('https://api.heroku.com/login',
+                   headers: DEFAULT_HEADERS,
+                   query: { username: username, password: password },
+                   expects: [200])
+      end
+
+      def request(method, path, opts = {})
+        body, query, headers = parse_opts(opts)
+
+        # set the default headers
+        headers.merge!(DEFAULT_HEADERS)
+
+        # set the authentication header
+        headers['Authorization'] = "Basic #{authentication_header}"
+
+        connection = Excon.new(@url)
+        connection.request(method: method, path: "/client/v11#{path}",
+                           body: body, query: query, headers: headers)
+      end
+
+      def parse_opts(opts)
+        # this might actually want to be a form
+        body = opts.fetch(:body, nil)
+        body = JSON.dump(body) if body && body.is_a?(Hash)
+
+        query = opts.fetch(:query, {})
+        headers = opts.fetch(:headers, {})
+
+        [body, query, headers]
+      end
+
+      def authentication_header
+        Base64.urlsafe_encode64("#{@username}:#{@token}")
+      end
+    end
+  end
+end

data/lib/heroku/postgres/database.rb

@@ -0,0 +1,29 @@
+module Heroku
+  module Postgres
+    # Representation and handling of Database objects
+    class Database < Resource
+      attr_accessor :app, :db
+      attr_accessor :database_name, :database_user, :database_password,
+                    :resource_url
+
+      def self.find(app_name, db_name)
+        response = Postgres.pg_client.get("/databases/#{db_name}")
+
+        db = new(JSON.parse(response.body))
+
+        db.db = db_name
+        db.app = app_name
+
+        db
+      end
+
+      def capture_backup(poll = false, &block)
+        Backup.capture(app, db, poll, &block)
+      end
+
+      def backups
+        Backup.all_for_app(app)
+      end
+    end
+  end
+end

data/lib/heroku/postgres/resource.rb

@@ -0,0 +1,29 @@
+module Heroku
+  module Postgres
+    # Base class for representing resources.
+    class Resource
+      def initialize(hash = {})
+        hash.each { |k, v| send("#{k}=", v) if respond_to?("#{k}=") }
+      end
+
+      def update_with_response(o, except_key = [])
+        hash = JSON.parse(o)
+
+        # remove keys that shouldn't be included
+        except_key.each { |k| hash.delete(k) }
+
+        hash.each { |k, v| send("#{k}=", v) if respond_to?("#{k}=") }
+      end
+
+      def to_hash
+        attrs = instance_variables.map { |v| v.to_s.sub(/^@/, '') }
+        Hash[attrs.select { |v| respond_to? v }.map { |v| [v.to_sym, send(v)] }]
+      end
+
+      def inspect
+        objects = to_hash.map { |k, v| "#{k}=#{v.inspect}" }.join(' ')
+        "#<#{self.class.name}:#{object_id} #{objects}>"
+      end
+    end
+  end
+end

data/lib/heroku/postgres/version.rb

@@ -0,0 +1,5 @@
+module Heroku
+  module Postgres
+    VERSION = '1.0.0'
+  end
+end

metadata

@@ -0,0 +1,145 @@
+--- !ruby/object:Gem::Specification
+name: heroku-postgres
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Nick Charlton
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-07-15 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: excon
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.45'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.45'
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.2'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.10'
+description: Ruby library for interacting with Heroku Postgres.
+email:
+- nick@nickcharlton.net
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".ruby-version"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- heroku-postgres.gemspec
+- lib/heroku-postgres.rb
+- lib/heroku/postgres.rb
+- lib/heroku/postgres/backup.rb
+- lib/heroku/postgres/client.rb
+- lib/heroku/postgres/database.rb
+- lib/heroku/postgres/resource.rb
+- lib/heroku/postgres/version.rb
+homepage: https://github.com/nickcharlton/heroku-postgres
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.5
+signing_key: 
+specification_version: 4
+summary: Ruby library for interacting with Heroku Postgres.
+test_files: []