rest-man 1.0.0

data/Rakefile

@@ -0,0 +1,140 @@
+# load `rake build/install/release tasks'
+require 'bundler/setup'
+require_relative './lib/restman/version'
+
+namespace :ruby do
+  Bundler::GemHelper.install_tasks(:name => 'rest-man')
+end
+
+require "rspec/core/rake_task"
+
+desc "Run all specs"
+RSpec::Core::RakeTask.new('spec')
+
+desc "Run unit specs"
+RSpec::Core::RakeTask.new('spec:unit') do |t|
+  t.pattern = 'spec/unit/*_spec.rb'
+end
+
+desc "Run integration specs"
+RSpec::Core::RakeTask.new('spec:integration') do |t|
+  t.pattern = 'spec/integration/*_spec.rb'
+end
+
+desc "Print specdocs"
+RSpec::Core::RakeTask.new(:doc) do |t|
+  t.rspec_opts = ["--format", "specdoc", "--dry-run"]
+  t.pattern = 'spec/**/*_spec.rb'
+end
+
+desc "Run all examples with RCov"
+RSpec::Core::RakeTask.new('rcov') do |t|
+  t.pattern = 'spec/*_spec.rb'
+  t.rcov = true
+  t.rcov_opts = ['--exclude', 'examples']
+end
+
+desc 'Regenerate authors file'
+task :authors do
+  Dir.chdir(File.dirname(__FILE__)) do
+    File.open('AUTHORS', 'w') do |f|
+      f.write <<-EOM
+The Ruby REST Client would not be what it is today without the help of
+the following kind souls:
+
+      EOM
+    end
+
+    sh 'git shortlog -s | cut -f 2 >> AUTHORS'
+  end
+end
+
+task :default do
+  sh 'rake -T'
+end
+
+def alias_task(alias_task, original)
+  desc "Alias for rake #{original}"
+  task alias_task, Rake.application[original].arg_names => original
+end
+alias_task(:test, :spec)
+
+############################
+
+WindowsPlatforms = %w{x86-mingw32 x64-mingw32 x86-mswin32}
+
+namespace :all do
+
+  desc "Build rest-man #{RestMan::VERSION} for all platforms"
+  task :build => ['ruby:build'] + \
+    WindowsPlatforms.map {|p| "windows:#{p}:build"}
+
+  desc "Create tag v#{RestMan::VERSION} and for all platforms build and " \
+    "push rest-man #{RestMan::VERSION} to Rubygems"
+  task :release => ['build', 'ruby:release'] + \
+    WindowsPlatforms.map {|p| "windows:#{p}:push"}
+
+end
+
+namespace :windows do
+  spec_path = File.join(File.dirname(__FILE__), 'rest-man.windows.gemspec')
+
+  WindowsPlatforms.each do |platform|
+    namespace platform do
+      gem_filename = "rest-man-#{RestMan::VERSION}-#{platform}.gem"
+      base = File.dirname(__FILE__)
+      pkg_dir = File.join(base, 'pkg')
+      gem_file_path = File.join(pkg_dir, gem_filename)
+
+      desc "Build #{gem_filename} into the pkg directory"
+      task 'build' do
+        orig_platform = ENV['BUILD_PLATFORM']
+        begin
+          ENV['BUILD_PLATFORM'] = platform
+
+          sh("gem build -V #{spec_path}") do |ok, res|
+            if ok
+              FileUtils.mkdir_p(pkg_dir)
+              FileUtils.mv(File.join(base, gem_filename), pkg_dir)
+              Bundler.ui.confirm("rest-man #{RestMan::VERSION} " \
+                                 "built to pkg/#{gem_filename}")
+            else
+              abort "Command `gem build` failed: #{res}"
+            end
+          end
+
+        ensure
+          ENV['BUILD_PLATFORM'] = orig_platform
+        end
+      end
+
+      desc "Push #{gem_filename} to Rubygems"
+      task 'push' do
+        sh("gem push #{gem_file_path}")
+      end
+    end
+  end
+
+end
+
+############################
+
+require 'rdoc/task'
+
+Rake::RDocTask.new do |t|
+  t.rdoc_dir = 'rdoc'
+  t.title    = "rest-man, fetch RESTful resources effortlessly"
+  t.options << '--line-numbers' << '--inline-source' << '-A cattr_accessor=object'
+  t.options << '--charset' << 'utf-8'
+  t.rdoc_files.include('README.md')
+  t.rdoc_files.include('lib/*.rb')
+end
+
+############################
+
+require 'rubocop/rake_task'
+
+RuboCop::RakeTask.new(:rubocop) do |t|
+  t.options = ['--display-cop-names']
+end
+alias_task(:lint, :rubocop)

data/exe/restman

