Merge branch 'release/0.2'

Author: Daisuke Miyamoto

README.md

@@ -3,17 +3,22 @@ aurl
 
 ## Description
 
-HTTP CLI client with OAuth2 authentication
+HTTP CLI client with OAuth 2.0 authentication.
 
-curl is powerful command line tool and you can make any complex HTTP request to every servers.  But the target web
-server is secured by OAuth2, you must request another HTTP request to the authorization server before making
-principal request.  And more, you should to manage issued access tokens for every resources.
+You know `curl` is powerful command line tool and you can make any complex HTTP request to every servers.  But the target web server is secured by OAuth 2.0, you must send another HTTP request to the authorization server before making principal request.  And more, you should to manage issued access tokens for every resources.
 
-aurl is auto processing OAuth dance and manage access/refresh tokens.
+`aurl` is a command-line tool that process OAuth 2.0 dance and manage access/refresh tokens automatically.
+
+**Note:** Currently, `aurl` is not support OAuth 1.0a.  Your pull-request is appreciated.
 
 ## Install
 
-To install, use `go get`:
+To install, use `homebrew` or `go get`:
+
+```bash
+$ brew tap classmethod-aws/cm
+$ brew install aurl
+```
 
 ```bash
 $ go get -d github.com/classmethod-aws/aurl
@@ -23,10 +28,29 @@ $ go get -d github.com/classmethod-aws/aurl
 
 ### Profile configuration
 
-First, you MUST create profile setting file `~/.aurl/profiles` file which format is described below.
+First, you must create profile setting file `~/.aurl/profiles` file which format is described below.
 Profile setting file format is typically called [INI file](http://en.wikipedia.org/wiki/INI_file).
 Each section name is used as profile name.
 
+###### SYNOPSIS
+
+Section name is utilized as profile name.  In each section following key settings are available:
+
+| key name                      | description                       | default value | available values | mandatory                       |
+| ----------------------------- | --------------------------------- |:-------------:|:----------------:|:-------------------------------:|
+| grant\_type | OAuth2 grant type (implicit flow is not supported currently) | authorization_code | authorization_code, password | no |
+| client\_id                    | client id                         | aurl          | (any)            | no                              |
+| client_secret                 | client secret                     | aurl          | (any)            | no                              |
+| auth\_server\_auth\_endpoint  | OAuth2 authorization endpoint URI | (none)        | (any)            | YES (except for password grant) |
+| auth\_server\_token\_endpoint | OAuth2 token endpoint URI         | (none)        | (any)            | YES                             |
+| redirect                      | redirect URI                      | (none)        | (any)            | YES (except for password grant) |
+| scopes                        | space separated scope values      | read write    | (any)            | no                              |
+| username                      | username for password grant       | (none)        | (any)            | no (except for password grant)  |
+| password                      | password for password grant       | (none)        | (any)            | no (except for password grant)  |
+
+
+###### EXAMPLE
+
 ```
 [default]
 auth_server_auth_endpoint = https://api.example.com/oauth/authorize
@@ -35,16 +59,36 @@ redirect = https://api.example.com/oauth/oob
 
 [foobar]
 grant_type = password
+client_id = foobar
+client_secret = bazqux
 auth_server_token_endpoint = https://api.example.com/oauth/token
+scopes = read write global
 username = john
 password = pass1234
