underway 1.0.1 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 0ee57f24ba90cd705ee45e9179174240077059c9
-  data.tar.gz: 7b354facf948869e7de7f01cdb026187fb96a005
+  metadata.gz: ea67c9db9aa37c2b89c6b4e6c5d70c96808a0628
+  data.tar.gz: 2e44144648905e30991c8e561f2b6e86073804e2
 SHA512:
-  metadata.gz: 9e47816d17d724ce6442d7e3dc54e6c2b7bac2c1851b69a97d75552fb8a49772fca5c3254855014b7aeddc20f952fcfec5b9d78ee282e7dd1f3d21275b15334d
-  data.tar.gz: a475108a944742afaf76fefbf08f10917445785b85b5d6c1995205e468c04183cced8f0430c903d2a880015f913a0763b3c5052a794735c8d014dbf5a0ef14d4
+  metadata.gz: 940689feca04bf0f6eaa358920d22b60039b1e001fb10da571171ca9547693eda20427b83854ff56757e696f1dc4d9cba28bb969e4815817cf8875d18b3643d3
+  data.tar.gz: '020818b8d5c4a3b06aca9e77efecc4c04a2ac5a0e1eec7bf05f4bda408c77e385d89737e7a7c545c6f462928e8d11f01fb3a9d06404b57c8c0ac9784503a4ad6'

data/.travis.yml

@@ -3,3 +3,5 @@ rvm:
   - 2.3
   - 2.4
   - 2.5
+before_install:
+  - gem install -v 2.0.1 bundler --no-rdoc --no-ri

data/CHANGELOG.md

@@ -5,6 +5,15 @@ This project adheres to [Semantic Versioning](http://semver.org/).
 ## [Unreleased][unreleased]
 - Nothing
 
+## [1.1.0] - 2019-05-21
+### Added
+- `Underway::Api.client_for` helper that returns a configured `Octokit` client
+  for a given installation ID or access token
+
+### Fixed
+- Make Underway work for GHES
+  [#7](https://github.com/jamesmartin/underway/pulls/7)
+
 ## [1.0.1] - 2018-05-09
 ### Fixed
 - No longer require Sinatra to be installed
@@ -14,6 +23,7 @@ This project adheres to [Semantic Versioning](http://semver.org/).
 ### Added
 - First release
 
-[unreleased]: https://github.com/jamesmartin/underway/compare/v1.0.1...HEAD
+[unreleased]: https://github.com/jamesmartin/underway/compare/v1.1.0...HEAD
+[1.1.0]: https://github.com/jamesmartin/underway/compare/v1.0.1...v1.1.0
 [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

@@ -16,6 +16,12 @@ access token for your App and its installations. Starting with a Sinatra
 application is a fast way to build a GitHub App prototype and explore how
 GitHub Apps work with the GitHub REST API.
 
+## Changelog
+
+This project adheres to [Semantic Versioning](http://semver.org). All notable
+changes are documented in the
+[CHANGELOG](https://github.com/jamesmartin/underway/blob/master/CHANGELOG.md).
+
 ## Installation
 
 Add this line to your application's Gemfile:
@@ -90,7 +96,7 @@ Underway::Api.generate_jwt
 You can get an access token for a given installation of your App:
 
 ```ruby
-installations = Underway::Api.invoke("/app/installations")
+installations = Underway::Api.invoke("app/installations")
 access_token = Underway::Api.installation_token(id: installations.first.id)
 ```
 
@@ -101,7 +107,7 @@ To get a list of repositories to which an installation of your App has access,
 try this:
 
 ```ruby
-installations = Underway::Api.invoke("/app/installations")
+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}" })
+repositories = Underway::Api.invoke("installation/repositories", headers: { authorization: "token #{access_token}" })
 ```

data/lib/underway/api.rb

@@ -28,6 +28,20 @@ module Underway
       end
     end
 
+    def self.client_for(installation_id: nil, access_token: nil)
+      token = access_token
+      if !installation_id.nil?
+        token = installation_token(id: installation_id)
+      end
+
+      return if token.nil?
+
+      client = Octokit::Client.new(
+        api_endpoint: Underway::Settings.config.raw["github_api_host"],
+        access_token: token
+      )
+    end
+
     def self.generate_jwt
       payload = {
         # Issued at time:
@@ -49,7 +63,7 @@ module Underway
       else
         log("token cache: miss")
         res = invoke(
-          "/app/installations/#{id}/access_tokens",
+          "app/installations/#{id}/access_tokens",
           method: :post
         )
 

data/lib/underway/settings.rb

@@ -1,3 +1,4 @@
+require "addressable/uri"
 require "pathname"
 require "json"
 
@@ -74,6 +75,25 @@ module Underway
       def token_cache
         @token_cache ||= Underway::TokenCache.new(db)
       end
+
+      def oauth_authorize_url
+        uri = Addressable::URI.parse(config["github_api_host"])
+        "#{uri.scheme}://#{uri.domain}/login/oauth/authorize?client_id=#{config["client_id"]}"
+      end
+
+      def oauth_access_token_url(code)
+        api_host = Addressable::URI.parse(config["github_api_host"])
+        template = Addressable::Template.new(
+          "{scheme}://{host}/login/oauth/access_token{?code,client_id,client_secret}"
+        )
+        template.expand(
+          "scheme" => api_host.scheme,
+          "host" => api_host.domain,
+          "code" => code,
+          "client_id" => config["client_id"],
+          "client_secret" => config["client_secret"]
+        )
+      end
     end
 
     @configuration = Configuration.new

data/lib/underway/version.rb

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

data/underway.gemspec

@@ -18,13 +18,14 @@ Gem::Specification.new do |spec|
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ["lib"]
 
-  spec.add_development_dependency "bundler", "~> 1.16"
+  spec.add_development_dependency "bundler", "~> 2.0"
   spec.add_development_dependency "minitest"
   spec.add_development_dependency "pry"
   spec.add_development_dependency "rake"
   spec.add_development_dependency "sinatra"
   spec.add_development_dependency "timecop"
 
+  spec.add_runtime_dependency "addressable", "~> 2.3"
   spec.add_runtime_dependency "jwt", "~> 2.1"
   spec.add_runtime_dependency "octokit", "~> 4.0"
   spec.add_runtime_dependency "sequel"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: underway
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 1.1.0
 platform: ruby
 authors:
 - James Martin
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-05-08 00:00:00.000000000 Z
+date: 2019-05-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.16'
+        version: '2.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.16'
+        version: '2.0'
 - !ruby/object:Gem::Dependency
   name: minitest
   requirement: !ruby/object:Gem::Requirement
@@ -94,6 +94,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: addressable
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.3'
 - !ruby/object:Gem::Dependency
   name: jwt
   requirement: !ruby/object:Gem::Requirement