gistrb 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: a2aefb784623a1659b2bafd3eeeec8e050766df6
+  data.tar.gz: fb813f490cf60efb217ea2b3f46d439ac52b4daf
+SHA512:
+  metadata.gz: 98aca49aa436b184c517c61e5b7fdb8acffab6b900cbf279d7656e85696bf7ec7a6d2450547befeb8c63b1c04338a72fb585768a63df1975e202c1009414bdcf
+  data.tar.gz: 1fb6927724c4cdef4f360fed6139fa9909b3980bee60503123034eaae08d8d43d018c0b04bbab615292b107c003651615e610e904f9ed446be8b1920e7d04d6a

data/.gitignore

@@ -0,0 +1,8 @@
+# Don't add sublime project files
+*sublime*
+
+# Don't add the Gemfile.lock
+Gemfile.lock
+
+# Also, ignore the config file
+lib/config.rb

data/.travis.yml

@@ -0,0 +1,14 @@
+language: ruby
+rvm:
+- 2.2
+- jruby-19mode
+- rbx-2
+before_install: gem install bundler -v 1.15
+deploy:
+  provider: rubygems
+  api_key:
+    secure: RmgCZqvJKcpDPrxNsJrivxChVcaPNaJfIpdWCPnhIR/uM8kkD3dXF+dOvtUOXsOn8uO2EbFOPYv8dEcQd3bQaNhgdOrPdg+Z47nf6LphKpDKemmUS2DskepJUG1q0lCHhG5V3v8XIDUdT78ZpyNGh9KQ5ineFVgOJ+oQuxUzkUc=
+  gem: gistrb
+  on:
+    tags: true
+    repo: cameronbroe/gistrb

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 Cameron Roe
+
+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,48 @@
+# gistrb - A command-line utility to post files directly as Gists on GitHub.com
+### Description:
+This is a utility to easily post local source files you have on GitHub Gists. It
+supports uploading multi-file Gists, authenticated Gists, anonymous Gists, and
+declaring the Gists as private or public. You can also attach descriptions to the Gist you post.
+
+## Usage:
+
+```shell
+gistrb [opts] source_file source_file2 ...
+```
+
+`gistrb` also supports input from STDIN. If `gistrb` is invoked with no files and nothing piped in, then it will wait
+on the terminal for input from STDIN until it reads an EOF character. An EOF character can be inserted on the terminal using Ctrl+D.
+
+Any files in the Gist from STDIN will be labelled as "STDIN".
+
+```shell
+$ cat foo.txt | gistrb [opts] source_file # Reads foo.txt from piped STDIN and source_file as a file.
+$ gistrb [opts] # Waits until it reads Ctrl+D and processes that data as STDIN
+```
+
+## Options:
+Option                                 | Description
+-------------------------------------- | -----------
+ -u | --user                      | Post the Gist as currently signed in user
+ -s | --sign-in                   | Sign into the utility using your GitHub account
+ --sign-out                            | Sign out of the utility
+ -p | --public                    | Post the Gist as public (it posts as private by default)
+ -d [DESC] | --description [DESC] | Use [DESC] as the description for the Gist
+ -c | --clipboard                 | Automatically put the created Gist URL into your clipboard (beta)
+
+## Installation:
+Using RubyGems, simply run this command:
+`gem install gistrb`
+
+## Requirements:
+If on Linux, you need to have xclip installed for clipboard support
+
+To install this on Ubuntu-based distributions, run the following command.
+```shell
+sudo apt-get install xclip
+```
+
+## License
+MIT License
+
+Copyright © 2017 Cameron Roe

data/Rakefile

@@ -0,0 +1,5 @@
+require 'bundler/gem_tasks'
+
+task :default do
+    puts "Need to add tests"
+end

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require 'bundler/setup'
+require 'gist'
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require 'irb'
+IRB.start(__FILE__)

data/bin/gistrb

