avdi-faraday 0.8.1

data/Gemfile

@@ -0,0 +1,27 @@
+source 'https://rubygems.org'
+
+group :development do
+  gem 'sinatra', '~> 1.2'
+end
+
+group :test do
+  gem 'em-http-request', '~> 1.0', :require => 'em-http'
+  gem 'em-synchrony', '~> 1.0', :require => ['em-synchrony', 'em-synchrony/em-http'], :platforms => :ruby_19
+  gem 'excon', '~> 0.14'
+  gem 'httpclient', '~> 2.2'
+  gem 'net-http-persistent', '~> 2.5', :require => false
+  gem 'leftright', '~> 0.9', :require => false
+  gem 'rack-test', '~> 0.6', :require => 'rack/test'
+end
+
+platforms :ruby do
+  gem 'patron', '~> 0.4', '> 0.4.1'
+  gem 'typhoeus', '~> 0.3.3'
+end
+
+platforms :jruby do
+  gem 'jruby-openssl', '~> 0.7'
+  gem 'ffi-ncurses', '~> 0.3'
+end
+
+gemspec

data/LICENSE.md

@@ -0,0 +1,20 @@
+Copyright (c) 2009 rick olson, zack hobson
+
+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,250 @@
+# Faraday
+
+Faraday is an HTTP client lib that provides a common interface over many
+adapters (such as Net::HTTP) and embraces the concept of Rack middleware when
+processing the request/response cycle.
+
+Faraday supports these adapters:
+
+* Net::HTTP
+* [Excon][]
+* [Typhoeus][]
+* [Patron][]
+* [EventMachine][]
+
+It also includes a Rack adapter for hitting loaded Rack applications through
+Rack::Test, and a Test adapter for stubbing requests by hand.
+
+## Usage
+
+```ruby
+conn = Faraday.new(:url => 'http://sushi.com') do |faraday|
+  faraday.request  :url_encoded             # form-encode POST params
+  faraday.response :logger                  # log requests to STDOUT
+  faraday.adapter  Faraday.default_adapter  # make requests with Net::HTTP
+end
+
+## GET ##
+
+response = conn.get '/nigiri/sake.json'     # GET http://sushi.com/nigiri/sake.json
+response.body
+
+conn.get '/nigiri', { :name => 'Maguro' }   # GET /nigiri?name=Maguro
+
+conn.get do |req|                           # GET http://sushi.com/search?page=2&limit=100
+  req.url '/search', :page => 2
+  req.params['limit'] = 100
+end
+
+## POST ##
+
+conn.post '/nigiri', { :name => 'Maguro' }  # POST "name=maguro" to http://sushi.com/nigiri
+
+# post payload as JSON instead of "www-form-urlencoded" encoding:
+conn.post do |req|
+  req.url '/nigiri'
+  req.headers['Content-Type'] = 'application/json'
+  req.body = '{ "name": "Unagi" }'
+end
+
+## Per-request options ##
+
+conn.get do |req|
+  req.url '/search'
+  req.options[:timeout] = 5           # open/read timeout in seconds
+  req.options[:open_timeout] = 2      # connection open timeout in seconds
+end
+```
+
+If you don't need to set up anything, you can roll with just the bare minimum:
+
+```ruby
+# using the default stack:
+response = Faraday.get 'http://sushi.com/nigiri/sake.json'
+```
+
+## Advanced middleware usage
+
+The order in which middleware is stacked is important. Like with Rack, the
+first middleware on the list wraps all others, while the last middleware is the
+innermost one, so that must be the adapter.
+
+```ruby
+Faraday.new(...) do |conn|
+  # POST/PUT params encoders:
+  conn.request :multipart
+  conn.request :url_encoded
+
+  conn.adapter :net_http
+end
+```
+
+This request middleware setup affects POST/PUT requests in the following way:
+
+1. `Request::Multipart` checks for files in the payload, otherwise leaves
+  everything untouched;
+2. `Request::UrlEncoded` encodes as "application/x-www-form-urlencoded" if not
+  already encoded or of another type
+
+Swapping middleware means giving the other priority. Specifying the
+"Content-Type" for the request is explicitly stating which middleware should
+process it.
+
+Examples:
+
+```ruby
+# uploading a file:
+payload[:profile_pic] = Faraday::UploadIO.new('/path/to/avatar.jpg', 'image/jpeg')
+
+# "Multipart" middleware detects files and encodes with "multipart/form-data":
+conn.put '/profile', payload
+```
+
+## Writing middleware
+
+Middleware are classes that implement a `call` instance method. They hook into
+the request/response cycle.
+
+```ruby
+def call(env)
+  # do something with the request
+
+  @app.call(env).on_complete do
+    # do something with the response
+  end
+end
+```
+
+It's important to do all processing of the response only in the `on_complete`
+block. This enables middleware to work in parallel mode where requests are
+asynchronous.
+
+The `env` is a hash with symbol keys that contains info about the request and,
+later, response. Some keys are:
+
+```
+# request phase
+:method - :get, :post, ...
+:url    - URI for the current request; also contains GET parameters
+:body   - POST parameters for :post/:put requests
+:request_headers
+
+# response phase
+:status - HTTP response status code, such as 200
+:body   - the response body
+:response_headers
+```
+
+## Using Faraday for testing
+
+```ruby
+# It's possible to define stubbed request outside a test adapter block.
+stubs = Faraday::Adapter::Test::Stubs.new do |stub|
+  stub.get('/tamago') { [200, {}, 'egg'] }
+end
+
+# You can pass stubbed request to the test adapter or define them in a block
+# or a combination of the two.
+test = Faraday.new do |builder|
+  builder.adapter :test, stubs do |stub|
+    stub.get('/ebi') {[ 200, {}, 'shrimp' ]}
+  end
+end
+
+# It's also possible to stub additional requests after the connection has
+# been initialized. This is useful for testing.
+stubs.get('/uni') {[ 200, {}, 'urchin' ]}
+
+resp = test.get '/tamago'
+resp.body # => 'egg'
+resp = test.get '/ebi'
+resp.body # => 'shrimp'
+resp = test.get '/uni'
+resp.body # => 'urchin'
+resp = test.get '/else' #=> raises "no such stub" error
+
+# If you like, you can treat your stubs as mocks by verifying that all of
+# the stubbed calls were made. NOTE that this feature is still fairly
+# experimental: It will not verify the order or count of any stub, only that
+# it was called once during the course of the test.
+stubs.verify_stubbed_calls
+```
+
+## TODO
+
+* support streaming requests/responses
+* better stubbing API
+
+## Contributing
+
+You can run the test suite against a live server by running `script/test`. It
+automatically starts a test server in background. Only tests in
+`test/adapters/*_test.rb` require a server, though.
+
+``` sh
+# run the whole suite
+$ script/server
+
+# run only specific files
+$ script/server excon typhoeus
+```
+
+We will accept middleware that:
+
+1. is useful to a broader audience, but can be implemented relatively
+   simple; and
+2. which isn't already present in [faraday_middleware][] project.
+
+We will accept adapters that:
+
+1. support SSL & streaming;
+1. are proven and may have better performance than existing ones; or
+2. if they have features not present in included adapters.
+
+We are pushing towards a 1.0 release, when we will have to follow [Semantic
+Versioning][semver].  If your patch includes changes to break compatiblitity,
+note that so we can add it to the [Changelog][].
+
+## Supported Ruby versions
+
+This library aims to support and is [tested against][travis] the following Ruby
+implementations:
+
+* MRI 1.8.7
+* MRI 1.9.2
+* MRI 1.9.3
+* [JRuby][]
+* [Rubinius][]
+
+If something doesn't work on one of these interpreters, it should be considered
+a bug.
+
+This library may inadvertently work (or seem to work) on other Ruby
+implementations, however support will only be provided for the versions listed
+above.
+
+If you would like this library to support another Ruby version, you may
+volunteer to be a maintainer. Being a maintainer entails making sure all tests
+run and pass on that implementation. When something breaks on your
+implementation, you will be personally responsible for providing patches in a
+timely fashion. If critical issues for a particular implementation exist at the
+time of a major release, support for that Ruby version may be dropped.
+
+## Copyright
+
+Copyright (c) 2009-2012 [Rick Olson](mailto:technoweenie@gmail.com), zack hobson.
+See [LICENSE][] for details.
+
+
+  [license]:   https://github.com/technoweenie/faraday/blob/master/LICENSE.md
+  [travis]:    http://travis-ci.org/technoweenie/faraday
+  [jruby]:     http://jruby.org/
+  [rubinius]:  http://rubini.us/
+  [semver]:    http://semver.org/
+  [changelog]: https://github.com/technoweenie/faraday/wiki/Changelog
+  [excon]:     https://github.com/geemus/excon#readme
+  [typhoeus]:  https://github.com/typhoeus/typhoeus#readme
+  [patron]:    http://toland.github.com/patron/
+
+  [eventmachine]:       https://github.com/igrigorik/em-http-request#readme
+  [faraday_middleware]: https://github.com/pengwynn/faraday_middleware/wiki

