getauthtoken 0.4.1 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 36470fd7a5da225e693d83ccd434a83fe5a8a0331633fb7f070b8129bbd95a55
-  data.tar.gz: 88a34fe8d9e19ff26cac441a5055c3996228bc1d2e5cdfef91634eed37b6e12f
+  metadata.gz: 568a05c002733aa012393e484a452ba1377776dd4d227fb781777f339d907fc1
+  data.tar.gz: b04ec9d5aa278f0168275a94f8ccded0f181df2d5b77a6281182429e1b843505
 SHA512:
-  metadata.gz: 776884e842291b27555eef4268a7f15f6a55a29836f10cca04238937c168d56249d83f496ac0931d70bfbee1c2ce6048e3be39b72f10066fd045733c2181f5aa
-  data.tar.gz: 3c36a887c504cecd9d7085bcde5f6afff0712f5025427352275997222d006b06b14915365aa98df08570be139ee997ada4aea4dded2dee2396715735ff103488
+  metadata.gz: ad0ee84ab0475f32edc67c1f7bb20bea8869faa93eb680b1aafdd4ed1bdc3d32b3fabcb014becc15eaba8b074007bf81be8e6cd3f8c965511321607d2018ddcb
+  data.tar.gz: 0e815ce2043bdb8e8e419cd40bc1ae8ac06d93ecd46f63d7d39f9387d2633f93ad78ed5fc96f3f509c213fc2c8730441d759ff1806b6b8969020265a84bdac4c

data/Gemfile.lock

@@ -1,7 +1,8 @@
 PATH
   remote: .
   specs:
-    getauthtoken (0.4.0)
+    getauthtoken (0.5.0)
+      highline (~> 2.0.3)
       http (~> 4.2.0)
 
 GEM
@@ -16,6 +17,7 @@ GEM
     ffi-compiler (1.0.1)
       ffi (>= 1.0.0)
       rake
+    highline (2.0.3)
     http (4.2.0)
       addressable (~> 2.3)
       http-cookie (~> 1.0)

data/README.md

@@ -1,35 +1,49 @@
 # getauthtoken
 