+
+[fb]
+client_id = your_facebook_App_ID
+client_secret = your_facebook_App_Secret
+auth_server_auth_endpoint = https://www.facebook.com/dialog/oauth
+auth_server_token_endpoint = https://graph.facebook.com/oauth/access_token
+redirect = https://www.facebook.com/connect/login_success.html
+scopes = public_profile email user_friends
+
+[google]
+client_id = xxxxxxxx.apps.googleusercontent.com
+client_secret = yyyyyyyy
+auth_server_auth_endpoint = https://accounts.google.com/o/oauth2/auth
+auth_server_token_endpoint = https://www.googleapis.com/oauth2/v3/token
+redirect = urn:ietf:wg:oauth:2.0:oob
+scopes = https://www.googleapis.com/auth/plus.login https://www.googleapis.com/auth/userinfo.email
+
 ```
 
 ### Token store file
 
 Token store file `~/.aurl/tokens` is used by acurl internally.  Retrieved access/refresh token is stored in this file.
 You SHOULD NOT edit this file manually because this file is overwritten every time curl is executed.
-You MAY lose comment and another extra data.
+You may lose comment and another extra data.
 
 Just for information, token sotore file example is following:
 
@@ -59,6 +103,12 @@ refresh_token = yyyy
 expiry = 1424141030
 access_token = zzzz
 token_type = bearer
+
+[fb]
+refresh_token = 
+expiry = 1429580553
+access_token = blahblah
+token_type = 
 ```
 
 ### Execution
@@ -69,33 +119,41 @@ token_type = bearer
 $ aurl [global options] command [command options] [arguments...]
 ```
 
-`command` is every http method (e.g. `get`, `post`, `delete`) and first argument is target url.
+`command` is every http method (e.g. `get`, `post`, `delete`) and first argument is target url.  You can see all `command` in the help message.  Try, `aurl -h`.
 
 ###### EXAMPLE
 
 ```bash
 $ aurl get http://api.example.com/path/to/resource
+...http.response.body...
 $ aurl post http://api.example.com/path/to/resource --data "foobar"
+...http.response.body...
 ```
 
 aurl make request with access token in `Authorization` header of `default` profile.
 You can specify profile name with `--profile` option.
 
 ```bash
-$ aurl --profile foobar get http://api.example.com/path/to/resource
+$ aurl --profile fb get https://graph.facebook.com/me
+{"id":"...","email": ... }
+$ aurl --profile google get https://www.googleapis.com/plus/v1/people/me
+{
+ "kind": "plus#person",
+...
+}
 ```
 
 By default aurl prints response body in stdout.  When an error occured the detail is printed in stderr.
 You may want not response body but response header, then you can use `--no-body` and `--print-headers` option.
 
 ```bash
 $ aurl --no-body --print-headers options http://api.example.com/path/to/resource
