brat 0.1.1

data/lib/brat/client/system_hooks.rb

@@ -0,0 +1,58 @@
+class Brat::Client
+  # Defines methods related to system hooks.
+  module SystemHooks
+    # Gets a list of system hooks.
+    #
+    # @example
+    #   Brat.hooks
+    #   Brat.system_hooks
+    #
+    # @param  [Hash] options A customizable set of options.
+    # @option options [Integer] :page The page number.
+    # @option options [Integer] :per_page The number of results per page.
+    # @return [Array<Brat::ObjectifiedHash>]
+    def hooks(options={})
+      get("/hooks", query: options)
+    end
+    alias_method :system_hooks, :hooks
+
+    # Adds a new system hook.
+    #
+    # @example
+    #   Brat.add_hook('http://example.com/hook')
+    #   Brat.add_system_hook('https://api.example.net/v1/hook')
+    #
+    # @param  [String] url The hook URL.
+    # @return [Brat::ObjectifiedHash]
+    def add_hook(url)
+      post("/hooks", :body => {:url => url})
+    end
+    alias_method :add_system_hook, :add_hook
+
+    # Tests a system hook.
+    #
+    # @example
+    #   Brat.hook(3)
+    #   Brat.system_hook(12)
+    #
+    # @param  [Integer] id The ID of a system hook.
+    # @return [Array<Brat::ObjectifiedHash>]
+    def hook(id)
+      get("/hooks/#{id}")
+    end
+    alias_method :system_hook, :hook
+
+    # Deletes a new system hook.
+    #
+    # @example
+    #   Brat.delete_hook(3)
+    #   Brat.delete_system_hook(12)
+    #
+    # @param  [Integer] id The ID of a system hook.
+    # @return [Brat::ObjectifiedHash]
+    def delete_hook(id)
+      delete("/hooks/#{id}")
+    end
+    alias_method :delete_system_hook, :delete_hook
+  end
+end

data/lib/brat/client/users.rb

