api_hammer 0.0.3 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b422b307a5753a8315b2bce549a2a18966c78ede
-  data.tar.gz: 9f23c48f532e57c59105da808f373879037640ff
+  metadata.gz: 30f42f8b22545e005c29603af5d98d6874e8027b
+  data.tar.gz: 7257d0076928ecc3c328596243c3b16d465dba6b
 SHA512:
-  metadata.gz: 6edf87fe1bcac33ef5d2e74af2e93e366804d964a4f3ca0c6e581ab2e576b4698940eef276366e1aa728262fcdc7bd4ce00c406343f5d77597f7ebcd5957132d
-  data.tar.gz: 4bfd01db70492fc17227e38bfac2f5dc622e6b4ebec1e228573a8ca23fd354e0f2f1fa7b95a52c764f46174d208ced4fb4ad99c963e11639553991580ac4741b
+  metadata.gz: a3ea4254d06322b584a4b78ec25d3334280c5118406913500cfaf8d2fbc84a9c5478fd6c0d2bfdb15ead42f795b58a9abc61bfa7daff88696195df93cd21f2d3
+  data.tar.gz: a275cccb8fba41c50c2781bc2423477bec6a688b0d831145ee044889193ab9d70105bf17a138d88cf3380ee4fbbd2216ad1ea42265609bef407729e90680468d

data/CHANGELOG.md

@@ -1,3 +1,8 @@
+# 0.1.0
+- Object#public_instance_exec
+- Obect#public_instance_eval
+- hc
+
 # 0.0.3
 - rake cucumber:pretty_json
 - Rails#find_or_halt

data/bin/hc

