brat 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 057d5021e30f18c5dc02e68e144aac17b41d1cc9
+  data.tar.gz: 32c68c61399d306e309e36b2720a433fb9113a52
+SHA512:
+  metadata.gz: b6a52cc17f8bece0515273aa515315bb96563997734772fa844a34b1d1e89f72b2f7354f78f52bdca0f2c7f91cd70818087650d056ed62e9047e46557bd46ee4
+  data.tar.gz: fcf7496ccd8efde5c835f1e03c49e0a6473ee851bd00843a3e3274adc5f90f80a9ce9a84f8d1b1cf355de606727f3d2b0065b6b1ffc0d122134cf32639b9d9b3

data/.gitignore

@@ -0,0 +1,20 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+.idea
+.ruby-version
+.ruby-gemset

data/.travis.yml

@@ -0,0 +1,3 @@
+language: ruby
+rvm:
+  - 2.2.0

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,24 @@
+Copyright (c) 2012-2014 Nihad Abbasov <mail@narkoz.me>
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
+
+1. Redistributions of source code must retain the above copyright notice,
+this list of conditions and the following disclaimer.
+
+2. Redistributions in binary form must reproduce the above copyright notice,
+this list of conditions and the following disclaimer in the documentation
+and/or other materials provided with the distribution.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
+ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
+LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
+CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
+SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
+INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
+CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
+ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
+POSSIBILITY OF SUCH DAMAGE.

data/README.md