@@ -0,0 +1,70 @@
+#!/usr/bin/env ruby
+require File.expand_path('../../lib/gist', __FILE__) # Require the Gist library files
+require 'optparse'
+
+options = {}
+OptionParser.new do |opts|
+  opts.banner = 'Usage: gist [options] files'
+  opts.on('-u', '--user', 'Post as user') do |u|
+    options[:user] = u
+  end
+
+  opts.on('-s', '--sign-in', 'Sign in as user') do |s|
+    options[:sign_in] = s
+  end
+
+  opts.on('--sign-out', 'Clear out saved user') do |s|
+    options[:sign_out] = s
+  end
+
+  opts.on('-p', '--public', 'Make the gist public') do |p|
+    options[:public] = p
+  end
+
+  opts.on('-d [DESC]', '--description [DESC]', String, 'Description of the gist') do |d|
+    options[:description] = d
+  end
+
+  opts.on('-c', '--clipboard', 'Save the gist URL to clipboard') do |c|
+    options[:clipboard] = c
+  end
+end.parse!
+
+# Copy ARGV into another array then clear it, to make gets behave properly
+files = ARGV.clone
+ARGV.clear
+
+# Get anything sent by STDIN to support cat and pasting.
+if !STDIN.tty? || files.empty? then
+	stdin = STDIN.read
+end
+
+if options[:sign_out]
+  File.delete(Gist::ACCESS_TOKEN_PATH) if File.exist?(Gist::ACCESS_TOKEN_PATH)
+  exit
+end
+
+if options[:sign_in]
+  print 'Username: '
+  username = gets.chomp
+  password = Gist::Helpers.get_password
+  @user = Gist::User.new(username, password)
+  @user.authenticate
+end
+
+if options[:user]
+  @user = Gist::User.new
+  @user.authenticate
+  unless @user.access_token
+    STDERR.puts 'ERROR: There is no user saved. You need to sign in.'
+    exit
+  end
+  post = Gist::Post.new(files, options[:public], options[:description], @user)
+else
+  post = Gist::Post.new(files, options[:public], options[:description])
+end
+gist_url = post.submit(stdin)
+
+Clipboard.copy(gist_url) if options[:clipboard]
+
+puts gist_url

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/gistrb.gemspec

@@ -0,0 +1,27 @@
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'gist/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'gistrb'
+  spec.version       = Gist::VERSION
+  spec.authors       = ['Cameron Roe']
+  spec.email         = ['cameron@cameronbroe.com']
+  spec.licenses      = ['MIT']
+
+  spec.summary       = 'A command-line utility to manage GitHub Gists'
+  spec.homepage      = 'https://github.com/cameronbroe/gistrb'
+
+  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_development_dependency 'bundler', '~> 1.15'
+  spec.add_development_dependency 'rubocop', '~> 0.51'
+  spec.add_dependency 'clipboard', '~> 1.1'
+  spec.add_dependency 'ffi', '~> 1.9.18' if RUBY_PLATFORM =~ /win32/i
+  spec.add_dependency 'highline', '~> 1.7'
+end

data/lib/gist/clipboard.rb

@@ -0,0 +1,10 @@
+module Gist
+  # Helper class for clipboard functions
+  class Clipboard
+    # Wraps clipboard functionality
+    def self::copy(str)
+      Clipboard.clear
+      Clipboard.copy(str)
+    end
+  end
+end

data/lib/gist/helpers.rb

@@ -0,0 +1,9 @@
+module Gist
+  # Helper methods for getting input
+  class Helpers
+    # Method to wrap a highline call to hide a passworded input
+    def self::get_password(prompt = 'Password: ')
+      ask(prompt) { |q| q.echo = false }
+    end
+  end
+end

data/lib/gist/post.rb

@@ -0,0 +1,55 @@
+module Gist
+  # Class that controls a posted Gist
+  class Post
+    attr_accessor :source_files
+    attr_accessor :user
+
+    def initialize(filenames, pub = false, description = nil, user = nil)
+      @user ||= user
+      @public ||= pub
+      @description ||= description ? description : ''
+      @source_files ||= {}
+      populate_source_files(filenames)
+      @http = Net::HTTP.new(Gist::API_URL, Gist::API_PORT)
+      @http.use_ssl = true
+    end
+
+    def submit(stdin)
+    	unless stdin.nil? then
+    		@source_files['STDIN'] = {
+    			'content' => stdin
+    		}
+    	end
+      body = {
+        'files' => @source_files,
+        'public' => @public,
+        'description' => @description
+      }.to_json
+      headers ||= {}
+      unless @user.nil?
+        headers['Authorization'] = "token #{@user.access_token}"
+      end
+      response = @http.post('/gists', body, headers)
+      JSON.parse(response.body)['html_url']
+    end
+
+    private
+
+    def load_code(filename)
+      file = File.open(filename)
+      file_str = ''
+      file.each do |line|
+        file_str << line
+      end
+      file_str
+    end
+
+    private def populate_source_files(filenames)
+      filenames.each do |filename|
+        @source_files[File.basename(filename)] = {
+          'content' => load_code(filename)
+        }
+      end
+    end
+  end
+end