-{"Content-Type":["application/json;charset=UTF-8"],"Date":["Tue, 17 Feb 2015 08:16:41 GMT"],"Server":["nginx/1.6.2"], "...": "..."}
+{"Content-Type":["application/json;charset=UTF-8"],"Date":["Tue, 17 Feb 2015 08:16:41 GMT"],"Server":["nginx/1.6.2"], ...}
 ```
 
 ## Contribution
 
-1. Fork ([https://github.com/classmethod-aws/oauthttp/fork](https://github.com/classmethod-aws/aurl/fork))
+1. Fork ([https://github.com/classmethod-aws/aurl/fork](https://github.com/classmethod-aws/aurl/fork))
 1. Create a feature branch named like `feature/something_awesome_feature` from `development` branch
 1. Commit your changes
 1. Rebase your local changes against the `develop` branch

commands.go

@@ -186,14 +186,14 @@ func doRequest(ctx *cli.Context, method string) {
 
 	Tracef("doRequest start")
 	resp, tok, err := doRequest0(ctx, method)
+	if tok != nil && resp != nil && resp.StatusCode != 401 && resp.StatusCode != 403 {
+		storeToken(tok)
+	}
 	if err != nil {
 		log.Fatal(err)
 		return
 	} else {
 		Tracef("request done successfully")
-		if tok != nil {
-			storeToken(tok)
-		}
 	}
 
 	Tracef("printing headers")
@@ -311,7 +311,7 @@ func toString(retrieve bool) string {
 	if retrieve {
 		return "retrieve"
 	}
-	return "sotred"
+	return "stored"
 }
 
 func targetUrl(ctx *cli.Context) (string, error) {

oauth2.go

@@ -37,7 +37,7 @@ func AccessToken(profileName string, retrieve bool) (*oauth2.Token, bool, error)
 				return tok, false, nil
 			}
 		} else {
-			Tracef("load error: %v", err)
+			Tracef("cannot found token store: %v", err)
 		}
 		Tracef("==== phase transition to Retrieve")
 	}
@@ -50,6 +50,8 @@ func AccessToken(profileName string, retrieve bool) (*oauth2.Token, bool, error)
 	switch grantType {
 	case "authorization_code":
 		return authorizationCodeFlow(oauth2Conf)
+	case "implicit":
+		return implicitFlow(oauth2Conf)
 	case "password":
 		return resourceOwnerPasswordFlow(oauth2Conf, currentProfile[USERNAME], currentProfile[PASSWORD])
 	case "switch_user":
@@ -74,6 +76,11 @@ func authorizationCodeFlow(oauth2Conf *oauth2.Config) (*oauth2.Token, bool, erro
 	}
 }
 
+func implicitFlow(oauth2Conf *oauth2.Config) (*oauth2.Token, bool, error) {
+	return &oauth2.Token{}, true, fmt.Errorf("implicit flow is not supported")
+	// TODO
+}
+
 func resourceOwnerPasswordFlow(oauth2Conf *oauth2.Config, username string, password string) (*oauth2.Token, bool, error) {
 	if tok, err := oauth2Conf.PasswordCredentialsToken(oauth2.NoContext, username, password); err != nil {
 		return &oauth2.Token{}, true, err

profile.go

@@ -18,8 +18,8 @@ const (
 	PASSWORD                   = "password"
 	SOURCE_PROFILE             = "source_profile"
 
-	DEFAULT_CLIENT_ID     = "oauthttp"
-	DEFAULT_CLIENT_SECRET = "oauthttp"
+	DEFAULT_CLIENT_ID     = "aurl"
+	DEFAULT_CLIENT_SECRET = "aurl"
 	DEFAULT_GRANT_TYPE    = "authorization_code"
 	DEFAULT_SCOPES        = "read,write"
 )

scripts/compile.sh

@@ -0,0 +1,13 @@
+#! /bin/bash
+set -e
+
+DIR=$(cd $(dirname ${0})/.. && pwd)
+cd ${DIR}
+
+XC_ARCH=${XC_ARCH:-386 amd64}
+XC_OS=${XC_OS:-darwin linux windows}
+
+rm -rf pkg/
+
+gox -output "pkg/{{.OS}}_{{.Arch}}/{{.Dir}}"
+

scripts/package.sh

@@ -0,0 +1,45 @@
+#!/bin/bash
+set -e
+
+DIR=$(cd $(dirname ${0})/.. && pwd)
+cd ${DIR}
+
+# If you prepare version.go
+VERSION=$(grep "const Version " version.go | sed -E 's/.*"(.+)"$/\1/')
+if [ -z "${VERSION}" ]; then
+    echo "Please specify a version."
+    exit 1
+fi
+
+if [ -z "${REPO}" ]; then
+    echo "Please set your Application name in the REPO env var."
+    exit 1
+fi
+
+# Run Compile
+./scripts/compile.sh
+
+
+if [ -d pkg ];then
+    rm -rf ./pkg/dist
+fi
+
+# Package all binary as .zip
+mkdir -p ./pkg/dist
+for PLATFORM in $(find ./pkg -mindepth 1 -maxdepth 1 -type d); do
+    PLATFORM_NAME=$(basename ${PLATFORM})
+    ARCHIVE_NAME=${REPO}_${VERSION}_${PLATFORM_NAME}
+
+    if [ $PLATFORM_NAME = "dist" ]; then
+        continue
+    fi
+
+    pushd ${PLATFORM}
+    zip ${DIR}/pkg/dist/${ARCHIVE_NAME}.zip ./*
+    popd
+done
+
+# Generate shasum
+pushd ./pkg/dist
+shasum * > ./${VERSION}_SHASUMS
+popd

version.go

@@ -1,3 +1,3 @@
 package main
 
-const Version string = "0.1"
+const Version string = "0.2"