getauthtoken 0.4.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 68681b938373b176e145a551cb269a38a25d6730685b0fc9a42ce2613a06151a
+  data.tar.gz: 10e76d40cf115b6a99b823a1238c769d3ff2ad54b2cfd660b5d14a1fb4d6ecd2
+SHA512:
+  metadata.gz: b4159644067d1c8e793ef0dd778681854db8867b687f970903c082d0222b4588e60a36347569dc8fc97ef7d108d783998f2509767ac909473da1958d582055ab
+  data.tar.gz: a7081d399e1b1f6393d82647b1f53e1f65fe8b6d0e368ea06783930ea5c0a429f0d3c117e82e1418f3ed612de6848582c97365cfb12462c4fbf15447a12e66ba

data/.gitignore

@@ -0,0 +1,8 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.travis.yml

@@ -0,0 +1,7 @@
+---
+sudo: false
+language: ruby
+cache: bundler
+rvm:
+  - 2.6.3
+before_install: gem install bundler -v 2.0.2

data/Gemfile

@@ -0,0 +1,4 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in getauthtoken.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,60 @@
+PATH
+  remote: .
+  specs:
+    getauthtoken (0.3.0)
+      http (~> 4.2.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    addressable (2.7.0)
+      public_suffix (>= 2.0.2, < 5.0)
+    diff-lcs (1.3)
+    domain_name (0.5.20190701)
+      unf (>= 0.0.5, < 1.0.0)
+    ffi (1.11.3)
+    ffi-compiler (1.0.1)
+      ffi (>= 1.0.0)
+      rake
+    http (4.2.0)
+      addressable (~> 2.3)
+      http-cookie (~> 1.0)
+      http-form_data (~> 2.0)
+      http-parser (~> 1.2.0)
+    http-cookie (1.0.3)
+      domain_name (~> 0.5)
+    http-form_data (2.1.1)
+    http-parser (1.2.1)
+      ffi-compiler (>= 1.0, < 2.0)
+    minitest (5.13.0)
+    public_suffix (4.0.1)
+    rake (10.5.0)
+    rspec (3.9.0)
+      rspec-core (~> 3.9.0)
+      rspec-expectations (~> 3.9.0)
+      rspec-mocks (~> 3.9.0)
+    rspec-core (3.9.0)
+      rspec-support (~> 3.9.0)
+    rspec-expectations (3.9.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-mocks (3.9.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-support (3.9.0)
+    unf (0.1.4)
+      unf_ext
+    unf_ext (0.0.7.6)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 2.0)
+  getauthtoken!
+  minitest (~> 5.0)
+  rake (~> 10.0)
+  rspec (~> 3.9.0)
+
+BUNDLED WITH
+   2.0.2

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2019 Dylan Irlbeck
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,54 @@
+# 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, clone the repository and install the gem locally. 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
+```
+
+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:
+
+```json
+{
+    "username": "<YOUR_USERNAME>",
+    "password": "<YOUR_PASSWORD>"
+}
+```
+
+## Usage
+
+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...
+Your token is <TOKEN>. It has been copied to the clipboard.
+```
+
+## Development
+
+Write tests, pass tests, bump version, pull request.
+
+Running the tests
+
+```shell
+$ rake test
+```
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/dylanirlbeck/getauthtoken.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList["test/**/*_test.rb"]
+end
+
+task :default => :test

data/bin/getauthtoken

@@ -0,0 +1,7 @@
+#!/usr/bin/env ruby
+require 'getauthtoken'
+
+puts "Authenticating with Xaptum..."
+token = Getauthtoken::authenticate()
+Getauthtoken::pbcopy(token)
+puts "Your token is #{token}. It has been copied to the clipboard."

data/getauthtoken.gemspec

@@ -0,0 +1,37 @@
+lib = File.expand_path("lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "getauthtoken/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "getauthtoken"
+  spec.version       = Getauthtoken::VERSION
+  spec.authors       = ["Dylan Irlbeck"]
+  spec.email         = ["irlbeck2@illinois.edu"]
+
+  spec.summary       = "Acquire a Xaptum API authorization token"
+  spec.description   = "Small CLI utility to acquire a Xaptum API authentication token and copy into your clipboard."
+  spec.homepage      = "https://xaptum.com"
+  spec.license       = "MIT"
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = "https://github.com/dylanirlbeck/getauthtoken"
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  # spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+  #   `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+
+  end
+  spec.bindir        = "bin"
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+  
+  spec.add_dependency "http", "~> 4.2.0"
+
+  spec.add_development_dependency "bundler", "~> 2.0"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "minitest", "~> 5.0"
+  spec.add_development_dependency "rspec", "~> 3.9.0"
+end

data/lib/getauthtoken.rb

@@ -0,0 +1,35 @@
+require "getauthtoken/version"
+require "json"
+require "http"
+
+module Getauthtoken
+  BASE_URL = 'https://dev.xaptum.io/api/xcr/v2/xauth'
+
+  def self.authenticate()
+     credentials = get_credentials()
+     return 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
+  end
+
+  def self.post_credentials(credentials)
+    hash = { "username" => credentials["username"], "token" => credentials["password"]}
+    json = JSON.generate(hash)
+    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
+  end
+
+  def self.pbcopy(token)
+    IO.popen('pbcopy', 'w') { |f| f << token }
+    token
+  end
+
+end
+

data/lib/getauthtoken/version.rb

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

metadata

@@ -0,0 +1,128 @@
+--- !ruby/object:Gem::Specification
+name: getauthtoken
+version: !ruby/object:Gem::Version
+  version: 0.4.0
+platform: ruby
+authors:
+- Dylan Irlbeck
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2019-12-15 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: http
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 4.2.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 4.2.0
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.9.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.9.0
+description: Small CLI utility to acquire a Xaptum API authentication token and copy
+  into your clipboard.
+email:
+- irlbeck2@illinois.edu
+executables:
+- getauthtoken
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/getauthtoken
+- getauthtoken.gemspec
+- lib/getauthtoken.rb
+- lib/getauthtoken/version.rb
+homepage: https://xaptum.com
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://xaptum.com
+  source_code_uri: https://github.com/dylanirlbeck/getauthtoken
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.3
+signing_key: 
+specification_version: 4
+summary: Acquire a Xaptum API authorization token
+test_files: []