faraday_yaml 0.0.1

data/.gitignore

@@ -0,0 +1,4 @@
+pkg/*
+*.gem
+.bundle
+driver.rb

data/Gemfile

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

data/README.md

@@ -0,0 +1,46 @@
+# Faraday YAML Middleware
+
+Yeah, JSON is at least 2.9x cooler than YAML, but sometimes you're stuck using it, right?
+
+## Installation
+
+    gem install faraday_yaml
+
+### Examples
+
+#### Response
+Here's an example: (Github's YAML API is currently deprecated, but it works for the sake of this example)
+
+    conn = Faraday::Connection.new(:url => "http://github.com") do |builder|
+      builder.adapter Faraday.default_adapter
+      builder.use Faraday::Response::YAML
+    end
+
+    resp = conn.get do |req|
+      req.url "/api/v2/yaml/user/show/dmarkow"
+    end
+
+    u = resp.body
+    u['user']['name']
+    # => "Dylan Markow"
+
+#### Request
+
+    conn = Faraday::Connection.new(:url => "http://USERNAME:PASSWORD@github.com") do |builder|
+      builder.adapter Faraday.default_adapter
+      builder.use Faraday::Request::YAML
+      builder.use Faraday::Response::YAML
+    end
+
+    resp = conn.post do |req|
+      req.url "/api/v2/yaml/user/show/dmarkow"
+      req.body = {
+        "values" => {
+          "location" => "Portland, OR"
+        }
+      }
+    end
+
+    u = resp.body
+    u['user']['location']
+    # => "Portland, OR"

data/Rakefile

@@ -0,0 +1,2 @@
+require 'bundler'
+Bundler::GemHelper.install_tasks

data/faraday_yaml.gemspec

@@ -0,0 +1,23 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "faraday_yaml/version"
+
+Gem::Specification.new do |s|
+  s.name        = "faraday_yaml"
+  s.version     = FaradayYaml::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["Dylan Markow"]
+  s.email       = ["dylan@dylanmarkow.com"]
+  s.homepage    = "http://github.com/dmarkow/faraday_yaml"
+  s.summary     = %q{YAML Response/Request Middleware for Faraday}
+  s.description = s.summary
+
+  s.rubyforge_project = "faraday_yaml"
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+  s.add_development_dependency "rspec", "~> 2.4.0"
+  s.add_runtime_dependency "faraday", "~> 0.5.4"
+end

data/lib/faraday_yaml/request/yaml.rb

@@ -0,0 +1,20 @@
+require 'faraday'
+
+module Faraday
+  class Request::YAML < Faraday::Middleware
+    begin
+      require 'yaml'
+    rescue LoadError, NameError => e
+      self.load_error = e
+    end
+
+    def call(env)
+      env[:request_headers]['Content-Type'] = 'application/x-yaml'
+      if env[:body] && !env[:body].respond_to?(:to_str)
+        env[:body] = env[:body].to_yaml
+      end
+      @app.call env
+    end
+  end
+end
+

data/lib/faraday_yaml/response/yaml.rb

@@ -0,0 +1,28 @@
+require 'faraday'
+
+module Faraday
+  class Response::YAML < Response::Middleware
+    begin
+      require 'yaml'
+
+      def self.register_on_complete(env)
+        env[:response].on_complete do |finished_env|
+          finished_env[:body] = parse(finished_env[:body])
+        end
+      end
+    rescue LoadError, NameError => e
+      self.load_error = e
+    end
+
+    def initialize(app)
+      super
+      @parser = nil
+    end
+
+    def self.parse(body)
+      YAML.load(body) || nil
+    rescue Object => err
+      raise Faraday::Error::ParsingError.new(err)
+    end
+  end
+end

data/lib/faraday_yaml/version.rb

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

data/lib/faraday_yaml.rb

@@ -0,0 +1,2 @@
+require 'faraday_yaml/request/yaml.rb'
+require 'faraday_yaml/response/yaml.rb'

data/spec/response_yaml_spec.rb

@@ -0,0 +1,54 @@
+require 'spec_helper'
+
+describe "Using the YAML Response Middleware" do
+
+  before do
+    @stubs = Faraday::Adapter::Test::Stubs.new
+    @conn = Faraday::Connection.new do |conn|
+      conn.adapter :test, @stubs
+      conn.use Faraday::Response::YAML
+    end
+  end
+
+  context "with a valid YAML response" do
+    before do
+      @stubs.get("/me") {[200, {'Content-Type' => 'application/x-yaml'}, "---\nuser:\n  name: Dylan Markow\n  username: dmarkow"]}
+    end
+
+    it "parses the response into a Hash" do
+      me = @conn.get("/me").body['user']
+      me.should be_a(Hash)
+      me['name'].should == "Dylan Markow"
+      me['username'].should == "dmarkow"
+    end
+  end
+
+  context "with a nil response" do
+    before do
+      @stubs.get("/me") {[200, {'Content-Type' => 'application/x-yaml'}, nil]}
+      @response = @conn.get("/me")
+    end
+
+    it "still uses the status code" do
+      @response.status.should == 200
+    end
+    it "should skip empty content" do
+      @response.body.should be_nil
+    end
+  end
+
+  context "with an empty response" do
+    before do
+      @stubs.get("/me") {[200, {'Content-Type' => 'application/x-yaml'}, ""]}
+      @response = @conn.get("/me")
+    end
+
+    it "still uses the status code" do
+      @response.status.should == 200
+    end
+
+    it "should skip empty content" do
+      @response.body.should be_nil
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1 @@
+require File.expand_path('../../lib/faraday_yaml.rb', __FILE__)

metadata

@@ -0,0 +1,105 @@
+--- !ruby/object:Gem::Specification 
+name: faraday_yaml
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 0
+  - 0
+  - 1
+  version: 0.0.1
+platform: ruby
+authors: 
+- Dylan Markow
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-02-04 00:00:00 -08:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 2
+        - 4
+        - 0
+        version: 2.4.0
+  type: :development
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: faraday
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        - 5
+        - 4
+        version: 0.5.4
+  type: :runtime
+  version_requirements: *id002
+description: YAML Response/Request Middleware for Faraday
+email: 
+- dylan@dylanmarkow.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- .gitignore
+- Gemfile
+- README.md
+- Rakefile
+- faraday_yaml.gemspec
+- lib/faraday_yaml.rb
+- lib/faraday_yaml/request/yaml.rb
+- lib/faraday_yaml/response/yaml.rb
+- lib/faraday_yaml/version.rb
+- spec/response_yaml_spec.rb
+- spec/spec_helper.rb
+has_rdoc: true
+homepage: http://github.com/dmarkow/faraday_yaml
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: faraday_yaml
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: YAML Response/Request Middleware for Faraday
+test_files: 
+- spec/response_yaml_spec.rb
+- spec/spec_helper.rb