data/lib/gist/user.rb

@@ -0,0 +1,73 @@
+module Gist
+  # Class to hold user information
+  class User
+    attr_accessor :username
+    attr_accessor :password
+    attr_accessor :access_token # Personal access token
+
+    # Create the GistUser instance
+    def initialize(username = nil, password = nil)
+      @username = username
+      @password = password
+      @http = Net::HTTP.new(Gist::API_URL, Gist::API_PORT)
+      @http.use_ssl = true
+      @access_token = load_token if saved?
+    end
+
+    # Authentication method, will set the authentication token for the user
+    def authenticate
+      # If we already have authenticated, don't let it happen again
+      return unless @access_token.nil?
+      # If not, let's authenticate
+      @http.start do |http|
+        response = http.request(auth_obj)
+        json_response = JSON.parse(response.body)
+        @access_token = json_response['token']
+      end
+      # Then save
+      save
+      populate_methods(user_info)
+    end
+
+    private def user_info
+      headers = { 'Authorization' => "token #{access_token}" }
+      response = @http.get('/user', headers)
+      JSON.parse(response.body)
+    end
+
+    private def populate_methods(response)
+      response.each do |k, v|
+        define_singleton_method(k) { v }
+      end
+    end
+
+    private def saved?
+      File.exist?(Gist::ACCESS_TOKEN_PATH)
+    end
+
+    private def save
+      unless Dir.exist?(File.dirname(Gist::ACCESS_TOKEN_PATH))
+        Dir.mkdir(File.dirname(Gist::ACCESS_TOKEN_PATH))
+      end
+      token_file = File.new(Gist::ACCESS_TOKEN_PATH, 'w+')
+      token_file << @access_token
+      token_file.close
+    end
+
+    private def load_token
+      File.readlines(Gist::ACCESS_TOKEN_PATH).first
+    end
+
+    private def auth_obj
+      req = Net::HTTP::Post.new('/authorizations')
+      req.basic_auth(@username, @password)
+      req['Content-Type'] = 'application/json'
+      req.body = {
+        scopes: ['gist'], # Only need Gist scope
+        note: 'Gist access for GistRB client',
+        note_url: 'https://github.com/cameronbroe/gistrb'
+      }.to_json
+      req
+    end
+  end
+end

data/lib/gist/version.rb

@@ -0,0 +1,3 @@
+module Gist
+  VERSION = '0.1.0'.freeze
+end

data/lib/gist.rb

@@ -0,0 +1,18 @@
+require 'net/https'
+require 'highline/import'
+require 'json'
+require 'clipboard'
+
+# Library requires
+require 'gist/user'
+require 'gist/post'
+require 'gist/helpers'
+require 'gist/clipboard'
+
+module Gist
+  # Module level constants
+  API_URL = 'api.github.com'.freeze
+  API_PORT = 443
+
+  ACCESS_TOKEN_PATH = "#{Dir.home}/.gistrb/access_token".freeze
+end

metadata

@@ -0,0 +1,119 @@
+--- !ruby/object:Gem::Specification
+name: gistrb
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Cameron Roe
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-11-16 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.15'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.15'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.51'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.51'
+- !ruby/object:Gem::Dependency
+  name: clipboard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+- !ruby/object:Gem::Dependency
+  name: highline
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+description: 
+email:
+- cameron@cameronbroe.com
+executables:
+- console
+- gistrb
+- setup
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- bin/console
+- bin/gistrb
+- bin/setup
+- gistrb.gemspec
+- lib/gist.rb
+- lib/gist/clipboard.rb
+- lib/gist/helpers.rb
+- lib/gist/post.rb
+- lib/gist/user.rb
+- lib/gist/version.rb
+homepage: https://github.com/cameronbroe/gistrb
+licenses:
+- MIT
+metadata: {}
+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: []
+rubyforge_project: 
+rubygems_version: 2.6.10
+signing_key: 
+specification_version: 4
+summary: A command-line utility to manage GitHub Gists
+test_files: []