@@ -0,0 +1,92 @@
+#!/usr/bin/env ruby
+
+$LOAD_PATH.unshift File.dirname(__FILE__) + "/../lib"
+
+require 'rubygems'
+require 'restman'
+require 'yaml'
+
+def usage(why = nil)
+  puts "failed for reason: #{why}" if why
+  puts "usage: restman [get|put|post|delete] url|name [username] [password]"
+  puts "  The verb is optional, if you leave it off you'll get an interactive shell."
+  puts "  put and post both take the input body on stdin."
+  exit(1)
+end
+
+POSSIBLE_VERBS = ['get', 'put', 'post', 'delete']
+
+if POSSIBLE_VERBS.include? ARGV.first
+  @verb = ARGV.shift
+else
+  @verb = nil
+end
+
+@url = ARGV.shift || 'http://localhost:4567'
+
+config = YAML.load(File.read(ENV['HOME'] + "/.restman")) rescue {}
+
+if (c = config[@url])
+  @url, @username, @password = [c['url'], c['username'], c['password']]
+else
+  @url, @username, @password = [@url, * ARGV]
+end
+
+usage("invalid url '#{@url}") unless @url =~ /^https?/
+usage("too few args") unless ARGV.size < 3
+
+def r
+  @r ||= RestMan::Resource.new(@url, @username, @password)
+end
+
+r # force rc to load
+
+if @verb
+  begin
+    if %w( put post ).include? @verb
+      puts r.send(@verb, STDIN.read)
+    else
+      puts r.send(@verb)
+    end
+    exit 0
+  rescue RestMan::Exception => e
+    puts e.response.body if e.respond_to?(:response) && e.response
+    raise
+  end
+end
+
+POSSIBLE_VERBS.each do |m|
+  define_method(m.to_sym) do |path, *args, &b|
+    r[path].public_send(m.to_sym, *args, &b)
+  end
+end
+
+def method_missing(s, * args, & b)
+  if POSSIBLE_VERBS.include? s
+    begin
+      r.send(s, *args, & b)
+    rescue RestMan::RequestFailed => e
+      print STDERR, e.response.body
+      raise e
+    end
+  else
+    super
+  end
+end
+
+require 'irb'
+require 'irb/completion'
+
+if File.exist? ".irbrc"
+  ENV['IRBRC'] = ".irbrc"
+end
+
+rcfile = File.expand_path("~/.restmanrc")
+if File.exist?(rcfile)
+  load(rcfile)
+end
+
+ARGV.clear
+
+IRB.start
+exit!

data/lib/rest-man.rb

@@ -0,0 +1,2 @@
+# More logical way to require 'rest-man'
+require File.dirname(__FILE__) + '/restman'

data/lib/rest_man.rb

@@ -0,0 +1,2 @@
+# This file exists for backward compatbility with require 'rest_man'
+require File.dirname(__FILE__) + '/restman'

data/lib/restman/abstract_response.rb