@@ -0,0 +1,123 @@
+class Brat::Client
+  # Defines methods related to users.
+  module Users
+    # Gets a list of users.
+    #
+    # @example
+    #   Brat.users
+    #
+    # @param  [Hash] options A customizable set of options.
+    # @option options [Integer] :page The page number.
+    # @option options [Integer] :per_page The number of results per page.
+    # @return [Array<Brat::ObjectifiedHash>]
+    def users(options={})
+      get("/users", :query => options)
+    end
+
+    # Gets information about a user.
+    # Will return information about an authorized user if no ID passed.
+    #
+    # @example
+    #   Brat.user
+    #   Brat.user(2)
+    #
+    # @param  [Integer] id The ID of a user.
+    # @return [Brat::ObjectifiedHash]
+    def user(id=nil)
+      id.to_i.zero? ? get("/user") : get("/users/#{id}")
+    end
+
+    # Creates a new user.
+    # Requires authentication from an admin account.
+    #
+    # @param  [String] email The email of a user.
+    # @param  [String] password The password of a user.
+    # @param  [Hash] options A customizable set of options.
+    # @option options [String] :name The name of a user. Defaults to email.
+    # @option options [String] :skype The skype of a user.
+    # @option options [String] :linkedin The linkedin of a user.
+    # @option options [String] :twitter The twitter of a user.
+    # @option options [Integer] :projects_limit The limit of projects for a user.
+    # @return [Brat::ObjectifiedHash] Information about created user.
+    def create_user(email, password, options={})
+      body = {:email => email, :password => password, :name => email}.merge(options)
+      post("/users", :body => body)
+    end
+
+    # Updates a user.
+    #
+    # @param  [Integer] id The ID of a user.
+    # @param  [Hash] options A customizable set of options.
+    # @option options [String] email The email of a user.
+    # @option options [String] password The password of a user.
+    # @option options [String] :name The name of a user. Defaults to email.
+    # @option options [String] :skype The skype of a user.
+    # @option options [String] :linkedin The linkedin of a user.
+    # @option options [String] :twitter The twitter of a user.
+    # @option options [Integer] :projects_limit The limit of projects for a user.
+    # @return [Brat::ObjectifiedHash] Information about created user.
+    def edit_user(user_id, options={})
+      put("/users/#{user_id}", :body => options)
+    end
+
+    # Creates a new user session.
+    #
+    # @example
+    #   Brat.session('jack@example.com', 'secret12345')
+    #
+    # @param  [String] email The email of a user.
+    # @param  [String] password The password of a user.
+    # @return [Brat::ObjectifiedHash]
+    # @note This method doesn't require private_token to be set.
+    def session(email, password)
+      post("/session", :body => {:email => email, :password => password})
+    end
+
+    # Gets a list of user's SSH keys.
+    #
+    # @example
+    #   Brat.ssh_keys
+    #
+    # @param  [Hash] options A customizable set of options.
+    # @option options [Integer] :page The page number.
+    # @option options [Integer] :per_page The number of results per page.
+    # @return [Array<Brat::ObjectifiedHash>]
+    def ssh_keys(options={})
+      get("/user/keys", :query => options)
+    end
+
+    # Gets information about SSH key.
+    #
+    # @example
+    #   Brat.ssh_key(1)
+    #
+    # @param  [Integer] id The ID of a user's SSH key.
+    # @return [Brat::ObjectifiedHash]
+    def ssh_key(id)
+      get("/user/keys/#{id}")
+    end
+
+    # Creates a new SSH key.
+    #
+    # @example
+    #   Brat.create_ssh_key('key title', 'key body')
+    #
+    # @param  [String] title The title of an SSH key.
+    # @param  [String] key The SSH key body.
+    # @return [Brat::ObjectifiedHash] Information about created SSH key.
+    def create_ssh_key(title, key)
+      post("/user/keys", :body => {:title => title, :key => key})
+    end
+
+    # Deletes an SSH key.
+    #
+    # @example
+    #   Brat.delete_ssh_key(1)
+    #
+    # @param  [Integer] id The ID of a user's SSH key.
+    # @return [Brat::ObjectifiedHash] Information about deleted SSH key.
+    def delete_ssh_key(id)
+      delete("/user/keys/#{id}")
+    end
+  end
+end

data/lib/brat/configuration.rb

@@ -0,0 +1,40 @@
+module Brat
+  # Defines constants and methods related to configuration.
+  module Configuration
+    # An array of valid keys in the options hash when configuring a Brat::API.
+    VALID_OPTIONS_KEYS = [:endpoint, :private_token, :user_agent, :sudo,
+                           :namespace, :api_version, :host].freeze
+
+    # The user agent that will be sent to the API endpoint if none is set.
+    DEFAULT_USER_AGENT = "Brat Ruby Gem #{Brat::VERSION}".freeze
+
+    # @private
+    attr_accessor(*VALID_OPTIONS_KEYS)
+
+    # Sets all configuration options to their default values
+    # when this module is extended.
+    def self.extended(base)
+      base.reset
+    end
+
+    # Convenience method to allow configuration options to be set in a block.
+    def configure
+      yield self
+    end
+
+    # Creates a hash of options and their values.
+    def options
+      VALID_OPTIONS_KEYS.inject({}) do |option, key|
+        option.merge!(key => send(key))
+      end
+    end
+
+    # Resets all configuration options to the defaults.
+    def reset
+      self.endpoint       = 'http://brat.io/api/v3'
+      self.private_token  = ENV['BRAT_API_PRIVATE_TOKEN']
+      self.sudo           = nil
+      self.user_agent     = DEFAULT_USER_AGENT
+    end
+  end
+end

data/lib/brat/error.rb

