oauth2-cli 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 76187c5b942695b8ee0626735c7a762f76dba841
-  data.tar.gz: bf31d9f78aee657bfd091d96c40b81bf8bfa72a0
+  metadata.gz: 9097f026f5b1eca0dc1801e3c316c240bb768b7d
+  data.tar.gz: a2cf31e5ad4845a37034efe503da7cd78e06da87
 SHA512:
-  metadata.gz: 0dcb7367f6597f3311c5e07982e8655f234fc3100a7160193af810cc0e71c050d4b71de2589a14e2935d69fd2035e33115e9d8b6383b8db2c9ba27079603309c
-  data.tar.gz: e7bbd220f94a2e494eada6131b22481d8cef9db51ff7ff7311c229813c3686c8eb73533535a289cfa995fab884f097a4c7091a4ef6acb27311be4ac14746ef68
+  metadata.gz: 06bda1c71bcb161c6baeaab5ddc208312fc60c05346aef2bbd60e952dfa36210f1db0c1462dd6bb39d44d01ac181051374a895449fe74cbdc5b76ebc99d96c4b
+  data.tar.gz: 267d37799a50d6d48fcc5bb2c46ffe9d8f4d198bc7b561ea69e2d64b5a4bc0f6e07c4372bc5e5f692c2a3ba5c64169b3ea1640dbfd1ffe1bf41f509280880c7c

data/README.md

@@ -4,7 +4,7 @@ Command line utility to get an OAuth access token for three-legged flows where y
 
 The reason for rewriting this in Ruby was the difficulty to debug the OAuth2 flow when things don't go as expected. Go's OAuth2 library is pretty opaque and trying to figure out why for some services the client_id is not passed when sending the the token request after obtaining the authorisation code has been fruitless - even though sending the request via curl using the produced authorisation code proved successful.
 
-The purpose for this tool is to obtain access and refresh tokens for applications which run as services (i.e daemons) where doing the OAuth2 flow is a bit difficult.
+The purpose for this tool is to obtain access and refresh tokens for applications which run as services (e.g daemons) where doing the OAuth2 flow is a bit difficult. However, the scope is not limited to just this. For this use case, the `client_credentials` grant type would be more appropriate, but unfortunately not all API providers support this because they make the rather wrong assumption that all apps are used interactively. They only support `authorization_code` grant type or worse, `password` grant type.
 
 ## Install
 
@@ -14,12 +14,12 @@ gem install oauth2-cli
 
 ## Usage
 
-For services which validate the callback URL, you must use `http://127.0.0.1:8000/oauth/callback` in your OAuth2 application. Bear in mind that `8000` is the default port which may be changed via CLI argument. Adapt as necessary.
+For services which validate the callback URL, you must use `http://127.0.0.1:8000/oauth/callback` in your OAuth2 application. Bear in mind that `8000` is the default port which may be changed via CLI argument. `127.0.0.1` is the default host which may be changed via CLI argument. Adapt as necessary.
 
 The `oauth2-cli` script has a built in help:
 
 ```bash
-oauth2-cli -h
+oauth2-cli --help
 Usage: oauth2-cli --auth AUTHORISATION_URL --token TOKEN_URL --id CLIENT_ID --secret CLIENT_SECRET
 
     -a, --auth AUTHORISATION_URL     Authorisation URL (required)
@@ -28,7 +28,9 @@ Usage: oauth2-cli --auth AUTHORISATION_URL --token TOKEN_URL --id CLIENT_ID --se
     -s, --secret CLIENT_SECRET       Client secret (required)
     -o, --scope SCOPE1,SCOPE2,etc    OAuth2 scope to authorise (not used if not specified)
     -e, --separator                  OAuth2 scope separator character (defaults to space) n.b the scope arg is always passed as array and joined with the separator char for the request
+    -h, --host 127.0.0.1             Callback host (defaults to 127.0.0.1) n.b this allows you to run this tool on a remote machine and have the authorisation code go there; the callback HTTP server always binds to all available network interfaces irrespective of this value
     -p, --port 8000                  Callback port (defaults to 8000)
+    -w, --write                      Write the returned token as JSON using TOKEN_URL as filename with the current working directory being the destination
     -d, --debug                      Turn on OAuth2 library debug and WEBrick log
 ```
 

data/bin/oauth2-cli

@@ -1,6 +1,8 @@
 #!/usr/bin/env ruby
 
 require 'pp'
+require 'uri'
+require 'json'
 require 'oauth2'
 require 'webrick'
 require 'optparse'
@@ -51,12 +53,28 @@ optp = OptionParser.new do |opts|
     options[:separator] = opt
   end
 
+  options[:host] = '127.0.0.1'
+  desc_host = 'Callback host (defaults to 127.0.0.1) n.b this allows you to '\
+    'run this tool on a remote machine and have the authorisation code go '\
+    'there; the callback HTTP server always binds to all available network '\
+    'interfaces irrespective of this value'
+  opts.on('-h', '--host 127.0.0.1', String, desc_host) do |opt|
+    options[:host] = opt
+  end
+
   options[:port] = 8000
   desc_port = 'Callback port (defaults to 8000)'
   opts.on('-p', '--port 8000', Integer, desc_port) do |opt|
     options[:port] = opt
   end
 
+  options[:write] = false
+  desc_write = 'Write the returned token as JSON using TOKEN_URL as filename '\
+    'with the current working directory being the destination'
+  opts.on('-w', '--write', desc_write) do
+    options[:write] = true
+  end
+
   options[:debug] = false
   opts.on('-d', '--debug', 'Turn on OAuth2 library debug and WEBrick log') do
     ENV['OAUTH_DEBUG'] = 'true'
@@ -70,11 +88,12 @@ required.each do |arg|
   next unless options[arg].nil?
 
   STDERR.puts "Error: missing required argument #{arg}. "\
-    "See #{src} -h for help."
+    "See #{src} --help for help."
   exit 1
 end
 
-redirect_uri = "http://127.0.0.1:#{options[:port]}#{path}"
+token_uri = URI(options[:token])
+redirect_uri = "http://#{options[:host]}:#{options[:port]}#{path}"
 client = OAuth2::Client.new(
   options[:id],
   options[:secret],
@@ -133,6 +152,8 @@ server.mount_proc('/') do |req, res|
   pp token.to_hash
   puts ''
 
+  File.write("#{token_uri.host}.json", token.to_hash.to_json) if options[:write]
+
   res.status = 200
   res.body = 'You may now close this tab'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: oauth2-cli
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Ștefan Rusu
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-01-05 00:00:00.000000000 Z
+date: 2019-01-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: oauth2