+[![Gem Version](https://badge.fury.io/rb/getauthtoken.svg)](https://badge.fury.io/rb/getauthtoken)
+
 `getauthtoken` is a small command line utility to acquire an authorization token from [Xaptum](https://dev.xaptum.io). It's intended to speed up the process of testing API's, since an authorization token is required as a header in every request and new tokens are generated every four hours.
 
 Running `getauthtoken` from your command line after installation (see below) will always give the current token.
 
 ## Installation
 
-First, install the gem from [Ruby Gems](https://rubygems.org). You may need to `sudo gem install` here.
+First, install the gem from [Ruby Gems](https://rubygems.org).
 
 ```shell
 $ gem install getauthtoken
 ```
 
-Second, we'll need to create a JSON file `.xaptum_credentials.json` that stores your Xaptum credentials. `getauthtoken` will always use the credentials in this file to acquire your auth token.
+Alternatively, if you've already installed `getauthtoken`, update the gem to the latest version.
+
+```shell
+$ gem update getauthtoken
+```
+
+_Note that for the above commands you may need to use `sudo gem`._
 
-In your `$HOME` directory, create the file `.xaptum_credentials.json` with the following structure:
+Second, we'll need to create a JSON file `.xaptum_config.json` that stores your Xaptum configurations. `getauthtoken` will always use the configurations in this file to acquire your auth token.
+
+In your `$HOME` directory, create the file `.xaptum_config.json` with the following structure:
 
 ```json
 {
   "username": "<YOUR_USERNAME>",
-  "password": "<YOUR_PASSWORD>"
+  "host": "<YOUR_HOST>"
 }
 ```
 
+`<YOUR_HOST>` should normally be `https://xaptum.io` or `https://dev.xaptum.io`.
+
 ## Usage
 
-Simply run `getauthtoken` from the command line. The token should then appear and get copied to your clipboard.
+Simply run `getauthtoken` from the command line. You will then be prompted for your Xaptum account password. If the password is correct, your token should appear and get copied to your clipboard.
 
 ```shell
 $ getauthtoken
 Authenticating with Xaptum...
+Enter Password
+
 Your token is <TOKEN>. It has been copied to the clipboard.
 ```
 
@@ -46,11 +60,14 @@ $ bundle install
 Write tests, pass tests, bump version, pull request.
 
 - **Write tests:** Write all tests in `test/getauthtoken_test.rb`.
-- **Pass tests:** Write code in `lib/getauthtoken.rb` to pass the tests. You can run tests with `$ rake test`.
+- **Pass tests:** Write code in `lib/getauthtoken.rb` to pass the tests. You can run tests with `rake test`.
 - **Bump version:** The current version of the gem is in `lib/getauthtoken/version.rb`. After you've made your changes, update this version by following the format `MAJOR.MINOR.PATCH`.
+- **Test locally:** Running `bundle exec rake build` will build a new version of the gem that you can run and test locally by installing with `gem install pkg/getauthtoken-<VERSION>` and then running `getauthtoken`.
 - **Pull request:** Open a PR! One of the maintainers will review your changes and work with you to get them merged.
 
-For maintainers: building new gem version and pushing to Github and Ruby Gems
+### For Maintainers
+
+Build a new gem version, pushing to Github (along with a tag), and add the new version to Ruby Gems
 
 ```shell
 $ bundle exec rake release

data/bin/getauthtoken

@@ -1,7 +1,13 @@
 #!/usr/bin/env ruby
 require 'getauthtoken'
+require 'highline/import'
+
+def get_password(prompt = "Enter Password")
+    ask(prompt) {|q| q.echo = false}
+end
 
 puts "Authenticating with Xaptum..."
-token = Getauthtoken::authenticate()
+password = get_password()
+token = Getauthtoken::authenticate(password)
 Getauthtoken::pbcopy(token)
 puts "Your token is #{token}. It has been copied to the clipboard."

data/getauthtoken.gemspec

@@ -29,6 +29,7 @@ Gem::Specification.new do |spec|
   spec.require_paths = ["lib"]
   
   spec.add_dependency "http", "~> 4.2.0"
+  spec.add_dependency "highline", "~> 2.0.3"
 
   spec.add_development_dependency "bundler", "~> 2.0"
   spec.add_development_dependency "rake", "~> 10.0"

data/lib/getauthtoken.rb

@@ -3,25 +3,25 @@ require "json"
 require "http"
 
 module Getauthtoken
-  BASE_URL = 'https://dev.xaptum.io/api/xcr/v2/xauth'
+  AUTH_PATH = '/api/xcr/v2/xauth'
 
-  def self.authenticate()
-     credentials = get_credentials()
-     post_credentials(credentials) 
+  def self.authenticate(password)
+     config = get_config()
+     post_credentials(config, password) 
   end
 
-  def self.get_credentials()
-    file = File.open(File.expand_path("~/.xaptum_credentials.json"))
+  def self.get_config()
+    file = File.open(File.expand_path("~/.xaptum_config.json"))
     data = JSON.load file
     file.close
     data
   end
 
-  def self.post_credentials(credentials)
-    hash = { "username" => credentials["username"], "token" => credentials["password"]}
+  def self.post_credentials(config, password)
+    hash = { "username" => config["username"], "token" => password}
     json = JSON.generate(hash)
     response = HTTP.headers("Content-Type": "application/json", "Accept": "application/json")
-      .post(BASE_URL, body: json)
+      .post(config["host"] + AUTH_PATH, body: json)
     
     response.code == 200 ? JSON.parse(response)["data"][0]["token"] : nil
   end

data/lib/getauthtoken/version.rb

@@ -1,3 +1,3 @@
 module Getauthtoken
-  VERSION = "0.4.1"
+  VERSION = "0.5.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: getauthtoken
 version: !ruby/object:Gem::Version
-  version: 0.4.1
+  version: 0.5.0
 platform: ruby
 authors:
 - Dylan Irlbeck
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-12-15 00:00:00.000000000 Z
+date: 2019-12-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: http
@@ -24,6 +24,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 4.2.0
+- !ruby/object:Gem::Dependency
+  name: highline
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.0.3
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.0.3
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement