ruby-resty 0.1.0 → 0.2.0

data/README.md

@@ -5,7 +5,7 @@
 Ruby-Resty is a ruby port of [Resty][1], which provides a simple way to interact with RESTful services. Ruby-Resty was
 ported to be shell agnostic and for easier community development.
 
-The resty REPL is built on top of [Pry][2] for niceties like [Custom Commands][3], history management, interactive 
+The resty REPL is built on top of [Pry][2] to leverage [Custom Commands][3], history management, an interactive 
 help system, and most importantly, using plain old Ruby.
 
 # Installation
@@ -27,13 +27,18 @@ To get started, you can enter the REPL by providing the `host` option.
 
 ```
 ruby-resty --host http://nyan.cat
-resty>
 ```
 
 If you would like headers to be attached with every request, you can do so:
 
 ```
-ruby-resty --host http://nyan.cat --headers X-NYAN-CAT-SECRET-KEY=nyan_nyan X-NYAN-TYPE=octo
+ruby-resty --host http://nyan.cat --headers X-NYAN-CAT-SECRET-KEY:nyan_nyan X-NYAN-TYPE:octo
+```
+
+HTTP Basic Authentication can be attached to the hostname
+
+```
+ruby-resty --host http://nyan.cat --username Leeroy --password Jenkins
 ```
 
 ### Options
@@ -42,11 +47,14 @@ The REPL accepts the following options that are attached to each request. This p
 requests without having to specify headers everytime.
 
 ```
---alias, -a   : The per-host entry to use in ~/.ruby_resty.yml
---host, -h    : The hostname of the REST service. Ex: http://nyan.cat
---headers, -H : The headers attached to each request. Ex: X-NYAN-CAT-SECRET-KEY=nyan_nyan
---verbose, -v : Verbose mode
---config, -c  : Use host information from ~/.ruby_resty.yml
+--alias, -a    : The per-host entry to use in ~/.ruby_resty.yml
+--headers, -H  : The headers attached to each request. Ex: X-NYAN-CAT-SECRET-KEY:nyan_nyan
+--host, -h     : The hostname of the REST service. Ex: http://nyan.cat
+--username, -u : HTTP basic authentication username
+--password, -p : HTTP basic authentication password
+--verbose, -v  : Verbose mode
+--version, -e  : Print verison and exit
+--config, -c   : Use host information from ~/.ruby_resty.yml
 ```
 
 ### Requests
@@ -100,6 +108,14 @@ resty> data = {nyan_cat: {name: "oliver", color: "blue"} }
 resty> POST /api/cats data
 ```
 
+#### Per-request headers
+
+Headers sent with individual requests are supported:
+
+```
+resty> GET /api/cats/1 -H filter:tail-length -H filter:name
+```
+
 ### Responses
 
 After a request is returned, the resulting JSON response is parsed into a ruby hash and stored in `response`:
@@ -148,6 +164,8 @@ nyan:
   headers:
     header_name: header_value
     header_name2: header_value2
+  username: (optional)
+  password: (optional)
 ```
 
 Now instead of starting the REPL like:

data/Rakefile

@@ -22,3 +22,10 @@ task :copy_config do
     puts "Copied config file to #{config_file}"
   end
 end
+
+namespace :test do
+  desc "Starts the test server used for integration testing"
+  task :server do
+   `ruby ./spec/server.rb`
+  end
+end

data/lib/resty/cli.rb

@@ -4,29 +4,37 @@ module Resty
   class Cli
 
     def run
-      p = Trollop::Parser.new do
+      options = Trollop::options do
+        version "Version: #{Resty::VERSION}\n"
         opt :alias, "The per-host entry to use in ~/.ruby_resty.yml", type: :string, short: "-a"
+        opt :headers, "The headers sent with each request. Ex: X-NYAN-CAT-SECRET-KEY:nyan_nyan",
+          type: :strings, short: "-H"
         opt :host, "The hostname of the REST service. Ex: http://nyan.cat", type: :string, short: "-h"
-        opt :headers, "The headers sent with each request. Ex: X-NYAN-CAT-SECRET-KEY=nyan_nyan",
-            type: :strings, short: "-H"
+        opt :username, "HTTP basic authentication username", type: :string, short: "-u"
+        opt :password, "HTTP basic authentication password", type: :string, short: "-p"
         opt :verbose, "Verbose mode", short: "-v"
       end
 
-      Trollop::with_standard_exception_handling p do
-        options = p.parse(ARGV)
-
-        if (options[:alias] && options[:host]) || (options[:alias].nil? && options[:host].nil?)
-          puts "Please specify an alias OR a host."
-          raise Trollop::HelpNeeded
-        elsif options.empty?
-          raise Trollop::HelpNeeded
-        end
-
+      if missing_host_or_alias?(options)
+        puts "Please specify an alias OR a host. Use --help for more info."
+      elsif basic_auth_invalid?(options)
+        puts "Please specify a username and password. Use --help for more info."
+      else
         Resty::Repl.start(options)
       end
 
     rescue ConfigFileError => e
       puts e.message
     end
