rack_curler 0.0.1

checksums.yaml

@@ -0,0 +1,15 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    ZGNkNTdlM2QzMGRiZjY1NTM1ODkyZTI0YTQ4ZTEwYjJkZGM0MmYyNw==
+  data.tar.gz: !binary |-
+    MDg5YTc2ZTU0ZDczYjU3ZmQyNDA5MjRlNzg1MDgzMGJkM2FjMDUzOQ==
+SHA512:
+  metadata.gz: !binary |-
+    MDkwN2E2NjBlYjgzNDkyZWRiZjhkOTk4NGZjYTRlOGRlNWEwNjIzMmVlMWIw
+    N2QzMmM2MDkwZGU5MjY2MWJmMGYxZDY0Zjk0YWU0NjMzOTE0YmM0OGM1Mjc0
+    OWFhNDIwMGY4ODZjNjhmMzlkN2M5MmZiMzNhNWNmZTViMmEwZWE=
+  data.tar.gz: !binary |-
+    YzViOTZiYmRmNmM5OTQ2MzU1YjFkY2E1OTIyMDNlYmIyMDU1MDU5MDRiZjVj
+    OWNiNTIxMDMxOGM1NmYxZTZjNmNmZGZmMDRhOGRjZTc2N2NjMDJlZWFmNjA0
+    YTQ2NGIzZmJmZGJjMjZiODc3YTZlOTQyYjFkNzk0MDI4Njk3M2Y=

data/.gitignore

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

data/.ruby-gemset

@@ -0,0 +1 @@
+rack_curler

data/.ruby-version

@@ -0,0 +1 @@
+ruby-1.9.3-p448

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Nathan Speed
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,42 @@
+# RackCurler
+
+Given a Rack env, generate a nicely formatted curl command that approximates the request. Suitable for debugging.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'rack_curler'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install rack_curler
+
+## Usage
+
+Where ```env``` is a Rack env:
+
+    RackCurler.to_curl(env)
+
+Will output something like (depending on the request):
+
+    curl 'https://foo.example.com/hello/times' \
+       -X PUT
+       -H 'X-Forwarded-For: 127.0.0.1' \
+       -H 'X-Forwarded-Proto: https' \
+       -H 'Authorization: Basic laiusdfhalnsidufhxalnsuhflsadufhxadlsunxdsauhnlaudflnsuhadsf==' \
+       -H 'Accept: application/json' \
+       -H 'Cookie: crazy_cookie=alskdjfhasldkjfhxalsdufhxwoeufhxa; normal_cookie=asdfsadhfjlkdsajflksadjfh;'
+       --data 'super awesome request body'
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/lib/rack_curler/version.rb

@@ -0,0 +1,3 @@
+module RackCurler
+  VERSION = "0.0.1"
+end

data/lib/rack_curler.rb

@@ -0,0 +1,44 @@
+require "rack_curler/version"
+
+module RackCurler
+  def self.to_curl(env)
+
+    headers_to_drop = [
+      'Version',         # make your life easy and let curl set this
+      'Content-Length',  # curl will set this for you
+      'Host',            # curl will set this for you
+      'Connection',      # curl will set this for you
+      'Accept-Encoding', # for debugging, you don't want an encoded-response
+      'Date'             # it would be incorrect to repeat
+    ]
+
+    header_defaults = {
+      'Accept' => '*/*',
+      'Content-Type' => 'application/x-www-form-urlencoded'
+    }
+    
+    env['rack.input'].rewind
+    body = env['rack.input'].read
+    env['rack.input'].rewind
+
+    headerize = lambda { |raw| raw.split(/[ _\-]/).map(&:capitalize).join('-') }
+
+    headers = {}.tap do |h|
+      env.select { |k, v| k =~ /^HTTP_/ || k == 'CONTENT_TYPE' }
+        .each { |k, v| h[headerize.call(k.sub(/^HTTP_/, ''))] = v}
+      h.select! { |k, v| !headers_to_drop.member?(k) }
+      h.select! { |k, v| header_defaults[k].nil? || header_defaults[k] != v }
+    end
+    
+    url = Rack::Request.new(env).url
+    
+    curl_command = "curl '#{url}'"
+    curl_command << " \\\n   -X #{env['REQUEST_METHOD']}" unless ['GET', 'POST'].member?(env['REQUEST_METHOD'])
+    headers.each_pair do |header, value|
+      curl_command << " \\\n   -H '#{header}: #{value}'"
+    end
+    curl_command << " \\\n   --data '#{body}'" if body && !body.empty?
+
+    curl_command
+  end
+end

data/rack_curler.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'rack_curler/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "rack_curler"
+  spec.version       = RackCurler::VERSION
+  spec.authors       = ["Nathan Speed"]
+  spec.email         = ["speedarius@gmail.com"]
+  spec.description   = %q{Generate curl commands that approximate rack requests.}
+  spec.summary       = %q{Given a rack env, generate a prettified curl command that approximates the request, including headers and request body. Suitable for debugging.}
+  spec.homepage      = "https://github.com/speedarius/rack_curler"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "rack"
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec", "~> 2.6"
+end

data/spec/rack_curler_spec.rb

