better_heroku 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 7bee66aa4746a36e226976943195c0f108919bda
+  data.tar.gz: b656652bfff3acdcc4774231a2b4267bd0ed0a6e
+SHA512:
+  metadata.gz: d4f92d4b7fa0014e40893157685dcdff329a3a35603b7286b319dbabf2218a04f0388c1597aba625c9c4d4950cbcfdccde54f5a461eaa2679a1881e0d7dc1000
+  data.tar.gz: fdf5ec34f75875816ec02e6d207c9f0af1250df73fc7f15d52357772570e89db934baf9a2415dba9062bf7bb6c0352813f830563851d5144207ff380a81d1b55

data/LICENSE.md

@@ -0,0 +1,20 @@
+Copyright (c) 2017 []().
+
+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,191 @@
+# BetterHeroku
+
+[![Gem Version](https://badge.fury.io/rb/better_heroku.svg)](http://badge.fury.io/rb/better_heroku)
+
+<!-- Tocer[start]: Auto-generated, don't remove. -->
+
+# Table of Contents
+
+- [Features](#features)
+- [Requirements](#requirements)
+- [Setup](#setup)
+- [Usage](#usage)
+  - [Authentication](#authentication)
+    - [Personal API tokens](#personal-api-tokens)
+    - [OAuth tokens](#oauth-tokens)
+  - [Mocking requests](#mocking-requests)
+- [Tests](#tests)
+- [Versioning](#versioning)
+- [Code of Conduct](#code-of-conduct)
+- [Contributions](#contributions)
+- [License](#license)
+- [History](#history)
+- [Credits](#credits)
+
+<!-- Tocer[finish]: Auto-generated, don't remove. -->
+
+# Features
+
+**BetterHeroku** Is a better Heroku client gem. The official "platform-api" Heroku client gem has several issues:
+
+ * The name itself is presumptuous. No mention of Heroku, assumes there's no other platform for which there's an API.
+ * The code is auto-generated from a `schema.json` provided by Heroku themselves. The gem is not updated nearly as
+   frequently as the `schema.json`, and lags behind the published APIs.
+ * The `schema.json` itself often lags behind the published API docs, and occasionally disagrees with them.
+ * It's not obvious how to consume the documented API.
+   * The way to get the [current account][heroku-account-info] is `heroku.account.info("~")`. The only way to know this
+     is to contact Heroku support.
+   * For a url with multiple parameters, like [info for a dyno for an app][heroku-dyno-info], is requested like
+     `heroku.dyno.info(app, dyno)`. The parameters are not documented, because the code is generated.
+ * The client provides no access to the lower-level HTTP client, Excon, to enable features such as HTTP persistence, or
+   to override it for testing.
+ * The client provides no means to add logging or instrumentation of the raw requests.
+
+**BetterHeroku** attempts to solve all these problems by being a much simpler and less-opinionated implementation.
+
+[heroku-account-info]: https://devcenter.heroku.com/articles/platform-api-reference#account
+[heroku-dyno-info]:    https://devcenter.heroku.com/articles/platform-api-reference#dyno-info
+
+# Requirements
+
+0. [Ruby 2.4.0](https://www.ruby-lang.org)
+
+# Setup
+
+    gem install better_heroku
+
+Add the following to your Gemfile:
+
+    gem "better_heroku"
+
+# Usage
+
+```ruby
+client = BetterHeroku::Client.new.authenticate(token: my_token)
+resp = client.get("apps", app_id)
+resp.status #=> 200
+resp["id"]  #=> "01234567-89ab-cdef-0123-456789abcdef"
+```
+
+The client pays no attention to the segments of the url passed in, and instead just joins them with `/`. This way, it
+always matches 1:1 with the published API docs. In this example, we're using the [App Info][heroku-app-info] endpoint,
+which looks like `GET /apps/{app_id_or_name}` in the docs. Just pass in the various segments in the same order, and
+it'll work.
+
+[heroku-app-info]: https://devcenter.heroku.com/articles/platform-api-reference#app-info
+
+## Authentication
+
+**BetterHeroku** supports all the Heroku methods of authentication.
+
+### Personal API tokens
+
+Get your personal API token from the Heroku dashboard, or from the CLI:
+
+    heroku auth:token
+
+You'll get a UUID that you can use to make requests:
+
+```ruby
+client = BetterHeroku::Client.new.authenticate(token: "01234567-89ab-cdef-0123-456789abcdef")
+resp = client.get("apps", app_id)
+```
+
+In one-off scripts this is fine, but for production usage I strongly recommend you put the token in a config or
+environment variable.
+
+### OAuth tokens
+
+When making requests on behalf of other users, you'll need to use OAuth tokens. See the
+[Heroku OAuth docs][heroku-oauth-docs] for details.
+
+Once set up, you'll have your Heroku OAuth secret. In this example, we've stored it in an environment variable called
+`HEROKU_OAUTH_SECRET`. Once your users go through the web flow, you'll get back from Heroku a `token` and a
+`refresh_token`. The `token` expires after 8 hours, and the `refresh_token` never expires, and may be used to obtain a
+new token.
+
+If you're not concerned about storing the token (perhaps you only make a few requests once a day, and the token would
+have expired the next time you need it anyways), you can just authenticate with your secret and the refresh token:
+
+```ruby
+client = BetterHeroku::Client.new
+authenticated_client = client.oauth(secret: ENV["HEROKU_OAUTH_SECRET"], refresh_token: refresh_token)
+
+resp = authenticated_client.get("apps", app_id)
+```
+
+The `authenticated_client` will automatically handle refreshing the oauth token, and making requests using that. In the
+unlikely situation where that object lives longer than the token expiry, it will automatically refresh again as needed.
+
+Alternatively, the `authenticated_client` provides a callback that gets called when the refresh happens, which you can use
+to persist the token for future requests:
+
+```ruby
+authenticated_client.on_token_refresh do |response|
+  user.update_attribute(:oauth_token, response["access_token"])
+end
+```
+
+The `response` is the response body as documented in the [Heroku OAuth token refresh docs][heroku-token-refresh-docs].
+
+[heroku-oauth-docs]: https://devcenter.heroku.com/articles/oauth
+[heroku-token-refresh-docs]: https://devcenter.heroku.com/articles/oauth#token-refresh
+
+## Mocking requests
+
+You probably don't want to always make actual requests against the Heroku API, so **BetterHeroku** provides a mechanism
+to pass in the lower HTTP client. An example of what this might look like:
+
+```ruby
+let(:http) { double(HTTP) }
+
+it "should do awesome things" do
+  allow(http).to receive(:get).and_return(BetterHeroku::MockResponse.new({"id" => "01234567-89ab-cdef-0123-456789abcdef"})
+  client = BetterHeroku::Client.new(http: http)
+
+  resp = client.get("accounts", "01234567-89ab-cdef-0123-456789abcdef")
+
+  expect(resp["id"]).to eq "01234567-89ab-cdef-0123-456789abcdef"
+end
+```
+
+Also, be sure to check out the [FakeHTTP][fake-http] gem to mock the HTTP library with a Sinatra-like DSL.
+
+[fake-http]: https://github.com/paul/fake_http
+
+# Tests
+
+To test, run:
+
+    rake
+
+# Versioning
+
+Read [Semantic Versioning](http://semver.org) for details. Briefly, it means:
+
+- Patch (x.y.Z) - Incremented for small, backwards compatible, bug fixes.
+- Minor (x.Y.z) - Incremented for new, backwards compatible, public API enhancements/fixes.
+- Major (X.y.z) - Incremented for any backwards incompatible public API changes.
+
+# Code of Conduct
+
+Please note that this project is released with a [CODE OF CONDUCT](CODE_OF_CONDUCT.md). By
+participating in this project you agree to abide by its terms.
+
+# Contributions
+
+Read [CONTRIBUTING](CONTRIBUTING.md) for details.
+
+# License
+
+Copyright (c) 2017 [Paul Sadauskas](mailto:psadauskas@gmail.com).
+Read [LICENSE](LICENSE.md) for details.
+
+# History
+
+Read [CHANGES](CHANGES.md) for details.
+Built with [Gemsmith](https://github.com/bkuhlmann/gemsmith).
+
+# Credits
+
+Developed by [Paul Sadauskas](mailto:psadauskas@gmail.com)

data/lib/better_heroku.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+require "better_heroku/identity"
+
+require "better_heroku/client"
+
+module BetterHeroku
+end
+

data/lib/better_heroku/client.rb

@@ -0,0 +1,29 @@
+require "http"
+
+module BetterHeroku
+  class Client
+    ACCEPT = "application/vnd.heroku+json; version=3"
+
+    attr_reader :host, :http
+
+    def initialize(host: "https://api.heroku.com", http: HTTP)
+      @host = host
+      @http = http.headers("Accept" => ACCEPT)
+    end
+
+    def get(*parts)
+      path = [host, *parts].join("/")
+      http.get(path)
+    end
+
+    def authenticate(token: token)
+      branch http.auth("Bearer #{token}")
+    end
+
+    private
+
+    def branch(http)
+      self.class.new http: http
+    end
+  end
+end

data/lib/better_heroku/identity.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module BetterHeroku
+  # Gem identity information.
+  module Identity
+    def self.name
+      "better_heroku"
+    end
+
+    def self.label
+      "BetterHeroku"
+    end
+
+    def self.version
+      "0.0.1"
+    end
+
+    def self.version_label
+      "#{label} #{version}"
+    end
+  end
+end

metadata

@@ -0,0 +1,177 @@
+--- !ruby/object:Gem::Specification
+name: better_heroku
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Paul Sadauskas
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-02-03 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.0'
+- !ruby/object:Gem::Dependency
+  name: gemsmith
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '8.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '8.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'
+- !ruby/object:Gem::Dependency
+  name: pry-byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.4'
+- !ruby/object:Gem::Dependency
+  name: pry-state
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.5'
+- !ruby/object:Gem::Dependency
+  name: guard-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.7'
+- !ruby/object:Gem::Dependency
+  name: reek
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.5'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.46'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.46'
+description: 
+email:
+- psadauskas@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files:
+- README.md
+- LICENSE.md
+files:
+- LICENSE.md
+- README.md
+- lib/better_heroku.rb
+- lib/better_heroku/client.rb
+- lib/better_heroku/identity.rb
+homepage: https://github.com/paul/better_heroku
+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.6.8
+signing_key: 
+specification_version: 4
+summary: ''
+test_files: []