@@ -0,0 +1,220 @@
+#!/usr/bin/env ruby
+
+require 'rubygems'
+require 'faraday'
+require 'logger'
+require 'yaml'
+
+# OPTION PARSER 
+
+require 'optparse'
+
+# $options default values
+$options = {
+  :verbose => true,
+  :color => nil,
+  :no_ssl_verify => false,
+  :headers => {},
+}
+
+$oauth = {}
+
+opt_parser = OptionParser.new do |opts|
+  opts.banner = "Usage: #{$0} [options] <verb> <url> [body]"
+
+  opts.on("-v", "--[no-]verbose", "Run verbosely - output is like curl -v (this is the default)") do |v|
+    $options[:verbose] = v
+  end
+  opts.on("-q", "Run quietly - only outputs the response body (same as --no-verbose)") do |v|
+    $options[:verbose] = !v
+  end
+  opts.on("--[no-]color", "Color the output (defaults to color if the output device is a TTY)") do |v|
+    $options[:color] = v
+  end
+  opts.on("-t", "--content-type CONTENT-TYPE", "Sets the Content-Type header of the request") do |v|
+    $options[:headers]['Content-Type'.downcase] = v
+  end
+  opts.on("--oauth-token TOKEN") do |token|
+    $oauth[:token] = token
+  end
+  opts.on("--oauth-token-secret TOKEN_SECRET") do |token_secret|
+    $oauth[:token_secret] = token_secret
+  end
+  opts.on("--oauth-consumer-key CONSUMER_KEY") do |consumer_key|
+    $oauth[:consumer_key] = consumer_key
+  end
+  opts.on("--oauth-consumer-secret CONSUMER_SECRET") do |consumer_secret|
+    $oauth[:consumer_secret] = consumer_secret
+  end
+  opts.on("--oauth-signature-method SIGNATURE_METHOD") do |signature_method|
+    $oauth[:signature_method] = signature_method
+  end
+
+  opts.on("--no-ssl-verify", "Disables SSL verification - use cautiously!") do
+    $options[:no_ssl_verify] = true
+  end
+  opts.on("-H", "--header HEADER", "Set a header") do |header|
+    if header =~ /\A([^:]+):\s*(.*)\z/m # this could be more strictly conformant to rfc, but whatever
+      field_name = $1
+      field_value = $2
+      $options[:headers][field_name.downcase] = field_value
+    else
+      abort "bad header value given: #{header}"
+    end
+  end
+end
+opt_parser.parse!
+abort(opt_parser.help) unless (2..3).include?(ARGV.size)
+
+# OUTPUTTERS FOR FARADAY THAT SHOULD MOVE TO A LIB SOMEWHERE 
+
+# outputs the response body to the given output device (defaulting to STDOUT) 
+class FaradayOutputter < Faraday::Middleware
+  def initialize(app, outdev=STDOUT)
+    @app=app
+    @outdev = outdev
+  end
+
+  def call(request_env)
+    @app.call(request_env).on_complete do |response_env|
+      @outdev.puts(response_env[:body] || '')
+    end
+  end
+end
+
+# this is to approximate `curl -v`s output. but it's all faked, whereas curl gives you 
+# the real text written and read for request and response. whatever, close enough. 
+class FaradayCurlVOutputter < FaradayOutputter
+
+  # defines a method with the given name, applying coloring defined by any additional arguments. 
+  # if $options[:color] is set, respects that; otherwise, applies color if the output device is a tty. 
+  def self.color(name, *color_args)
+    define_method(name) do |arg|
+      if color?
+        require 'term/ansicolor'
+        color_args.inject(arg) do |result, color_arg|
+          Term::ANSIColor.send(color_arg, result)
+        end
+      else
+        arg
+      end
+    end
+  end
+
+  color :info, :intense_yellow
+  color :info_body, :yellow
+  color :protocol
+
+  color :request, :intense_cyan
+  color :request_verb, :bold
+  color :request_header
+  color :request_blankline, :intense_cyan, :bold
+
+  color :response, :intense_green
+  color :response_status, :bold, :green
+  color :response_header
+  color :response_blankline, :intense_green, :bold
+
+  def call(request_env)
+    @outdev.puts "#{info('*')} #{info_body("connect to #{request_env[:url].host} on port #{request_env[:url].port}")}"
+    @outdev.puts "#{info('*')} #{info_body("getting our SSL on")}" if request_env[:url].scheme=='https'
+    @outdev.puts "#{request('>')} #{request_verb(request_env[:method].to_s.upcase)} #{request_env[:url].request_uri} #{protocol('HTTP/1.1' || 'or something - TODO')}"
+    request_env[:request_headers].each do |k, v|
+      @outdev.puts "#{request('>')} #{request_header(k)}#{request(':')} #{v}"
+    end
+    @outdev.puts "#{request_blankline('>')} "
+    request_body = color_body_by_content_type(request_env[:body], request_env[:request_headers]['Content-Type'])
+    (request_body || '').split("\n", -1).each do |line|
+      @outdev.puts "#{request('>')} #{line}"
+    end
+    @app.call(request_env).on_complete do |response_env|
+      @outdev.puts "#{response('<')} #{protocol('HTTP/1.1' || 'or something - TODO')} #{response_status(response_env[:status].to_s)}"
+      request_env[:response_headers].each do |k, v|
+        @outdev.puts "#{response('<')} #{response_header(k)}#{response(':')} #{v}"
+      end
+      @outdev.puts "#{response_blankline  ('<')} "
+      response_body = color_body_by_content_type(response_env[:body], response_env[:response_headers]['Content-Type'])
+      (response_body || '').split("\n", -1).each do |line|
+        @outdev.puts "#{response('<')} #{line}"
+      end
+    end
+  end
+
+  # whether to use color
+  def color?
+    $options[:color].nil? ? @outdev.tty? : $options[:color]
+  end
+
+  # a mapping for each registered CodeRay scanner to the Media Types which represent 
+  # that language. extremely incomplete! 
+  CodeRayForMediaTypes = {
+    :c => [],
+    :cpp => [],
+    :clojure => [],
+    :css => ['text/css', 'application/css-stylesheet'],
+    :delphi => [],
+    :diff => [],
+    :erb => [],
+    :groovy => [],
+    :haml => [],
+    :html => ['text/html'],
+    :java => [],
+    :java_script => ['application/javascript', 'text/javascript', 'application/x-javascript'],
+    :json => ['application/json'],
+    :php => [],
+    :python => ['text/x-python'],
+    :ruby => [],
+    :sql => [],
+    :xml => ['text/xml', 'application/xml', %r(\Aapplication/.*\+xml\z)],
+    :yaml => [],
+  }
+
+  # takes a body and a content type; returns the body, with coloring (ansi colors for terminals)
+  # possibly added, if it's a recognized content type and #color? is true 
+  def color_body_by_content_type(body, content_type)
+    if body && color?
+      # kinda hacky way to get the media_type. faraday should supply this ...
+      require 'rack'
+      media_type = ::Rack::Request.new({'CONTENT_TYPE' => content_type}).media_type
+      coderay_scanner = CodeRayForMediaTypes.reject{|k,v| !v.any?{|type| type === media_type} }.keys.first
+      if coderay_scanner
+        require 'coderay'
+        body = CodeRay.scan(body, coderay_scanner).encode(:terminal)
+      end
+    end
+    body
+  end
+end
+
+# CONFIGURE THE FARADAY CONNECTION 
+faraday_options = {}
+if $options[:no_ssl_verify]
+  faraday_options[:ssl] = {:verify => false}
+end
+connection = Faraday.new(faraday_options) do |builder|
+  if $oauth.any?
+    $oauth[:signature_method] ||= 'HMAC-SHA1'
+    require 'oauthenticator'
+    OAuthenticator::FaradaySigner
+    builder.use OAuthenticator::FaradaySigner, $oauth
+  end
+  builder.use $options[:verbose] ? FaradayCurlVOutputter : FaradayOutputter
+  builder.adapter Faraday.default_adapter
+end
+
+httpmethod, url, body = *ARGV
+
+unless Faraday::Connection::METHODS.map{|m| m.to_s.downcase }.include?(httpmethod.downcase)
+  abort "Unrecognized HTTP method given: #{httpmethod}\n\n" + opt_parser.help
+end
+
+headers = $options[:headers]
+if body && !headers['Content-Type'.downcase]
+  # I'd rather not have a default content-type, but if none is set then the HTTP adapter sets this to 
+  # application/x-www-form-urlencoded anyway. application/json is a better default for our purposes. 
+  headers['Content-Type'.downcase] = 'application/json'
+end
+
+# OH LOOK IT'S FINALLY ACTUALLY CONNECTING TO SOMETHING
+
+response = connection.run_request(httpmethod.downcase.to_sym, url, body, headers)