@@ -0,0 +1,161 @@
+require 'rack_curler'
+require 'rack/mock'
+
+describe RackCurler do
+  it "has a version" do
+    RackCurler::VERSION.should_not be_nil
+  end
+
+  describe "to_curl" do
+    before(:each) do
+      @get_env = lambda do |options={}|
+        env = Rack::MockRequest.env_for('http://foo.example.com', options)
+        env['HTTP_VERSION'] = '1.2.3.4'
+        env['HTTP_HOST'] = 'foo.example.com'
+        env['HTTP_CONNECTION'] = 'close'
+        env['HTTP_ACCEPT_ENCODING'] = 'deflate, gzip'
+        env['HTTP_DATE'] = '2013-11-06 16:52:05 -0800'
+        env['HTTP_ACCEPT'] = '*/*'
+        env['HTTP_SOME_OTHER_HEADER'] = 'header value 123'
+        env
+      end
+    end
+
+    shared_examples_for "a request for http://foo.example.com" do
+      it "is a curl command" do
+        @output.should match /^curl /
+      end
+
+      it "has a url argument of http://foo.example.com" do
+        @output.should match /^curl 'http:\/\/foo\.example\.com\/?'/
+      end
+
+      it "does not specify a Version header (curl should choose this)" do
+        @output.should_not match /-H 'Version:/
+      end
+
+      it "does not specify a Host header (curl does this for you)" do
+        @output.should_not match /-H 'Host:/
+      end
+
+      it "does not specify a Connection header (curl does this for you)" do
+        @output.should_not match /-H 'Connection:/
+      end
+
+      it "does not specify an Accept-Encoding header (for debugging, you don't want an encoded response)" do
+        @output.should_not match /-H 'Accept-Encoding:/
+      end
+
+      it "does not specify a Date header (curl will do this for you)" do
+        @output.should_not match /-H 'Date:/
+      end
+
+      it "does not have a redundant Accept header (curl will use */* by default)" do
+        @output.should_not match /-H 'Accept:/
+      end
+
+      it "does include any other header" do
+        @output.should match /-H 'Some-Other-Header: header value 123'/
+      end
+
+      describe 'with non-default Accept' do
+        before(:each) do
+          @env['HTTP_ACCEPT'] = 'something specific'
+          @output = RackCurler.to_curl(@env)
+        end
+
+        it "does include the Accept header" do
+          @output.should match /-H 'Accept: something specific'/
+        end
+      end
+    end
+
+    shared_examples_for "a request for http://foo.example.com without a body" do
+      it "does not have a --data argument" do
+        @output.should_not match /--data/
+      end
+    end
+
+    shared_examples_for "a request for http://foo.example.com with a body" do
+      it "does not specify a Content-Length header (curl will set this for you)" do
+        @output.should_not match /-H 'Content-Length:/
+      end
+
+      it "does not specify a redundant Content-Type header (curl will assume application/x-www-form-urlencoded)" do
+        @output.should_not match /-H 'Content-Type:/
+      end
+
+      it "includes the body in a --data argument" do
+        @output.should match /--data 'some body'/
+      end
+
+      describe 'with non-default Content-Type' do
+        before(:each) do
+          @env['CONTENT_TYPE'] = 'hello'
+          @output = RackCurler.to_curl(@env)
+        end
+
+        it "does specify a Content-Type header" do
+          @output.should match /-H 'Content-Type: hello'/
+        end
+      end
+    end
+
+    describe 'for a GET to http://foo.example.com' do
+      before(:each) do
+        @env = @get_env.call :method => 'GET'
+        @output = RackCurler.to_curl(@env)
+      end
+
+      it_behaves_like "a request for http://foo.example.com"
+      it_behaves_like "a request for http://foo.example.com without a body"
+
+      it "does not have a -X argument (curl will assume it is a GET)" do
+        @output.should_not match /-X GET/
+      end
+    end
+
+    describe 'for a DELETE to http://foo.example.com' do
+      before(:each) do
+        @env = @get_env.call :method => 'DELETE'
+        @output = RackCurler.to_curl(@env)
+      end
+
+      it_behaves_like "a request for http://foo.example.com"
+      it_behaves_like "a request for http://foo.example.com without a body"
+
+      it "specifies -X DELETE" do
+        @output.should match /-X DELETE/
+      end
+    end
+
+    describe 'for a PUT to http://foo.example.com' do
+      before(:each) do
+        @env = @get_env.call :method => 'PUT', :input => 'some body'
+        @output = RackCurler.to_curl(@env)
+      end
+
+      it_behaves_like "a request for http://foo.example.com"
+      it_behaves_like "a request for http://foo.example.com with a body"
+
+      it "specifies -X PUT" do
+        @output.should match /-X PUT/
+      end
+    end
+
+    describe 'for a POST to http://foo.example.com' do
+      before(:each) do
+        @env = @get_env.call :method => 'POST', :input => 'some body'
+        @output = RackCurler.to_curl(@env)
+      end
+
+      it_behaves_like "a request for http://foo.example.com"
+      it_behaves_like "a request for http://foo.example.com with a body"
+
+      it "does not specify -X POST (curl will assume it is a POST)" do
+        @output.should_not match /-X POST/
+      end
+    end
+  end
+end
+

metadata

@@ -0,0 +1,113 @@
+--- !ruby/object:Gem::Specification
+name: rack_curler
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Nathan Speed
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-11-07 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rack
+  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: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.6'
+description: Generate curl commands that approximate rack requests.
+email:
+- speedarius@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .ruby-gemset
+- .ruby-version
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/rack_curler.rb
+- lib/rack_curler/version.rb
+- rack_curler.gemspec
+- spec/rack_curler_spec.rb
+homepage: https://github.com/speedarius/rack_curler
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.1.10
+signing_key: 
+specification_version: 4
+summary: Given a rack env, generate a prettified curl command that approximates the
+  request, including headers and request body. Suitable for debugging.
+test_files:
+- spec/rack_curler_spec.rb