@@ -0,0 +1,42 @@
+module Brat
+  module Error
+    # Custom error class for rescuing from all Brat errors.
+    class Error < StandardError; end
+
+    # Raise when attributes are missing.
+    class MissingAttributes < Error; end
+
+    # Raised when API endpoint credentials not configured.
+    class MissingCredentials < Error; end
+
+    # Raised when impossible to parse response body.
+    class Parsing < Error; end
+
+    # Raised when API endpoint returns the HTTP status code 400.
+    class BadRequest < Error; end
+
+    # Raised when API endpoint returns the HTTP status code 401.
+    class Unauthorized < Error; end
+
+    # Raised when API endpoint returns the HTTP status code 403.
+    class Forbidden < Error; end
+
+    # Raised when API endpoint returns the HTTP status code 404.
+    class NotFound < Error; end
+
+    # Raised when API endpoint returns the HTTP status code 405.
+    class MethodNotAllowed < Error; end
+
+    # Raised when API endpoint returns the HTTP status code 409.
+    class Conflict < Error; end
+
+    # Raised when API endpoint returns the HTTP status code 500.
+    class InternalServerError < Error; end
+
+    # Raised when API endpoint returns the HTTP status code 502.
+    class BadGateway < Error; end
+
+    # Raised when API endpoint returns the HTTP status code 503.
+    class ServiceUnavailable < Error; end
+  end
+end

data/lib/brat/help.rb