@@ -0,0 +1,103 @@
+# Brat
+
+[website](http://brat.io/brat-io/brat)
+[![build status](http://ci.brat.io/projects/7/status.png?ref=master)](http://ci.brat.io/projects/7?ref=master)
+
+Brat is a wrapper and CLI for (Brat.io)[http://brat.io/brat-io/brat]. We are currently in pre-release.
+
+## Installation
+
+Install it from rubygems:
+
+```sh
+gem install brat
+```
+
+Or add to a Gemfile:
+
+```ruby
+gem 'brat'
+# gem 'brat', :git => 'git://brat.io/brat-io/brat.git'
+```
+
+## Usage
+
+Rails Configuration example:
+
+```ruby
+Brat.configure do |config|
+  config.private_token  = 'qEsq1pt6HJPaNciie3MG'       # user's private token, default: ENV['BRAT_API_PRIVATE_TOKEN']
+  # Optional
+  # config.endpoint     = 'http://brat.io/api/v3'      # API endpoint URL, default: 'http://brat.io/api/v3'
+  # config.user_agent   = 'Custom User Agent'          # user agent, default: 'Brat Ruby Gem [version]'
+  # config.sudo         = 'user'                       # username for sudo mode, default: nil
+end
+```
+
+Usage examples:
+
+```ruby
+# set a user private token
+Brat.private_token = 'qEsq1pt6HJPaNciie3MG'
+# => "qEsq1pt6HJPaNciie3MG"
+
+# list projects
+Brat.projects(:per_page => 5)
+# => [#<Brat::ObjectifiedHash:0x000000023326e0 @data={"id"=>1, "code"=>"brute", "name"=>"Brute", "description"=>nil, "path"=>"brute", "default_branch"=>nil, "owner"=>#<Brat::ObjectifiedHash:0x00000002331600 @data={"id"=>1, "email"=>"john@example.com", "name"=>"John Smith", "blocked"=>false, "created_at"=>"2012-09-17T09:41:56Z"}>, "private"=>true, "issues_enabled"=>true, "merge_requests_enabled"=>true, "wall_enabled"=>true, "wiki_enabled"=>true, "created_at"=>"2012-09-17T09:41:56Z"}>, #<Brat::ObjectifiedHash:0x000000023450d8 @data={"id"=>2, "code"=>"mozart", "name"=>"Mozart", "description"=>nil, "path"=>"mozart", "default_branch"=>nil, "owner"=>#<Brat::ObjectifiedHash:0x00000002344ca0 @data={"id"=>1, "email"=>"john@example.com", "name"=>"John Smith", "blocked"=>false, "created_at"=>"2012-09-17T09:41:56Z"}>, "private"=>true, "issues_enabled"=>true, "merge_requests_enabled"=>true, "wall_enabled"=>true, "wiki_enabled"=>true, "created_at"=>"2012-09-17T09:41:57Z"}>, #<Brat::ObjectifiedHash:0x00000002344958 @data={"id"=>3, "code"=>"brat", "name"=>"Brat", "description"=>nil, "path"=>"brat", "default_branch"=>nil, "owner"=>#<Brat::ObjectifiedHash:0x000000023447a0 @data={"id"=>1, "email"=>"john@example.com", "name"=>"John Smith", "blocked"=>false, "created_at"=>"2012-09-17T09:41:56Z"}>, "private"=>true, "issues_enabled"=>true, "merge_requests_enabled"=>true, "wall_enabled"=>true, "wiki_enabled"=>true, "created_at"=>"2012-09-17T09:41:58Z"}>]
+
+# initialize a new client
+g = Brat.client(:endpoint => 'https://brat.io/api/v3', private_token: 'qEsq1pt6HJPaNciie3MG')
+# => #<Brat::Client:0x00000001e62408 @endpoint="https://api.example.com", @private_token="qEsq1pt6HJPaNciie3MG", @user_agent="Brat Ruby Gem 0.1.1">
+
+# get a user
+user = g.user
+# => #<Brat::ObjectifiedHash:0x00000002217990 @data={"id"=>1, "email"=>"john@example.com", "name"=>"John Smith", "bio"=>nil, "skype"=>"", "linkedin"=>"", "twitter"=>"john", "dark_scheme"=>false, "theme_id"=>1, "blocked"=>false, "created_at"=>"2012-09-17T09:41:56Z"}>
+
+# get a user's email
+user.email
+# => "john@example.com"
+
+```
+
+## CLI
+
+Usage examples:
+
+```sh
+# set your private_token
+# list users
+brat users
+
+# get current user
+brat user
+
+# get a user
+brat user 2
+
+# filter output
+brat user --only=id,username
+
+brat user --except=email,bio
+```
+
+## CLI Shell
+
+Usage examples:
+
+```sh
+# start shell session
+brat shell
+
+# list available commands
+brat> help
+
+# list groups
+brat> groups
+
+# protect a branch
+brat> protect_branch 1 master
+```
+
+## License
+
+Released under the BSD 2-clause license. See LICENSE.txt for details.

data/Rakefile

@@ -0,0 +1,9 @@
+require "bundler/gem_tasks"
+
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec) do |spec|
+  spec.pattern    = FileList['spec/**/*_spec.rb']
+  spec.rspec_opts = ['--color', '--format d']
+end
+
+task :default => :spec

data/bin/brat

@@ -0,0 +1,7 @@
+#!/usr/bin/env ruby
+
+$:.unshift File.expand_path('../../lib', __FILE__)
+
+require 'brat/cli'
+
+Brat::CLI.start(ARGV)

data/brat.gemspec

@@ -0,0 +1,26 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'brat/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = "brat"
+  gem.version       = Brat::VERSION
+  gem.authors       = ["John-Henry Liberty"]
+  gem.email         = ["johnhenry.liberty@gmail.com"]
+  gem.description   = %q{Ruby client and CLI for Brat.io}
+  gem.summary       = %q{A Ruby wrapper and CLI for the Brat.io API}
+  gem.homepage      = "https://github.com/jhliberty/brat-cli"
+
+  gem.files         = `git ls-files`.split($/)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.require_paths = ["lib"]
+
+  gem.add_runtime_dependency 'httparty'
+  gem.add_runtime_dependency 'terminal-table'
+
+  gem.add_development_dependency 'rake'
+  gem.add_development_dependency 'rspec'
+  gem.add_development_dependency 'webmock'
+end

data/lib/brat.rb

@@ -0,0 +1,37 @@
+require 'brat/version'
+require 'brat/objectified_hash'
+require 'brat/configuration'
+require 'brat/error'
+require 'brat/request'
+require 'brat/api'
+require 'brat/client'
+
+module Brat
+  extend Configuration
+
+  # Alias for Brat::Client.new
+  #
+  # @return [Brat::Client]
+  def self.client(options={})
+    Brat::Client.new(options)
+  end
+
+  # Delegate to Brat::Client
+  def self.method_missing(method, *args, &block)
+    return super unless client.respond_to?(method)
+    client.send(method, *args, &block)
+  end
+
+  # Delegate to Brat::Client
+  def self.respond_to?(method)
+    return client.respond_to?(method) || super
+  end
+
+  # Returns an unsorted array of available client methods.
+  #
+  # @return [Array<Symbol>]
+  def self.actions
+    hidden = /endpoint|private_token|user_agent|sudo|get|post|put|\Adelete\z|validate|set_request_defaults/
+    (Brat::Client.instance_methods - Object.methods).reject {|e| e[hidden]}
+  end
+end

data/lib/brat/api.rb

@@ -0,0 +1,17 @@
+module Brat
+  # @private
+  class API < Request
+    # @private
+    attr_accessor(*Configuration::VALID_OPTIONS_KEYS)
+
+    # Creates a new API.
+    # @raise [Error:MissingCredentials]
+    def initialize(options={})
+      options = Brat.options.merge(options)
+      Configuration::VALID_OPTIONS_KEYS.each do |key|
+        send("#{key}=", options[key])
+      end
+      set_request_defaults @endpoint, @private_token, @sudo
+    end
+  end
+end

data/lib/brat/cli.rb

@@ -0,0 +1,47 @@
+require 'brat'
+require 'terminal-table/import'
+require_relative 'cli_helpers'
+require_relative 'shell'
+
+class Brat::CLI
+  extend Helpers
+
+  def self.start(args)
+    command = args.shift.strip rescue 'help'
+    run(command, args)
+  end
+
+  def self.run(cmd, args=[])
+    case cmd
+    when 'help'
+      puts actions_table
+    when 'info'
+      endpoint = Brat.endpoint ? Brat.endpoint : 'not set'
+      private_token = Brat.private_token ? Brat.private_token : 'not set'
+      puts "Brat endpoint is #{endpoint}"
+      puts "Brat private token is #{private_token}"
+      puts "Ruby Version is #{RUBY_VERSION}"
+      puts "Brat Ruby Gem #{Brat::VERSION}"
+    when '-v', '--version'
+      puts "Brat Ruby Gem #{Brat::VERSION}"
+    when 'shell'
+      Brat::Shell.start
+    else
+      unless valid_command?(cmd)
+        puts "Unknown command. Run `brat help` for a list of available commands."
+        exit(1)
+      end
+
+      if args.any? && (args.last.start_with?('--only=') || args.last.start_with?('--except='))
+        command_args = args[0..-2]
+      else
+        command_args = args
+      end
+
+      confirm_command(cmd)
+
+      data = brat_helper(cmd, command_args) { exit(1) }
+      output_table(cmd, args, data)
+    end
+  end
+end

data/lib/brat/cli_helpers.rb

@@ -0,0 +1,175 @@
+class Brat::CLI
+  # Defines methods related to CLI output and formatting.
+  module Helpers
+    extend self
+
+    # Returns filtered required fields.
+    #
+    # @return [Array]
+    def required_fields(args)
+      if args.any? && args.last.start_with?('--only=')
+        args.last.gsub('--only=', '').split(',')
+      else
+        []
+      end
+    end
+
+    # Returns filtered excluded fields.
+    #
+    # @return [Array]
+    def excluded_fields(args)
+      if args.any? && args.last.start_with?('--except=')
+        args.last.gsub('--except=', '').split(',')
+      else
+        []
+      end
+    end
+
+    # Confirms command is valid.
+    #
+    # @return [Boolean]
+    def valid_command?(cmd)
+      command = cmd.is_a?(Symbol) ? cmd : cmd.to_sym
+      Brat.actions.include?(command)
+    end
+
+    # Confirms command with a desctructive action.
+    #
+    # @return [String]
+    def confirm_command(cmd)
+      if cmd.start_with?('remove_') || cmd.start_with?('delete_')
+        puts "Are you sure? (y/n)"
+        if %w(y yes).include?($stdin.gets.to_s.strip.downcase)
+          puts 'Proceeding..'
+        else
+          puts 'Command aborted.'
+          exit(1)
+        end
+      end
+    end
+
+    # Table with available commands.
+    #
+    # @return [String]
+    def actions_table
+      client = Brat::Client.new(endpoint: '')
+      actions = Brat.actions
+      methods = []
+
+      actions.each do |action|
+        methods << {
+          name: action,
+          owner: client.method(action).owner.to_s.gsub('Brat::Client::', '')
+        }
+      end
+
+      owners = methods.map {|m| m[:owner]}.uniq.sort
+      methods_c = methods.group_by {|m| m[:owner]}
+      methods_c = methods_c.map {|_, v| [_, v.sort_by {|hv| hv[:name]}] }
+      methods_c = Hash[methods_c.sort_by(&:first).map {|k, v| [k, v]}]
+      max_column_length = methods_c.values.max_by(&:size).size
+
+      rows = max_column_length.times.map do |i|
+        methods_c.keys.map do |key|
+          methods_c[key][i] ? methods_c[key][i][:name] : ''
+        end
+      end
+
+      table do |t|
+        t.title = "Available commands (#{actions.size} total)"
+        t.headings = owners
+
+        rows.each do |row|
+          t.add_row row
+        end
+      end
+    end
+
+    # Decides which table to use.
+    #
+    # @return [String]
+    def output_table(cmd, args, data)
+      case data
+      when Brat::ObjectifiedHash
+        puts single_record_table(data, cmd, args)
+      when Array
+        puts multiple_record_table(data, cmd, args)
+      else
+        puts data.inspect
+      end
+    end
+
+    # Table for a single record.
+    #
+    # @return [String]
+    def single_record_table(data, cmd, args)
+      hash = data.to_h
+      keys = hash.keys.sort {|x, y| x.to_s <=> y.to_s }
+      keys = keys & required_fields(args) if required_fields(args).any?
+      keys = keys - excluded_fields(args)
+
+      table do |t|
+        t.title = "Brat.#{cmd} #{args.join(', ')}"
+
+        keys.each_with_index do |key, index|
+          case value = hash[key]
+          when Hash
+            value = 'Hash'
+          when nil
+            value = 'null'
+          end
+
+          t.add_row [key, value]
+          t.add_separator unless keys.size - 1 == index
+        end
+      end
+    end
+
+    # Table for multiple records.
+    #
+    # @return [String]
+    def multiple_record_table(data, cmd, args)
+      return 'No data' if data.empty?
+
+      arr = data.map(&:to_h)
+      keys = arr.first.keys.sort {|x, y| x.to_s <=> y.to_s }
+      keys = keys & required_fields(args) if required_fields(args).any?
+      keys = keys - excluded_fields(args)
+
+      table do |t|
+        t.title = "Brat.#{cmd} #{args.join(', ')}"
+        t.headings = keys
+
+        arr.each_with_index do |hash, index|
+          values = []
+
+          keys.each do |key|
+            case value = hash[key]
+            when Hash
+              value = 'Hash'
+            when nil
+              value = 'null'
+            end
+
+            values << value
+          end
+
+          t.add_row values
+          t.add_separator unless arr.size - 1 == index
+        end
+      end
+    end
+
+    # Helper function to call Brat commands with args.
+    def brat_helper(cmd, args=[])
+      begin
+        data = args.any? ? Brat.send(cmd, *args) : Brat.send(cmd)
+      rescue => e
+        puts e.message
+        yield if block_given?
+      end
+
+      data
+    end
+  end
+end