faraday 0.4.6 → 0.5.0

data/Gemfile

@@ -0,0 +1,3 @@
+source "http://rubygems.org"
+
+gemspec

data/Gemfile.lock

@@ -0,0 +1,28 @@
+PATH
+  remote: .
+  specs:
+    faraday (0.4.6)
+      addressable (~> 2.1.1)
+      multipart-post (~> 1.0.1)
+      rack (~> 1.0.1)
+
+GEM
+  remote: http://rubygems.org/
+  specs:
+    addressable (2.1.2)
+    multipart-post (1.0.1)
+    rack (1.0.1)
+    rake (0.8.7)
+    sinatra (1.0)
+      rack (>= 1.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  addressable (~> 2.1.1)
+  faraday!
+  multipart-post (~> 1.0.1)
+  rack (~> 1.0.1)
+  rake (~> 0.8.7)
+  sinatra (~> 1.0.0)

data/README.md

@@ -0,0 +1,84 @@
+# faraday
+
+Modular HTTP client library using middleware heavily inspired by Rack.
+
+This mess is gonna get raw, like sushi. So, haters to the left.
+
+## Usage
+
+    conn = Faraday::Connection.new(:url => 'http://sushi.com') do |builder|
+      builder.use Faraday::Request::Yajl     # convert body to json with Yajl lib
+      builder.use Faraday::Adapter::Logger   # log the request somewhere?
+      builder.use Faraday::Adapter::Typhoeus # make http request with typhoeus
+      builder.use Faraday::Response::Yajl    # # parse body with yajl
+
+      # or use shortcuts
+      builder.request  :yajl     # Faraday::Request::Yajl
+      builder.adapter  :logger   # Faraday::Adapter::Logger
+      builder.adapter  :typhoeus # Faraday::Adapter::Typhoeus
+      builder.response :yajl     # Faraday::Response::Yajl
+    end
+
+    resp1 = conn.get '/nigiri/sake.json'
+    resp2 = conn.post do |req|
+      req.url  "/nigiri.json", :page => 2
+      req[:content_type] = 'application/json'
+      req.body = {:name => 'Unagi'}
+    end
+
+    # If you're ready to roll with just the bare minimum (net/http):
+    resp1 = Faraday.get 'http://sushi.com/nigiri/sake.json'
+
+## Testing
+
+    # It's possible to define stubbed request outside a test adapter block.
+    stubs = Faraday::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::Connection.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
+* Support timeouts
+* Add curb, em-http, fast_http
+
+## Note on Patches/Pull Requests
+ 
+* Fork the project.
+* Make your feature addition or bug fix.
+* Add tests for it. This is important so I don't break it in a
+  future version unintentionally.
+* Commit, do not mess with rakefile, version, or history.
+  (if you want to have your own version, that is fine but bump version in a commit by itself I can ignore when I pull)
+* Send me a pull request. Bonus points for topic branches.
+
+## Copyright
+
+Copyright (c) 2009-2010 rick, hobson. See LICENSE for details.

data/Rakefile

@@ -1,25 +1,50 @@
 require 'rubygems'
 require 'rake'
+require 'date'
 
-begin
-  require 'jeweler'
-  Jeweler::Tasks.new do |gem|
-    gem.name = "faraday"
-    gem.summary = "HTTP/REST API client library"
-    gem.description = "HTTP/REST API client library with pluggable components"
-    gem.email = "technoweenie@gmail.com"
-    gem.homepage = "http://github.com/technoweenie/faraday"
-    gem.authors = ["rick"]
-    gem.add_dependency "rack",        ">= 1.0.1"
-    gem.add_dependency "addressable", ">= 2.1.1"
-  end
-  Jeweler::GemcutterTasks.new
+#############################################################################
+#
+# Helper functions
+#
+#############################################################################
+
+def name
+  @name ||= Dir['*.gemspec'].first.split('.').first
+end
+
+def version
+  line = File.read("lib/#{name}.rb")[/^\s*VERSION\s*=\s*.*/]
+  line.match(/.*VERSION\s*=\s*['"](.*)['"]/)[1]
+end
+
+def date
+  Date.today.to_s
+end
 
-  task :test => :check_dependencies
-rescue LoadError
-  puts "Jeweler (or a dependency) not available. Install it with: gem install jeweler"
+def rubyforge_project
+  name
 end
 
+def gemspec_file
+  "#{name}.gemspec"
+end
+
+def gem_file
+  "#{name}-#{version}.gem"
+end
+
+def replace_header(head, header_name)
+  head.sub!(/(\.#{header_name}\s*= ').*'/) { "#{$1}#{send(header_name)}'"}
+end
+
+#############################################################################
+#
+# Standard tasks
+#
+#############################################################################
+
+task :default => :test
+
 require 'rake/testtask'
 Rake::TestTask.new(:test) do |test|
   test.libs << 'lib' << 'test'
@@ -27,27 +52,79 @@ Rake::TestTask.new(:test) do |test|
   test.verbose = true
 end
 
-begin
-  require 'rcov/rcovtask'
-  Rcov::RcovTask.new do |test|
-    test.libs << 'test'
-    test.pattern = 'test/**/*_test.rb'
-    test.verbose = true
-  end
-rescue LoadError
-  task :rcov do
-    abort "RCov is not available. In order to run rcov, you must: sudo gem install spicycode-rcov"
+desc "Open an irb session preloaded with this library"
+task :console do
+  sh "irb -rubygems -r ./lib/#{name}.rb"
+end
+
+#############################################################################
+#
+# Custom tasks (add your own tasks here)
+#
+#############################################################################
+
+
+
+#############################################################################
+#
+# Packaging tasks
+#
+#############################################################################
+
+task :release => :build do
+  unless `git branch` =~ /^\* master$/
+    puts "You must be on the master branch to release!"
+    exit!
   end
+  sh "git commit --allow-empty -a -m 'Release #{version}'"
+  sh "git tag v#{version}"
+  sh "git push origin master"
+  sh "git push origin v#{version}"
+  sh "gem push pkg/#{name}-#{version}.gem"
 end
 
-task :default => :test
+task :build => :gemspec do
+  sh "mkdir -p pkg"
+  sh "gem build #{gemspec_file}"
+  sh "mv #{gem_file} pkg"
+end
+
+task :gemspec => :validate 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, :name)
+  replace_header(head, :version)
+  replace_header(head, :date)
+  #comment this out if your rubyforge_project has a different name
+  replace_header(head, :rubyforge_project)
 
-require 'rake/rdoctask'
-Rake::RDocTask.new do |rdoc|
-  version = File.exist?('VERSION') ? File.read('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")
 
-  rdoc.rdoc_dir = 'rdoc'
-  rdoc.title = "faraday #{version}"
-  rdoc.rdoc_files.include('README*')
-  rdoc.rdoc_files.include('lib/**/*.rb')
+  # 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
+
+task :validate do
+  libfiles = Dir['lib/*'] - ["lib/#{name}.rb", "lib/#{name}"]
+  unless libfiles.empty?
+    puts "Directory `lib` should only contain a `#{name}.rb` file and `#{name}` dir."
+    exit!
+  end
+  unless Dir['VERSION*'].empty?
+    puts "A `VERSION` file at root level violates Gem best practices."
+    exit!
+  end
+end

data/faraday.gemspec

@@ -1,87 +1,90 @@
-# Generated by jeweler
-# DO NOT EDIT THIS FILE DIRECTLY
-# Instead, edit Jeweler::Tasks in Rakefile, and run the gemspec command
-# -*- encoding: utf-8 -*-
-
+## This is the rakegem gemspec template. Make sure you read and understand
+## all of the comments. Some sections require modification, and others can
+## be deleted if you don't need them. Once you understand the contents of
+## this file, feel free to delete any comments that begin with two hash marks.
+## You can find comprehensive Gem::Specification documentation, at
+## http://docs.rubygems.org/read/chapter/20
 Gem::Specification.new do |s|
-  s.name = %q{faraday}
-  s.version = "0.4.6"
-
+  s.specification_version = 2 if s.respond_to? :specification_version=
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
-  s.authors = ["rick"]
-  s.date = %q{2010-05-28}
-  s.description = %q{HTTP/REST API client library with pluggable components}
-  s.email = %q{technoweenie@gmail.com}
-  s.extra_rdoc_files = [
-    "LICENSE",
-     "README.rdoc"
-  ]
-  s.files = [
-    ".document",
-     ".gitignore",
-     "LICENSE",
-     "README.rdoc",
-     "Rakefile",
-     "VERSION",
-     "faraday.gemspec",
-     "lib/faraday.rb",
-     "lib/faraday/adapter/net_http.rb",
-     "lib/faraday/adapter/patron.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/active_support_json.rb",
-     "lib/faraday/request/yajl.rb",
-     "lib/faraday/response.rb",
-     "lib/faraday/response/active_support_json.rb",
-     "lib/faraday/response/yajl.rb",
-     "test/adapters/live_test.rb",
-     "test/adapters/test_middleware_test.rb",
-     "test/adapters/typhoeus_test.rb",
-     "test/connection_app_test.rb",
-     "test/connection_test.rb",
-     "test/env_test.rb",
-     "test/helper.rb",
-     "test/live_server.rb",
-     "test/request_middleware_test.rb",
-     "test/response_middleware_test.rb"
-  ]
-  s.homepage = %q{http://github.com/technoweenie/faraday}
-  s.rdoc_options = ["--charset=UTF-8"]
-  s.require_paths = ["lib"]
-  s.rubygems_version = %q{1.3.6}
-  s.summary = %q{HTTP/REST API client library}
-  s.test_files = [
-    "test/adapters/live_test.rb",
-     "test/adapters/test_middleware_test.rb",
-     "test/adapters/typhoeus_test.rb",
-     "test/connection_app_test.rb",
-     "test/connection_test.rb",
-     "test/env_test.rb",
-     "test/helper.rb",
-     "test/live_server.rb",
-     "test/request_middleware_test.rb",
-     "test/response_middleware_test.rb"
-  ]
+  s.rubygems_version = '1.3.5'
 
-  if s.respond_to? :specification_version then
-    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
-    s.specification_version = 3
+  ## Leave these as is they will be modified for you by the rake gemspec task.
+  ## If your rubyforge_project name is different, then edit it and comment out
+  ## the sub! line in the Rakefile
+  s.name              = 'faraday'
+  s.version           = '0.5.0'
+  s.date              = '2010-10-08'
+  s.rubyforge_project = 'faraday'
 
-    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
-      s.add_runtime_dependency(%q<rack>, [">= 1.0.1"])
-      s.add_runtime_dependency(%q<addressable>, [">= 2.1.1"])
-    else
-      s.add_dependency(%q<rack>, [">= 1.0.1"])
-      s.add_dependency(%q<addressable>, [">= 2.1.1"])
-    end
-  else
-    s.add_dependency(%q<rack>, [">= 1.0.1"])
-    s.add_dependency(%q<addressable>, [">= 2.1.1"])
-  end
-end
+  ## Make sure your summary is short. The description may be as long
+  ## as you like.
+  s.summary     = "HTTP/REST API client library."
+  s.description = "HTTP/REST API client library."
+
+  ## List the primary authors. If there are a bunch of authors, it's probably
+  ## better to set the email to an email list or something. If you don't have
+  ## a custom homepage, consider using your GitHub URL or the like.
+  s.authors  = ["Rick Olson"]
+  s.email    = 'technoweenie@gmail.com'
+  s.homepage = 'http://github.com/technoweenie/faraday'
+
+  ## This gets added to the $LOAD_PATH so that 'lib/NAME.rb' can be required as
+  ## require 'NAME.rb' or'/lib/NAME/file.rb' can be as require 'NAME/file.rb'
+  s.require_paths = %w[lib]
+
+  s.add_development_dependency('rake', ['~> 0.8.7'])
+  s.add_development_dependency('sinatra', ['~> 1.0.0'])
+  s.add_runtime_dependency('addressable', ['~> 2.1.1'])
+  s.add_runtime_dependency('multipart-post', ['~> 1.0.1'])
+  s.add_runtime_dependency('rack', ['~> 1.2.1'])
+
+  ## Leave this section as-is. It will be automatically generated from the
+  ## contents of your Git repository via the gemspec task. DO NOT REMOVE
+  ## THE MANIFEST COMMENTS, they are used as delimiters by the task.
+  # = MANIFEST =
+  s.files = %w[
+    Gemfile
+    Gemfile.lock
+    LICENSE
+    README.md
+    Rakefile
+    faraday.gemspec
+    lib/faraday.rb
+    lib/faraday/adapter.rb
+    lib/faraday/adapter/action_dispatch.rb
+    lib/faraday/adapter/net_http.rb
+    lib/faraday/adapter/patron.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/active_support_json.rb
+    lib/faraday/request/yajl.rb
+    lib/faraday/response.rb
+    lib/faraday/response/active_support_json.rb
+    lib/faraday/response/yajl.rb
+    lib/faraday/upload_io.rb
+    lib/faraday/utils.rb
+    test/adapters/live_test.rb
+    test/adapters/test_middleware_test.rb
+    test/adapters/typhoeus_test.rb
+    test/connection_app_test.rb
+    test/connection_test.rb
+    test/env_test.rb
+    test/form_post_test.rb
+    test/helper.rb
+    test/live_server.rb
+    test/multipart_test.rb
+    test/request_middleware_test.rb
+    test/response_middleware_test.rb
+  ]
+  # = MANIFEST =
 
+  ## Test files will be grabbed from the file list. Make sure the path glob
+  ## matches what you actually use.
+  s.test_files = s.files.select { |path| path =~ /^test\/.*_test\.rb/ }
+end