nomis-api-client 0.0.6 → 0.0.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 17e5a8b25e6bfe75a4301b5f7824cbc211fd83e6
-  data.tar.gz: 80503af449a148c65b7b2c7da2f10cfa38d4a61b
+  metadata.gz: 0565b63217b1a92ea23783172392d8772411ddb3
+  data.tar.gz: 5b0b83b7a490c3b8cca1710293a8fb8fc7e2238c
 SHA512:
-  metadata.gz: 3ac008741956f3b6d65180152683b2db74c66a2eacd30606be6668f2f353c2536711136d02594cac95d213f72d3d6d3149a3a2d61b6ddad145f1854d41a6d4a6
-  data.tar.gz: d45d4fd65889266c38d73d3522e5cc20dae26d01372ad50dae5882ed225b020e7be9142f7a7b5c6786d82af61e0713c093f6536d16c286baf1c332aa1592dffa
+  metadata.gz: a53ce9deb16a935ce3291ec3c892d161791a32c5c559dc16f432ae8c54c20a77057ff93debe94d8de6b2c8fd2cf8ce4b25d3fc780a2d94868c2e07953b257414
+  data.tar.gz: 9e84e9f0689b97ab9179787d8acb411863a5dac82c35300ad713569447629c2a2f5b13d7bf6b66e1335097e0ad7a4423568397eea4f7b413afd22641daf89466

data/README.md

@@ -5,6 +5,18 @@ A minimal client for the [NOMIS API](http://ministryofjustice.github.io/nomis-ap
 
 ## Installation
 
+### Without bundler
+
+Pre-requisites:
+- ruby
+- rubygems
+
+```bash
+  gem install nomis-api-client  
+```
+
+### With bundler
+
 1. In your Gemfile, add:
 ```ruby
 gem 'nomis-api-client'
@@ -63,6 +75,13 @@ You can generate a bearer token without making a request as follows:
 ```ruby
   # Manually generating a bearer token
   NOMIS::API::AuthToken.new(client_key: 'your client key', client_token: 'your client token').bearer_token
+```
+
+There is also a command-line executable:
+
+```bash
+  generate_bearer_token /path/to/your.token /path/to/your.key
+```
 
 ### Environment (preprod/prod)
 

data/bin/generate_bearer_token

@@ -1,7 +1,7 @@
 #!/usr/bin/env ruby 
 #
 # Usage:
-# generate_bearer_token client_key_file client_token_file
+# generate_bearer_token client_token_file client_key_file
 #
 
 require 'nomis_api_client_ruby'
@@ -9,7 +9,7 @@ require 'nomis_api_client_ruby'
 def usage
   output = <<-END
   Usage:
-    generate_bearer_token client_key_file client_token_file
+    generate_bearer_token client_token_file client_key_file
   
   Useful environment variables:
 
@@ -21,14 +21,14 @@ def usage
     'iat skew too large', you can provide this to bring your system
     time within +/-10s of the API gateway.
     e.g.
-     NOMIS_API_IAT_FUDGE_FACTOR=-5 generate_bearer_token ~/my.key ~/my.token
+     NOMIS_API_IAT_FUDGE_FACTOR=-5 generate_bearer_token /path/to/my.token /path/to/my.key 
 
 END
 end
 
-raise usage unless $ARGV.size == 2
+raise usage unless ARGV.size == 2
 
-token = NOMIS::API::AuthToken.new(client_key_file: $1, client_token_file: $2).bearer_token
+token = NOMIS::API::AuthToken.new(client_token_file: $1, client_key_file: $2).bearer_token
 puts token
 
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: nomis-api-client
 version: !ruby/object:Gem::Version
-  version: 0.0.6
+  version: 0.0.8
 platform: ruby
 authors:
 - Al Davidson