data/Rakefile

@@ -0,0 +1,87 @@
+require 'date'
+require 'rake/testtask'
+
+task :default => :test
+
+## helper functions
+
+def name
+  @name ||= Dir['*.gemspec'].first.split('.').first
+end
+
+def gem_name
+  'avdi-faraday'
+end
+
+def version
+  line = File.read("lib/#{name}.rb")[/^\s*VERSION\s*=\s*.*/]
+  line.match(/.*VERSION\s*=\s*['"](.*)['"]/)[1]
+end
+
+def gemspec_file
+  "#{name}.gemspec"
+end
+
+def gem_file
+  "#{gem_name}-#{version}.gem"
+end
+
+def replace_header(head, header_name)
+  head.sub!(/(\.#{header_name}\s*= ').*'/) { "#{$1}#{send(header_name)}'"}
+end
+
+## standard tasks
+
+desc "Run all tests"
+task :test do
+  exec 'script/test'
+end
+
+desc "Open an irb session preloaded with this library"
+task :console do
+  sh "irb -rubygems -r ./lib/#{name}.rb"
+end
+
+## release management tasks
+
+desc "Commit, create tag v#{version} and build and push #{gem_file} to Rubygems"
+task :release => :build do
+  sh "git commit --allow-empty -a -m 'Release #{version}'"
+  sh "git tag v#{version}-avdi"
+  sh "git push avdi"
+  sh "git push avdi v#{version}"
+  sh "gem push pkg/#{gem_file}"
+end
+
+desc "Build #{gem_file} into the pkg directory"
+task :build => :gemspec do
+  sh "mkdir -p pkg"
+  sh "gem build #{gemspec_file}"
+  sh "mv #{gem_file} pkg"
+end
+
+desc "Generate #{gemspec_file}"
+task :gemspec do
+  # read spec file and split out manifest section
+  spec = File.read(gemspec_file)
+  head, manifest, tail = spec.split("  # = MANIFEST =\n")
+
+  # replace name version and date
+  replace_header(head, :gem_name)
+  replace_header(head, :version)
+
+  # determine file list from git ls-files
+  files = `git ls-files`.
+    split("\n").
+    sort.
+    reject { |file| file =~ /^\./ }.
+    reject { |file| file =~ /^(rdoc|pkg)/ }.
+    map { |file| "    #{file}" }.
+    join("\n")
+
+  # piece file back together and write
+  manifest = "  s.files = %w[\n#{files}\n  ]\n"
+  spec = [head, manifest, tail].join("  # = MANIFEST =\n")
+  File.open(gemspec_file, 'w') { |io| io.write(spec) }
+  puts "Updated #{gemspec_file}"
+end

data/config.ru

@@ -0,0 +1,6 @@
+require 'rubygems'
+require 'bundler'
+Bundler.setup
+
+require File.expand_path('../test/live_server', __FILE__)
+run Sinatra::Application

data/faraday.gemspec

@@ -0,0 +1,86 @@
+Gem::Specification.new do |s|
+  s.specification_version = 2 if s.respond_to? :specification_version=
+  s.required_rubygems_version = Gem::Requirement.new(">= 1.3.5") if s.respond_to? :required_rubygems_version=
+
+  s.name    = 'avdi-faraday'
+  s.version = '0.8.1'
+
+  s.summary     = "Avdi's personal fork of Faraday. Nothing to see here. Move along."
+  s.description = "Just a fork so I can satisfy gem dependencies in Leadlight."
+
+  s.authors  = ["Rick Olson", "Avdi Grimm"]
+  s.email    = 'avdi@avdi.org'
+  s.homepage = 'https://github.com/avdi/faraday'
+
+  s.add_dependency 'multipart-post', '~> 1.1'
+  s.add_development_dependency 'rake'
+  s.add_development_dependency 'simplecov'
+  s.add_development_dependency 'test-unit'
+  s.add_development_dependency 'webmock'
+
+  # = MANIFEST =
+  s.files = %w[
+    Gemfile
+    LICENSE.md
+    README.md
+    Rakefile
+    config.ru
+    faraday.gemspec
+    lib/faraday.rb
+    lib/faraday/adapter.rb
+    lib/faraday/adapter/em_http.rb
+    lib/faraday/adapter/em_synchrony.rb
+    lib/faraday/adapter/em_synchrony/parallel_manager.rb
+    lib/faraday/adapter/excon.rb
+    lib/faraday/adapter/httpclient.rb
+    lib/faraday/adapter/net_http.rb
+    lib/faraday/adapter/net_http_persistent.rb
+    lib/faraday/adapter/patron.rb
+    lib/faraday/adapter/rack.rb
+    lib/faraday/adapter/test.rb
+    lib/faraday/adapter/typhoeus.rb
+    lib/faraday/builder.rb
+    lib/faraday/connection.rb
+    lib/faraday/error.rb
+    lib/faraday/middleware.rb
+    lib/faraday/request.rb
+    lib/faraday/request/authorization.rb
+    lib/faraday/request/basic_authentication.rb
+    lib/faraday/request/multipart.rb
+    lib/faraday/request/retry.rb
+    lib/faraday/request/token_authentication.rb
+    lib/faraday/request/url_encoded.rb
+    lib/faraday/response.rb
+    lib/faraday/response/logger.rb
+    lib/faraday/response/raise_error.rb
+    lib/faraday/upload_io.rb
+    lib/faraday/utils.rb
+    script/test
+    test/adapters/default_test.rb
+    test/adapters/em_http_test.rb
+    test/adapters/em_synchrony_test.rb
+    test/adapters/excon_test.rb
+    test/adapters/httpclient_test.rb
+    test/adapters/integration.rb
+    test/adapters/logger_test.rb
+    test/adapters/net_http_persistent_test.rb
+    test/adapters/net_http_test.rb
+    test/adapters/patron_test.rb
+    test/adapters/rack_test.rb
+    test/adapters/test_middleware_test.rb
+    test/adapters/typhoeus_test.rb
+    test/authentication_middleware_test.rb
+    test/connection_test.rb
+    test/env_test.rb
+    test/helper.rb
+    test/live_server.rb
+    test/middleware/retry_test.rb
+    test/middleware_stack_test.rb
+    test/middleware_test.rb
+    test/request_middleware_test.rb
+    test/response_middleware_test.rb
+  ]
+  # = MANIFEST =
+
+  s.test_files = s.files.select { |path| path =~ %r{^test/*/.+\.rb} }
+end