@@ -0,0 +1,252 @@
+require 'cgi'
+require 'http-cookie'
+
+module RestMan
+
+  module AbstractResponse
+
+    attr_reader :net_http_res, :request, :start_time, :end_time, :duration
+
+    def inspect
+      raise NotImplementedError.new('must override in subclass')
+    end
+
+    # Logger from the request, potentially nil.
+    def log
+      request.log
+    end
+
+    def log_response
+      return unless log
+
+      code = net_http_res.code
+      res_name = net_http_res.class.to_s.gsub(/\ANet::HTTP/, '')
+      content_type = (net_http_res['Content-type'] || '').gsub(/;.*\z/, '')
+
+      log << "# => #{code} #{res_name} | #{content_type} #{size} bytes, #{sprintf('%.2f', duration)}s\n"
+    end
+
+    # HTTP status code
+    def code
+      @code ||= @net_http_res.code.to_i
+    end
+
+    def history
+      @history ||= request.redirection_history || []
+    end
+
+    # A hash of the headers, beautified with symbols and underscores.
+    # e.g. "Content-type" will become :content_type.
+    def headers
+      @headers ||= AbstractResponse.beautify_headers(@net_http_res.to_hash)
+    end
+
+    # The raw headers.
+    def raw_headers
+      @raw_headers ||= @net_http_res.to_hash
+    end
+
+    # @param [Net::HTTPResponse] net_http_res
+    # @param [RestMan::Request] request
+    # @param [Time] start_time
+    def response_set_vars(net_http_res, request, start_time)
+      @net_http_res = net_http_res
+      @request = request
+      @start_time = start_time
+      @end_time = Time.now
+
+      if @start_time
+        @duration = @end_time - @start_time
+      else
+        @duration = nil
+      end
+
+      # prime redirection history
+      history
+    end
+
+    # Hash of cookies extracted from response headers.
+    #
+    # NB: This will return only cookies whose domain matches this request, and
+    # may not even return all of those cookies if there are duplicate names.
+    # Use the full cookie_jar for more nuanced access.
+    #
+    # @see #cookie_jar
+    #
+    # @return [Hash]
+    #
+    def cookies
+      hash = {}
+
+      cookie_jar.cookies(@request.uri).each do |cookie|
+        hash[cookie.name] = cookie.value
+      end
+
+      hash
+    end
+
+    # Cookie jar extracted from response headers.
+    #
+    # @return [HTTP::CookieJar]
+    #
+    def cookie_jar
+      return @cookie_jar if defined?(@cookie_jar) && @cookie_jar
+
+      jar = @request.cookie_jar.dup
+      headers.fetch(:set_cookie, []).each do |cookie|
+        jar.parse(cookie, @request.uri)
+      end
+
+      @cookie_jar = jar
+    end
+
+    # Return the default behavior corresponding to the response code:
+    #
+    # For 20x status codes: return the response itself
+    #
+    # For 30x status codes:
+    #   301, 302, 307: redirect GET / HEAD if there is a Location header
+    #   303: redirect, changing method to GET, if there is a Location header
+    #
+    # For all other responses, raise a response exception
+    #
+    def return!(&block)
+      case code
+      when 200..207
+        self
+      when 301, 302, 307
+        case request.method
+        when 'get', 'head'
+          check_max_redirects
+          follow_redirection(&block)
+        else
+          raise exception_with_response
+        end
+      when 303
+        check_max_redirects
+        follow_get_redirection(&block)
+      else
+        raise exception_with_response
+      end
+    end
+
+    def to_i
+      warn('warning: calling Response#to_i is not recommended')
+      super
+    end
+
+    def description
+      "#{code} #{STATUSES[code]} | #{(headers[:content_type] || '').gsub(/;.*$/, '')} #{size} bytes\n"
+    end
+
+    # Follow a redirection response by making a new HTTP request to the
+    # redirection target.
+    def follow_redirection(&block)
+      _follow_redirection(request.args.dup, &block)
+    end
+
+    # Follow a redirection response, but change the HTTP method to GET and drop
+    # the payload from the original request.
+    def follow_get_redirection(&block)
+      new_args = request.args.dup
+      new_args[:method] = :get
+      new_args.delete(:payload)
+
+      _follow_redirection(new_args, &block)
+    end
+
+    # Convert headers hash into canonical form.
+    #
+    # Header names will be converted to lowercase symbols with underscores
+    # instead of hyphens.
+    #
+    # Headers specified multiple times will be joined by comma and space,
+    # except for Set-Cookie, which will always be an array.
+    #
+    # Per RFC 2616, if a server sends multiple headers with the same key, they
+    # MUST be able to be joined into a single header by a comma. However,
+    # Set-Cookie (RFC 6265) cannot because commas are valid within cookie
+    # definitions. The newer RFC 7230 notes (3.2.2) that Set-Cookie should be
+    # handled as a special case.
+    #
+    # http://tools.ietf.org/html/rfc2616#section-4.2
+    # http://tools.ietf.org/html/rfc7230#section-3.2.2
+    # http://tools.ietf.org/html/rfc6265
+    #
+    # @param headers [Hash]
+    # @return [Hash]
+    #
+    def self.beautify_headers(headers)
+      headers.inject({}) do |out, (key, value)|
+        key_sym = key.tr('-', '_').downcase.to_sym
+
+        # Handle Set-Cookie specially since it cannot be joined by comma.
+        if key.downcase == 'set-cookie'
+          out[key_sym] = value
+        else
+          out[key_sym] = value.join(', ')
+        end
+
+        out
+      end
+    end
+
+    private
+
+    # Follow a redirection
+    #
+    # @param new_args [Hash] Start with this hash of arguments for the
+    #   redirection request. The hash will be mutated, so be sure to dup any
+    #   existing hash that should not be modified.
+    #
+    def _follow_redirection(new_args, &block)
+
+      # parse location header and merge into existing URL
+      url = headers[:location]
+
+      # cannot follow redirection if there is no location header
+      unless url
+        raise exception_with_response
+      end
+
+      # handle relative redirects
+      unless url.start_with?('http')
+        url = URI.parse(request.url).merge(url).to_s
+      end
+      new_args[:url] = url
+
+      new_args[:password] = request.password
+      new_args[:user] = request.user
+      new_args[:headers] = request.headers
+      new_args[:max_redirects] = request.max_redirects - 1
+
+      # pass through our new cookie jar
+      new_args[:cookies] = cookie_jar
+
+      # prepare new request
+      new_req = Request.new(new_args)
+
+      # append self to redirection history
+      new_req.redirection_history = history + [self]
+
+      # execute redirected request
+      new_req.execute(&block)
+    end
+
+    def check_max_redirects
+      if request.max_redirects <= 0
+        raise exception_with_response
+      end
+    end
+
+    def exception_with_response
+      begin
+        klass = Exceptions::EXCEPTIONS_MAP.fetch(code)
+      rescue KeyError
+        raise RequestFailed.new(self, code)
+      end
+
+      raise klass.new(self, code)
+    end
+  end
+end