+
+    def missing_host_or_alias?(options)
+      (options[:alias] && options[:host]) || (options[:alias].nil? && options[:host].nil?)
+    end
+
+    def basic_auth_invalid?(options)
+      username = options[:username]
+      password = options[:password]
+      (username && password.nil?) || (username.nil? && password)
+    end
   end
 end

data/lib/resty/commands/method_command.rb

@@ -1,4 +1,8 @@
-Pry::Commands.create_command /(get|put|post|delete|head|option|patch|trace)/i, listing: "method-command" do
+require 'hashie'
+
+Pry::Commands.create_command /(get|put|post|delete|head|options|patch)/i,
+  listing: "method-command", :keep_retval => true do
+
   description "Performs an HTTP request to the specified path: METHOD PATH [DATA]"
 
   banner <<-BANNER
@@ -7,6 +11,7 @@ Pry::Commands.create_command /(get|put|post|delete|head|option|patch|trace)/i, l
   Examples: 
   --------- 
   GET    /api/nyan
+  GET    /api/nyan -H filter:color -H type:space
   DELETE /api/nyan
   PUT    /api/nyan {"name": "Jan"}
   POST   /api/nyan {"name": "Jeff"}
@@ -26,24 +31,30 @@ Pry::Commands.create_command /(get|put|post|delete|head|option|patch|trace)/i, l
     shellwords: false
   )
 
+  def setup
+    @user_auth = nil
+  end
+
   def process
     if path_missing?
-      output.puts("Missing path\n\n")
-      run("help method-command")
+      "Missing path. Type 'method-command -h' for more info."
     elsif data_invalid?
-      output.puts("Invalid data\n\n")
-      run("help method-command")
+      "Invalid data. Type 'method-command -h' for more info."
     else
       params = { method: http_method, path: path, data: data }
-      request = Resty::Request.new(cli_options, params)
-      request.send_request do |response, request|
-        method_output = Resty::Commands::MethodOutput.new(cli_options.verbose?, response, request)
-        output.puts(method_output.generate)
+      request = Resty::Request.new(global_options, params)
+      request.send_request({headers: request_headers}) do |response, request|
         eval_response(response)
+        return Hashie::Mash.new(response: response, request: request)
       end
     end
   end
 
+  def options(opt)
+    opt.on "H=", :headers, "Headers sent per-request. Ex: -H header:value -H header:value",
+      as: Array
+  end
+
   private
 
   def path_missing?
@@ -57,7 +68,7 @@ Pry::Commands.create_command /(get|put|post|delete|head|option|patch|trace)/i, l
   def eval_response(response)
     target.eval("response = #{JSON.parse(response)}")
   rescue
-    target.eval("response = nil")
+    target.eval("response = '#{response}'")
   end
 
   def build_data
@@ -81,8 +92,8 @@ Pry::Commands.create_command /(get|put|post|delete|head|option|patch|trace)/i, l
     JSON.parse(input) rescue nil
   end
 
-  def cli_options
-    @cli_options ||= eval "self", target
+  def global_options
+    @global_options ||= eval "self", target
   end
 
   def http_method
@@ -96,4 +107,8 @@ Pry::Commands.create_command /(get|put|post|delete|head|option|patch|trace)/i, l
   def data
     @data ||= build_data
   end
+
+  def request_headers
+    opts[:headers] ? Resty::Options.parse_headers(opts[:headers]) : {}
+  end
 end

data/lib/resty/{cli_options.rb → options.rb}

@@ -1,7 +1,7 @@
 require 'yaml'
 
 module Resty
-  class CliOptions
+  class Options
     attr_reader :options
 
     CONFIG_FILE = "#{Dir.home}/.ruby_resty.yml"
@@ -10,7 +10,7 @@ module Resty
       @options = options
 
       if options[:headers]
-        parse_command_line_headers
+        options[:headers] = Options.parse_headers(options[:headers])
       elsif host_alias
         load_config_file
       end
@@ -32,18 +32,31 @@ module Resty
       options[:headers] || {}
     end
 
-    private
+    def username
+      options[:username]
+    end
 
-    def parse_command_line_headers
-      options[:headers] = options[:headers].inject({}) do |hash, header|
-        hash.merge(build_pair(header))
-      end
+    def password
+      options[:password]
     end
 
+    def self.parse_headers(headers)
+      headers.inject({}) { |hash, header| hash.merge(build_pair(header)) }
+    end
+
+    def self.build_pair(header)
+      pair = header.split(":")
+      { pair.first.to_sym => pair.last }
+    end
+
+    private
+
     def load_config_file
       read_config_file.tap do |config|
         options[:host] = config[host_alias]["host"]
         options[:headers] = config[host_alias]["headers"]
