getauthtoken 0.4.0 → 0.4.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 68681b938373b176e145a551cb269a38a25d6730685b0fc9a42ce2613a06151a
-  data.tar.gz: 10e76d40cf115b6a99b823a1238c769d3ff2ad54b2cfd660b5d14a1fb4d6ecd2
+  metadata.gz: 36470fd7a5da225e693d83ccd434a83fe5a8a0331633fb7f070b8129bbd95a55
+  data.tar.gz: 88a34fe8d9e19ff26cac441a5055c3996228bc1d2e5cdfef91634eed37b6e12f
 SHA512:
-  metadata.gz: b4159644067d1c8e793ef0dd778681854db8867b687f970903c082d0222b4588e60a36347569dc8fc97ef7d108d783998f2509767ac909473da1958d582055ab
-  data.tar.gz: a7081d399e1b1f6393d82647b1f53e1f65fe8b6d0e368ea06783930ea5c0a429f0d3c117e82e1418f3ed612de6848582c97365cfb12462c4fbf15447a12e66ba
+  metadata.gz: 776884e842291b27555eef4268a7f15f6a55a29836f10cca04238937c168d56249d83f496ac0931d70bfbee1c2ce6048e3be39b72f10066fd045733c2181f5aa
+  data.tar.gz: 3c36a887c504cecd9d7085bcde5f6afff0712f5025427352275997222d006b06b14915365aa98df08570be139ee997ada4aea4dded2dee2396715735ff103488

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    getauthtoken (0.3.0)
+    getauthtoken (0.4.0)
       http (~> 4.2.0)
 
 GEM

data/README.md

@@ -1,25 +1,25 @@
-# Getauthtoken
+# 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. 
+`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, clone the repository and install the gem locally. You may need to `sudo gem install` here.
+First, install the gem from [Ruby Gems](https://rubygems.org). You may need to `sudo gem install` here.
 
 ```shell
-$ git clone https://github.com/dylanirlbeck/getauthtoken.git
-$ cd getauthtoken
-$ gem install getauthtoken-0.3.0.gem
+$ gem install getauthtoken
 ```
 
-Second, we'll need to create JSON file that stores your Xaptum credentials. `getauthtoken` will always use the credentials in this file to acquire your auth token. In your `$HOME` directory, create the file `.xaptum_credentials.json` with the following structure:
+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.
+
+In your `$HOME` directory, create the file `.xaptum_credentials.json` with the following structure:
 
 ```json
 {
-    "username": "<YOUR_USERNAME>",
-    "password": "<YOUR_PASSWORD>"
+  "username": "<YOUR_USERNAME>",
+  "password": "<YOUR_PASSWORD>"
 }
 ```
 
@@ -27,8 +27,6 @@ Second, we'll need to create JSON file that stores your Xaptum credentials. `get
 
 Simply run `getauthtoken` from the command line. The token should then appear and get copied to your clipboard.
 
-Note that you do **not** have to be in the `getauthtoken` project directory (that you cloned earlier) to use this utility.
-
 ```shell
 $ getauthtoken
 Authenticating with Xaptum...
@@ -37,12 +35,25 @@ Your token is <TOKEN>. It has been copied to the clipboard.
 
 ## Development
 
+You can clone the repository and install the dependencies with [Bundler](https://bundler.io).
+
+```shell
+$ git clone https://github.com/dylanirlbeck/getauthtoken.git
+$ cd getauthtoken
+$ bundle install
+```
+
 Write tests, pass tests, bump version, pull request.
 
-Running the tests
+- **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`.
+- **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`.
+- **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
 
 ```shell
-$ rake test
+$ bundle exec rake release
 ```
 
 ## Contributing

data/lib/getauthtoken.rb

@@ -7,14 +7,14 @@ module Getauthtoken
 
   def self.authenticate()
      credentials = get_credentials()
-     return post_credentials(credentials) 
+     post_credentials(credentials) 
   end
 
   def self.get_credentials()
     file = File.open(File.expand_path("~/.xaptum_credentials.json"))
     data = JSON.load file
     file.close
-    return data
+    data
   end
 
   def self.post_credentials(credentials)
@@ -23,12 +23,11 @@ module Getauthtoken
     response = HTTP.headers("Content-Type": "application/json", "Accept": "application/json")
       .post(BASE_URL, body: json)
     
-    return response.code == 200 ? JSON.parse(response)["data"][0]["token"] : nil
+    response.code == 200 ? JSON.parse(response)["data"][0]["token"] : nil
   end
 
   def self.pbcopy(token)
     IO.popen('pbcopy', 'w') { |f| f << token }
-    token
   end
 
 end

data/lib/getauthtoken/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: getauthtoken
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.4.1
 platform: ruby
 authors:
 - Dylan Irlbeck