diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md new file mode 100644 index 0000000..1db011e --- /dev/null +++ b/.github/pull_request_template.md @@ -0,0 +1,33 @@ +[ABC-1234](https://toptal-core.atlassian.net/browse/ABC-1234) + +### Description + +Describe the changes and motivations for the pull request, unless obvious from the title. + +[Designs](https://share.abstract.com) (if applicable) + +### How to test + +- `bundle install` +- FIXME: Add the steps describing how to test your changes manually + +### Environment variables + +Include a snapshot of the ENV vars used in your local env when this PR was created. + +``` +PUBLIC_ENV_VAR=public-value +GLOBAL_SECRET_ENV_VAR=xxx # Added in 1Password in Shared-Utilities-Environment group +OWN_PRIVATE_ENV_VAR # Different for everyone +``` + +### Acceptance Criteria + +- [ ] Add acceptance criterias from Jira task [ABC-1234] + +### Pre-merge checklist + +- [ ] The PR relates to a single subject with a clear title and description in grammatically correct, complete sentences. +- [ ] Verify that feature branch is up-to-date with `master` (if not - rebase it). +- [ ] Double check the quality of [commit messages](http://chris.beams.io/posts/git-commit/). +- [ ] A snapshot of the author's env vars has been added diff --git a/.github/workflows/unit.yml b/.github/workflows/unit.yml new file mode 100644 index 0000000..7235b56 --- /dev/null +++ b/.github/workflows/unit.yml @@ -0,0 +1,28 @@ +name: Unit + +on: + push: + branches: [master] + pull_request: + branches: + - UTI-2583--adapt-haste-client-to-new-api + +jobs: + unit_tests: + name: Unit tests + runs-on: ubuntu-latest + timeout-minutes: 5 + + steps: + - uses: actions/checkout@v1 + - uses: actions/setup-ruby@v1 + with: + ruby-version: 3.0.0 + + - name: Run bundle install + run: | + gem install bundler + bundle install --jobs 4 --retry 3 + + - name: Build and test with rspec + run: bundle exec rspec spec diff --git a/.gitignore b/.gitignore index 7692abf..cd0fad5 100644 --- a/.gitignore +++ b/.gitignore @@ -3,3 +3,4 @@ *.gem Gemfile.lock .rspec +.DS_STORE diff --git a/LICENSE.txt b/LICENSE.txt new file mode 100644 index 0000000..196d38c --- /dev/null +++ b/LICENSE.txt @@ -0,0 +1,8 @@ +Copyright 2022 Toptal LLC + +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. + diff --git a/README.md b/README.md index 8bd50d1..6388f2d 100644 --- a/README.md +++ b/README.md @@ -1,14 +1,12 @@ # Haste Client -[![Build Status](https://secure.travis-ci.org/seejohnrun/haste-client.png)](http://travis-ci.org/seejohnrun/haste-client) +Haste-client is a simple client for uploading data to `Haste` server. All you need to do is to pipe data in STDIN: -haste-client is a simple client for uploading data to haste-server. All you do it pipe data in STDIN: +`cat file | HASTE_SERVER_TOKEN=mytoken haste` -`cat file | haste` +And once the output makes it to the server, it will print the `Haste` share page URL to STDOUT. -And once the output makes it to the server, it will print the URL to STDOUT. - -This can be really really cool in combination with `pbcopy`, like: +This can be combined with `pbcopy`, like: * mac osx: `cat file | haste | pbcopy` * linux: `cat file | haste | xsel` @@ -21,39 +19,43 @@ after which the contents of `file` will be accessible at a URL which has been co gem install haste ``` -## Making uploading file contents easier +## Configuration -If you supply a valid file path as argument #1 to the client, it will be uploaded: +Most of the configuration is controlled by env variables. Here is the all environment variables that you can use. -``` bash -# equivalent -cat file | haste -haste file +``` +HASTE_SERVER: Haste server domain url +HASTE_SERVER_TOKEN: Github authentication token +HASTE_SHARE_SERVER: Haste share server domain url +HASTE_USER: Basic authentication user name +HASTE_PASS: Basic authentication user pass +HASTE_SSL_CERTS: SSL certs path ``` -## You can get the raw version +To add these environment variables, you should simply add them to your ~.bash_profile: -Want the raw URL returned instead? (a plain-text version)? - -``` bash -cat file | haste --raw # or -haste file --raw +```bash +export VARIABLE="value" ``` -## Changing the location of your haste server - -By default, haste will point at `https://hastebin.com`. You can change this by setting the value of `ENV['HASTE_SERVER']` to the URL of your haste server. You can also use `alias` to make easy shortcuts if you commonly use a few hastes intermingled with each other. To do that, you'd put something like this into ~.bash_profile: - -``` bash -alias work_haste="HASTE_SERVER=https://something.com haste" -``` - -After which you can use `work_haste` to send hastes to that server instead. - ### Authentication -If your haste installation requires http authentication, -add the following to your ~.bash_profile: +If you are using default `HASTE_SERVER`, you need to have an GitHub authentication token. +You can get the information about authentication and how to generate token [here](https://www.toptal.com/developers/hastebin/documentation) + +After you have generated your token, you should add it to your ~.bash_profile: + +```bash +export HASTE_SERVER_TOKEN="mytoken" +``` + +or you can add token to your command: + +```bash +cat file | HASTE_SERVER_TOKEN=mytoken haste` +``` + +If your `Haste` installation requires http authentication, add the following to your ~.bash_profile: ```bash export HASTE_USER="myusername" @@ -66,7 +68,57 @@ if you are using SSL, you will need to supply your certs path export HASTE_SSL_CERTS="/System/Library/OpenSSL/certs" ``` -## Use as a library +## Usage + +If you supply a valid file path as an argument to the client, it will be uploaded: + +```bash +# equivalent +cat file | haste +haste file +``` + +### Different Haste server + +By default, `Haste` share page will point at `https://hastebin.com`. +If you have haste-server configured to serve bins on a separate domain, you also need to set ENV['HASTE_SHARE_SERVER'] value to that domain. + +To set the value of share server, you can add the following to your ~.bash_profile: + +```bash +export HASTE_SHARE_SERVER="myshareserver" +``` + +### Different Haste server + +By default, haste server will point at `https://hastebin.com`. +You can change this by setting the value of `ENV['HASTE_SERVER']` to the URL of your `Haste` server. + +To set the value of server, you can add the following to your ~.bash_profile: + +```bash +export HASTE_SERVER="myserver" +``` + +### Use with alias + +You can also use `alias` to make easy shortcuts if you commonly use a few hastes intermingled with each other. +To do that, you'd put something like this into ~.bash_profile: + +``` bash +alias work_haste="HASTE_SERVER=https://something.com HASTE_SERVER_TOKEN=mytoken haste" +``` + +or + +``` bash +alias work_haste="HASTE_SERVER_TOKEN=mytoken haste" +``` + +After which you can use `work_haste` to send hastes to that server or with different tokens instead. + + +### Use as a library You can also use `Haste` as a library to upload hastes: @@ -77,48 +129,6 @@ uploader.upload_raw 'this is my data' # key uploader.upload_path '/tmp/whaaaa' # key ``` -## Windows Support +## Contributor License Agreement -If you'd like an alternative on Windows that supports functionality similar to `pbcopy`, check out Aidan Ryan's [WinHaste](https://github.com/ajryan/WinHaste) project. - -## Lightweight Alternative - -Han Boetes and @nickthename have contributed a simple shell-script alternative for those not interested in installing a RubyGem: - -``` bash -haste() { - local S="https" H="hastebin.com" P="" L="$1" - local SHP="${S}://${H}${P}/" - curl -X POST -s --data-binary @- "${SHP}documents" \ - | awk -F '"' 'b{ b="."b }; {print a$4b}' a="${SHP}" b="${L}" -} -``` - -Where `S` is the scheme, `H` is the host, `P` is the port, and `L` is the language. Requires `curl` - -Usage: - -``` bash -cat file.txt | haste # cat file into hate, output url -haste sh < script.sh # Same as above, but ensure shell syntax highlighting -xsel -b | haste txt # Output clipboard buffer into haste, ensure no highlighting -``` - -And a more expansive BASH option by @diethnis can be found at: -https://github.com/diethnis/standalones/blob/master/hastebin.sh - -## Author - -John Crepezzi - -## License - -(The MIT License) - -Copyright © 2011 John Crepezzi - -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 +Licensed under the [MIT](https://github.com/toptal/haste-client/blob/main/LICENSE.txt 'https://github.com/toptal/haste-client/blob/main/LICENSE.txt') license. diff --git a/lib/haste/cli.rb b/lib/haste/cli.rb index 213ca11..04f6835 100644 --- a/lib/haste/cli.rb +++ b/lib/haste/cli.rb @@ -6,6 +6,8 @@ module Haste def initialize @uploader = Uploader.new( ENV['HASTE_SERVER'], + ENV['HASTE_SERVER_TOKEN'], + ENV['HASTE_SHARE_SERVER'], ENV['HASTE_USER'], ENV['HASTE_PASS'], ENV['HASTE_SSL_CERTS']) @@ -20,11 +22,7 @@ module Haste key = @uploader.upload_raw STDIN.readlines.join end # Put together a URL - if ARGV.include?('--raw') - url = "#{@uploader.server_url}/raw/#{key}" - else - url = "#{@uploader.server_url}/#{key}" - end + url = "#{@uploader.share_server_url}/share/#{key}" # And write data out if STDOUT.tty? STDOUT.puts url diff --git a/lib/haste/uploader.rb b/lib/haste/uploader.rb index 72ad08c..f42b06f 100644 --- a/lib/haste/uploader.rb +++ b/lib/haste/uploader.rb @@ -4,22 +4,29 @@ require 'uri' module Haste - DEFAULT_URL = 'https://hastebin.com' + DEFAULT_SERVER_URL = 'https://new.hastebin.com' + DEFAULT_SHARE_SERVER_URL = 'https://new.hastebin.com' class Uploader - attr_reader :server_url, :server_user, :server_pass, :ssl_certs - - def initialize(server_url = nil, server_user = nil, server_pass = nil, ssl_certs = nil) - @server_url = server_url || Haste::DEFAULT_URL - @server_url = @server_url.dup - @server_url = @server_url.chop if @server_url.end_with?('/') + attr_reader :server_url, :server_token, :share_server_url, :server_user, :server_pass, :ssl_certs + def initialize(server_url = nil, server_token = nil, share_server_url = nil, server_user = nil, server_pass = nil, ssl_certs = nil) + @server_url = generate_url(server_url || Haste::DEFAULT_SERVER_URL) + @share_server_url = generate_url(share_server_url || Haste::DEFAULT_SHARE_SERVER_URL) + @server_user = server_user + @server_token = server_token @server_pass = server_pass @ssl_certs = ssl_certs end + def generate_url(url) + url = url.dup + url = url.chop if url.end_with?('/') + return url + end + # Take in a path and return a key def upload_path(path) fail_with 'No input file given' unless path @@ -76,6 +83,7 @@ module Haste end def connection_config(config) + config.request :authorization, 'Bearer', @server_token if @server_token config.basic_auth(@server_user, @server_pass) if @server_user config.adapter Faraday.default_adapter end diff --git a/spec/examples/uploader_spec.rb b/spec/examples/uploader_spec.rb index 97e69a0..342db94 100644 --- a/spec/examples/uploader_spec.rb +++ b/spec/examples/uploader_spec.rb @@ -165,13 +165,15 @@ describe Haste::Uploader do describe :server_url do let(:server_url) { uploader.server_url } + let(:share_server_url) { uploader.share_server_url } context 'with default constructor' do let(:base) { nil } - it 'should use the default url' do - expect(server_url).to eq(Haste::DEFAULT_URL) + it 'should use the default urls' do + expect(server_url).to eq(Haste::DEFAULT_SERVER_URL) + expect(share_server_url).to eq(Haste::DEFAULT_SHARE_SERVER_URL) end end