+        options[:username] = config[host_alias]["username"]
+        options[:password] = config[host_alias]["password"]
       end
     end
 
@@ -64,11 +77,6 @@ module Resty
         raise ConfigFileError, "Alias missing from #{CONFIG_FILE}: #{host_alias}"
       end
     end
-
-    def build_pair(header)
-      pair = header.split("=")
-      { pair.first.to_sym => pair.last }
-    end
   end
 
   class ConfigFileError < StandardError; end

data/lib/resty/override_pry_help.rb

@@ -0,0 +1,17 @@
+class Pry
+  class Command::Help < Pry::ClassCommand
+    COMMANDS = %w{method-command}
+
+    def visible_commands
+      visible = {}
+      commands.each do |key, command|
+        visible[key] = command if COMMANDS.include?(command.options[:listing])
+      end
+      visible
+    end
+
+    def help_text_for_commands(name, commands)
+      commands.first.banner
+    end
+  end
+end

data/lib/resty/pretty_printer.rb

@@ -0,0 +1,59 @@
+
+module Resty
+  class PrettyPrinter
+    attr_accessor :options, :params
+
+    def initialize(options, params)
+      @options = options
+      @params = params
+    end
+
+    def generate 
+      if params.is_a? Hashie::Mash
+        output = ""
+        if verbose?
+          output += build_line("#{request.method.upcase} #{request.url}")
+          request.processed_headers.each { |key, value| output += build_line("#{key}: #{value}") }
+          output += "\n"
+
+          output += build_line("Response Code: #{response.code}")
+          response.headers.each { |key, value| output += build_line("#{key}: #{value}") }
+        else
+          output += build_line("Response Code: #{response.code}")
+        end
+
+        output += pretty_print_response(response)
+      else
+        params
+      end
+    end
+
+    private
+
+    def build_line(line)
+      "> #{line}\n"
+    end
+
+    def pretty_print_response(response)
+      return response if response == ""
+      parsed_response = JSON.parse(response)
+      MultiJson.dump(parsed_response, { pretty: true }) || ""
+    rescue => e
+      response
+    end
+
+    private
+
+    def verbose?
+      options.verbose?
+    end
+
+    def request
+      params[:request]
+    end
+
+    def response
+      params[:response]
+    end
+  end
+end

data/lib/resty/repl.rb

@@ -1,23 +1,25 @@
 require 'readline'
-require 'pry'
 
 module Resty
   class Repl
     include Readline
 
-    attr_accessor :cli_options, :interrupted
+    attr_accessor :options, :interrupted
 
     def initialize(resty_options)
-      @cli_options = Resty::CliOptions.new(resty_options)
+      @options = Resty::Options.new(resty_options)
 
       Pry.config.prompt = [ proc { "resty> " }, proc { "*>" }]
       Pry.config.history.file = "~/.ruby_resty_history"
+      Pry.config.print = proc do |output, value|
+        output.puts(Resty::PrettyPrinter.new(options, value).generate)
+      end
     end
 
     def self.start(resty_options)
       new(resty_options).tap do |repl|
         Pry.config.input = repl
-        repl.cli_options.pry
+        repl.options.pry
       end
     end
 

data/lib/resty/request.rb

@@ -3,19 +3,16 @@ require 'json'
 module Resty
   class Request
 
-    attr_reader :params, :cli_options
+    attr_reader :params, :global_options
 
-    def initialize(cli_options, params)
-      @cli_options = cli_options
+    def initialize(global_options, params)
+      @global_options = global_options
       @params = params
     end
 
-    def send_request
-      if Resty::Request.data_required?(method)
-        RestClient.send(method, url, data, cli_options.headers) { |*params| yield params }
-      else
-        RestClient.send(method, url, cli_options.headers) { |*params| yield params }
-      end
+    def send_request(options = {})
+      request_options[:headers].merge!(options[:headers]) if options[:headers]
+      RestClient::Request.new(request_options).execute { |*params| yield params }
     end
 
     def self.data_required?(method)
@@ -24,8 +21,19 @@ module Resty
 
     private
 
+    def request_options
+      @request_options ||= {}.tap do |options|
+        options[:method] = method
+        options[:headers] = global_options.headers
+        options[:url] = url
+        options[:user] = global_options.username if global_options.username
+        options[:password] = global_options.password if global_options.password
+        options[:payload] = data if Resty::Request.data_required?(method)
+      end
+    end
+
     def url
-      "#{cli_options.host}#{path}"
+      "#{global_options.host}#{path}"
     end
 
     def method

data/lib/resty.rb