@@ -0,0 +1,44 @@
+require 'brat'
+require 'brat/cli_helpers'
+
+module Brat::Help
+  extend Brat::CLI::Helpers
+
+  def self.get_help(methods,cmd=nil)
+    help = ''
+
+    if cmd.nil? || cmd == 'help'
+      help = actions_table
+    else
+      ri_cmd = `which ri`.chomp
+
+      if $? == 0
+        namespace = methods.select {|m| m[:name] === cmd }.map {|m| m[:owner]+'.'+m[:name] }.shift
+
+        if namespace
+          begin
+            ri_output = `#{ri_cmd} -T #{namespace} 2>&1`.chomp
+
+            if $? == 0
+              ri_output.gsub!(/#{cmd}\((.*)\)/, cmd+' \1')
+              ri_output.gsub!(/Brat\./, 'brat> ')
+              ri_output.gsub!(/Brat\..+$/, '')
+              ri_output.gsub!(/\,/, '')
+              help = ri_output
+            else
+              help = "Ri docs not found for #{namespace}, please install the docs to use 'help'"
+            end
+          rescue => e
+            puts e.message
+          end
+        else
+          help = "Unknown command: #{cmd}"
+        end
+      else
+        help = "'ri' tool not found in your PATH, please install it to use the help."
+      end
+    end
+
+    puts help
+  end
+end

data/lib/brat/objectified_hash.rb

@@ -0,0 +1,24 @@
+module Brat
+  # Converts hashes to the objects.
+  class ObjectifiedHash
+    # Creates a new ObjectifiedHash object.
+    def initialize(hash)
+      @hash = hash
+      @data = hash.inject({}) do |data, (key,value)|
+        value = ObjectifiedHash.new(value) if value.is_a? Hash
+        data[key.to_s] = value
+        data
+      end
+    end
+
+    def to_hash
+      @hash
+    end
+    alias_method :to_h, :to_hash
+
+    # Delegate to ObjectifiedHash.
+    def method_missing(key)
+      @data.key?(key.to_s) ? @data[key.to_s] : nil
+    end
+  end
+end

data/lib/brat/request.rb

@@ -0,0 +1,101 @@
+require 'httparty'
+require 'json'
+
+module Brat
+  # @private
+  class Request
+    include HTTParty
+    format :json
+    headers 'Accept' => 'application/json'
+    parser Proc.new { |body, _| parse(body) }
+
+    attr_accessor :private_token
+
+    # Converts the response body to an ObjectifiedHash.
+    def self.parse(body)
+      body = decode(body)
+
+      if body.is_a? Hash
+        ObjectifiedHash.new body
+      elsif body.is_a? Array
+        body.collect! { |e| ObjectifiedHash.new(e) }
+      else
+        raise Error::Parsing.new "Couldn't parse a response body"
+      end
+    end
+
+    # Decodes a JSON response into Ruby object.
+    def self.decode(response)
+      begin
+        JSON.load response
+      rescue JSON::ParserError
+        raise Error::Parsing.new "The response is not a valid JSON"
+      end
+    end
+
+    def get(path, options={})
+      set_private_token_header(options)
+      validate self.class.get(path, options)
+    end
+
+    def post(path, options={})
+      set_private_token_header(options, path)
+      validate self.class.post(path, options)
+    end
+
+    def put(path, options={})
+      set_private_token_header(options)
+      validate self.class.put(path, options)
+    end
+
+    def delete(path, options={})
+      set_private_token_header(options)
+      validate self.class.delete(path, options)
+    end
+
+    # Checks the response code for common errors.
+    # Returns parsed response for successful requests.
+    def validate(response)
+      case response.code
+        when 400; raise Error::BadRequest.new error_message(response)
+        when 401; raise Error::Unauthorized.new error_message(response)
+        when 403; raise Error::Forbidden.new error_message(response)
+        when 404; raise Error::NotFound.new error_message(response)
+        when 405; raise Error::MethodNotAllowed.new error_message(response)
+        when 409; raise Error::Conflict.new error_message(response)
+        when 500; raise Error::InternalServerError.new error_message(response)
+        when 502; raise Error::BadGateway.new error_message(response)
+        when 503; raise Error::ServiceUnavailable.new error_message(response)
+      end
+
+      response.parsed_response
+    end
+
+    # Sets a base_uri and default_params for requests.
+    # @raise [Error::MissingCredentials] if endpoint not set.
+    def set_request_defaults(endpoint, private_token, sudo=nil)
+      raise Error::MissingCredentials.new("Please set an endpoint to API") unless endpoint
+      @private_token = private_token
+
+      self.class.base_uri endpoint
+      self.class.default_params :sudo => sudo
+      self.class.default_params.delete(:sudo) if sudo.nil?
+    end
+
+    private
+
+    # Sets a PRIVATE-TOKEN header for requests.
+    # @raise [Error::MissingCredentials] if private_token not set.
+    def set_private_token_header(options, path=nil)
+      unless path == '/session'
+        raise Error::MissingCredentials.new("Please set a private_token for user") unless @private_token
+        options[:headers] = {'PRIVATE-TOKEN' => @private_token}
+      end
+    end
+
+    def error_message(response)
+      "Server responded with code #{response.code}, message: #{response.parsed_response.message}. " \
+      "Request URI: #{response.request.base_uri}#{response.request.path}"
+    end
+  end
+end

data/lib/brat/shell.rb

@@ -0,0 +1,49 @@
+require 'brat'
+require 'brat/help'
+require 'brat/cli_helpers'
+require 'readline'
+
+class Brat::Shell
+  extend Brat::CLI::Helpers
+
+  def self.start
+    actions = Brat.actions
+
+    comp = proc { |s| actions.map(&:to_s).grep(/^#{Regexp.escape(s)}/) }
+
+    Readline.completion_proc = comp
+    Readline.completion_append_character = ' '
+
+    client = Brat::Client.new(endpoint: '')
+
+    while buf = Readline.readline("brat> ", true)
+      next if buf.nil? || buf.empty?
+      buf = buf.split.map(&:chomp)
+      cmd = buf.shift
+      args = buf.count > 0 ? buf : []
+
+      if cmd == 'help'
+        methods = []
+
+        actions.each do |action|
+          methods << {
+            name: action.to_s,
+            owner: client.method(action).owner.to_s
+          }
+        end
+
+        args[0].nil? ? Brat::Help.get_help(methods) : Brat::Help.get_help(methods, args[0])
+        next
+      end
+
+      data = if actions.include?(cmd.to_sym)
+        confirm_command(cmd)
+        brat_helper(cmd, args)
+      else
+        "'#{cmd}' is not a valid command.  See the 'help' for a list of valid commands."
+      end
+
+      output_table(cmd, args, data)
+    end
+  end
+end