underway 1.0.0 → 1.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 0725b18ff63695654ff86cd63ba3d4669971a8ca
-  data.tar.gz: 2804c0a2916e847b2a7a53739c1568f94e7fcd99
+  metadata.gz: 0ee57f24ba90cd705ee45e9179174240077059c9
+  data.tar.gz: 7b354facf948869e7de7f01cdb026187fb96a005
 SHA512:
-  metadata.gz: 19914c5e32911685356e467ea190e73ac62222b939d9234c6e9180e3483d8433b1ddea0bf59fffd1990097eb5c326b5bc26d08c50a8d2fcd55179b6ded028dec
-  data.tar.gz: 1601a1f138f9dcf6ea6a709a2d272165deaff6fa1cb4a98b0c5327111a06ab912f62a391542114b6f4b9d5070d445b290577448bb0d34e109a5633d3ec909447
+  metadata.gz: 9e47816d17d724ce6442d7e3dc54e6c2b7bac2c1851b69a97d75552fb8a49772fca5c3254855014b7aeddc20f952fcfec5b9d78ee282e7dd1f3d21275b15334d
+  data.tar.gz: a475108a944742afaf76fefbf08f10917445785b85b5d6c1995205e468c04183cced8f0430c903d2a880015f913a0763b3c5052a794735c8d014dbf5a0ef14d4

data/.travis.yml

@@ -0,0 +1,5 @@
+language: ruby
+rvm:
+  - 2.3
+  - 2.4
+  - 2.5

data/CHANGELOG.md

@@ -0,0 +1,19 @@
+# Change Log
+All notable changes to this project will be documented in this file.
+This project adheres to [Semantic Versioning](http://semver.org/).
+
+## [Unreleased][unreleased]
+- Nothing
+
+## [1.0.1] - 2018-05-09
+### Fixed
+- No longer require Sinatra to be installed
+  [#4](https://github.com/jamesmartin/underway/issues/4)
+
+## 1.0.0 - 2018-03-05
+### Added
+- First release
+
+[unreleased]: https://github.com/jamesmartin/underway/compare/v1.0.1...HEAD
+[1.0.1]: https://github.com/jamesmartin/underway/compare/v1.0.0...v1.0.1
+[1.0.0]: https://github.com/jamesmartin/underway/compare/5c7f4d7d3bfc...v1.0.0

data/README.md

@@ -1,5 +1,7 @@
 # Underway
 
+[![Build Status](https://travis-ci.org/jamesmartin/underway.svg?branch=master)](https://travis-ci.org/jamesmartin/underway)
+
 Underway is a Ruby gem that helps developers quickly prototype [GitHub
 Apps](https://developer.github.com/apps/).
 
@@ -45,8 +47,10 @@ When you're done creating a new App you should have:
 - A private key file (.pem)
 - A webhook secret (optional)
 
-Make a copy of the [config.json.example]() file in a location readable by your
-application and edit the file to match your GitHub App's settings.
+Make a copy of the
+[config.json.example](https://github.com/jamesmartin/underway/blob/master/config.json.example)
+file in a location readable by your application and edit the file to match your
+GitHub App's settings.
 
 At its core, Underway is just a Ruby library and can be used in virtually any
 application.  To get started quickly and test out your new GitHub App you might
@@ -71,3 +75,33 @@ Underway::Settings.configure do |config|
   config.config_filename = "config.json"
 end
 ```
+
+## Usage
+
+The most useful part of Underway for interacting with GitHub Apps is found in
+the `Underway::Api` class.
+
+For example, right out of the box you can generate a JWT for your App:
+
+```ruby
+Underway::Api.generate_jwt
+```
+
+You can get an access token for a given installation of your App:
+
+```ruby
+installations = Underway::Api.invoke("/app/installations")
+access_token = Underway::Api.installation_token(id: installations.first.id)
+```
+
+Access tokens are cached, to save API calls. When an access token has expired a
+new one will be generated and cached.
+
+To get a list of repositories to which an installation of your App has access,
+try this:
+
+```ruby
+installations = Underway::Api.invoke("/app/installations")
+access_token = Underway::Api.installation_token(id: installations.first.id)
+repositories = Underway::Api.invoke("/installation/repositories", headers: { authorization: "token #{access_token}" })
+```

data/example/app.rb

@@ -1,5 +1,6 @@
 require "sinatra"
 require "underway"
+require "underway/sinatra"
 
 configure do
   Underway::Settings.configure do |config|

data/lib/underway/api.rb

@@ -78,5 +78,11 @@ module Underway
     def self.verbose_logging?
       !!Underway::Settings.config.verbose_logging
     end
+
+    def self.log(message)
+      if verbose_logging?
+        ::Underway::Settings.config.logger.info(message)
+      end
+    end
   end
 end

data/lib/underway/version.rb

@@ -1,3 +1,3 @@
 module Underway
-  VERSION = "1.0.0"
+  VERSION = "1.0.1"
 end

data/lib/underway.rb

@@ -3,7 +3,6 @@ require "underway/database"
 require "underway/logger"
 require "underway/sawyer_to_json"
 require "underway/settings"
-require "underway/sinatra"
 require "underway/token_cache"
 require "underway/version"
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: underway
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.0.1
 platform: ruby
 authors:
 - James Martin
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-03-05 00:00:00.000000000 Z
+date: 2018-05-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -159,6 +159,8 @@ extra_rdoc_files: []
 files:
 - ".gitignore"
 - ".ruby-version"
+- ".travis.yml"
+- CHANGELOG.md
 - Gemfile
 - LICENSE
 - README.md