@@ -1,13 +1,16 @@
-require 'rest_client'
 require 'active_support'
 require 'multi_json'
+require 'pry'
+require 'rest_client'
 
 module Resty
 end
 
+require_relative "version"
 require_relative "resty/cli"
-require_relative "resty/cli_options"
+require_relative "resty/options"
+require_relative "resty/override_pry_help"
+require_relative "resty/pretty_printer"
 require_relative "resty/repl"
 require_relative "resty/request"
 require_relative "resty/commands/method_command"
-require_relative "resty/commands/method_output"

data/lib/version.rb

@@ -1,3 +1,3 @@
 module Resty
-  VERSION = "0.1.0"
+  VERSION = "0.2.0"
 end

data/ruby-resty.gemspec

@@ -16,10 +16,11 @@ Gem::Specification.new do |gem|
   gem.executables   << 'ruby-resty'
 
   gem.add_dependency 'active_support'
+  gem.add_dependency 'hashie'
+  gem.add_dependency 'multi_json'
   gem.add_dependency 'pry'
   gem.add_dependency 'rest-client', '1.6.7'
   gem.add_dependency 'trollop'
-  gem.add_dependency 'multi_json'
 
   gem.add_development_dependency 'bourne', "1.4.0"
   gem.add_development_dependency 'guard'
@@ -28,4 +29,7 @@ Gem::Specification.new do |gem|
   gem.add_development_dependency 'pry'
   gem.add_development_dependency 'rspec'
   gem.add_development_dependency 'rake'
+  gem.add_development_dependency 'sinatra'
+  gem.add_development_dependency 'vcr'
+  gem.add_development_dependency 'webmock'
 end

data/spec/lib/resty/commands/method_command_spec.rb

@@ -17,13 +17,13 @@ describe "MethodCommand" do
     end
 
     it "responds lower case method" do
-      %w{get put post delete head option patch trace}.each do |method|
+      %w{get put post delete head options patch}.each do |method|
         pry_eval("#{method}").start_with?("Missing").should be_true
       end
     end
 
     it "responds to case-insentivity" do
-      %w{GET Put PoSt delete head option patch trace}.each do |method|
+      %w{GET Put PoSt delete head options patch}.each do |method|
         pry_eval("#{method}").start_with?("Missing").should be_true
       end
     end
@@ -49,7 +49,6 @@ describe "MethodCommand" do
 
     context "request doesn't require data" do
       before(:each) do
-        Resty::Commands::MethodOutput.stubs(:new).returns(stub(:generate))
         Resty::Request.stubs(:new).returns(request)
         request.stubs(:send_request).yields(response, request)
         pry_eval("get /api/nyan")
@@ -66,7 +65,6 @@ describe "MethodCommand" do
     let(:method_output) { stub(generate: "")}
 
     before(:each) do
-      Resty::Commands::MethodOutput.stubs(:new).returns(method_output)
       request.stubs(:send_request).yields(response, request)
     end
 
@@ -82,8 +80,7 @@ describe "MethodCommand" do
         end
 
         it "sends request" do
-          Resty::Commands::MethodOutput.should have_received(:new).with(false, response,request)
-          method_output.should have_received(:generate)
+          request.should have_received(:send_request)
         end
       end
     end
@@ -99,8 +96,7 @@ describe "MethodCommand" do
       end
 
       it "sends request" do
-        Resty::Commands::MethodOutput.should have_received(:new).with(false, response,request)
-        method_output.should have_received(:generate)
+        request.should have_received(:send_request)
       end
     end
 
@@ -117,8 +113,7 @@ describe "MethodCommand" do
         end
 
         it "sends request" do
-          Resty::Commands::MethodOutput.should have_received(:new).with(false, response,request)
-          method_output.should have_received(:generate)
+          request.should have_received(:send_request)
         end
       end
 
@@ -134,8 +129,7 @@ describe "MethodCommand" do
         end
 
         it "sends request" do
-          Resty::Commands::MethodOutput.should have_received(:new).with(false, response,request)
-          method_output.should have_received(:generate)
+          request.should have_received(:send_request)
         end
       end
     end
@@ -151,8 +145,22 @@ describe "MethodCommand" do
       end
 
       it "sends request" do
-        Resty::Commands::MethodOutput.should have_received(:new).with(false, response,request)
-        method_output.should have_received(:generate)
+        request.should have_received(:send_request)
+      end
+    end
+
+    context "with request options" do
+      before(:each) do
+        pry_eval("get /api/nyan -H name:nyaa -H address:space")
+      end
+
+      it "creates request" do
+        params  = { method: "get", path: "/api/nyan", data: nil }
+        Resty::Request.should have_received(:new).with(anything, params)
+      end
+
+      it "sends request" do
+        request.should have_received(:send_request).with(headers: { name: "nyaa", address: "space" })
       end
     end
   end