data/lib/api_hammer/public_instance_exec.rb

@@ -0,0 +1,31 @@
+class PublicForwarder < BasicObject
+  def initialize(object)
+    @object=object
+  end
+
+  # forwards public methods to the object. attempting to invoke private or 
+  # protected methods raises, as it would if the object was a normal receiver.
+  def method_missing(method, *args, &block)
+    if @object.protected_methods.any?{|pm| pm.to_s == method.to_s }
+      ::Kernel.raise ::NoMethodError, "protected method `#{method}' called for #{@object.inspect}"
+    elsif @object.private_methods.any?{|pm| pm.to_s == method.to_s }
+      ::Kernel.raise ::NoMethodError, "private method `#{method}' called for #{@object.inspect}"
+    else
+      @object.__send__(method, *args, &block)
+    end
+  end
+end
+
+class Object
+  # like instance_exec, but only gives access to public methods. no private or protected methods, no 
+  # instance variables. 
+  def public_instance_exec(*args, &block)
+    PublicForwarder.new(self).instance_exec(*args, &block)
+  end
+
+  # like instance_eval, but only gives access to public methods. no private or protected methods, no 
+  # instance variables. 
+  def public_instance_eval(&block)
+    PublicForwarder.new(self).instance_eval(&block)
+  end
+end

data/lib/api_hammer/version.rb

@@ -1,3 +1,3 @@
 module ApiHammer
-  VERSION = "0.0.3"
+  VERSION = "0.1.0"
 end

data/test/public_instance_exec_test.rb

@@ -0,0 +1,43 @@
+proc { |p| $:.unshift(p) unless $:.any? { |lp| File.expand_path(lp) == p } }.call(File.expand_path('.', File.dirname(__FILE__)))
+require 'helper'
+
+require 'api_hammer/public_instance_exec'
+
+class Foo
+  def public_method(arg = :public)
+    arg
+  end
+  protected
+  def protected_method(arg = :protected)
+    arg
+  end
+  private
+  def private_method(arg = :private)
+    arg
+  end
+end
+
+describe '#public_instance_exec' do
+  it 'does things' do
+    foo = Foo.new
+    assert_equal(:public_exec, foo.public_instance_exec(:public_exec) { |arg| public_method(arg) })
+    regularex = (foo.protected_method rescue $!)
+    ex = assert_raises(regularex.class) { foo.public_instance_exec(:protected_exec) { |arg| protected_method(arg) } }
+    assert_equal(regularex.message, ex.message)
+    regularex = (foo.private_method rescue $!)
+    ex = assert_raises(regularex.class) { foo.public_instance_exec(:private_exec) { |arg| private_method(arg) } }
+    assert_equal(regularex.message, ex.message)
+  end
+end
+describe '#public_instance_eval' do
+  it 'does things' do
+    foo = Foo.new
+    assert_equal(:public, foo.public_instance_eval { public_method })
+    regularex = (foo.protected_method rescue $!)
+    ex = assert_raises(regularex.class) { foo.public_instance_eval { protected_method } }
+    assert_equal(regularex.message, ex.message)
+    regularex = (foo.private_method rescue $!)
+    ex = assert_raises(regularex.class) { foo.public_instance_eval { private_method } }
+    assert_equal(regularex.message, ex.message)
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: api_hammer
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.1.0
 platform: ruby
 authors:
 - Ethan
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-05-02 00:00:00.000000000 Z
+date: 2014-05-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rack
@@ -66,6 +66,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: coderay
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -140,7 +154,8 @@ description: actually a set of small API-related tools. very much unlike a hamme
   at all, which is one large tool.
 email:
 - ethan@unth
-executables: []
+executables:
+- hc
 extensions: []
 extra_rdoc_files: []
 files:
@@ -150,9 +165,11 @@ files:
 - LICENSE.txt
 - README.md
 - Rakefile.rb
+- bin/hc
 - lib/api_hammer.rb
 - lib/api_hammer/check_required_params.rb
 - lib/api_hammer/halt.rb
+- lib/api_hammer/public_instance_exec.rb
 - lib/api_hammer/rails.rb
 - lib/api_hammer/request_logger.rb
 - lib/api_hammer/show_text_exceptions.rb
@@ -165,6 +182,7 @@ files:
 - test/check_required_params_test.rb
 - test/halt_test.rb
 - test/helper.rb
+- test/public_instance_exec_test.rb
 - test/request_logger_test.rb
 - test/show_text_exceptions_test.rb
 - test/trailing_newline_test.rb
@@ -197,6 +215,7 @@ test_files:
 - test/check_required_params_test.rb
 - test/halt_test.rb
 - test/helper.rb
+- test/public_instance_exec_test.rb
 - test/request_logger_test.rb
 - test/show_text_exceptions_test.rb
 - test/trailing_newline_test.rb