faraday-lazyable 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 6fac454b5e6dfbf8d9a1dcb28a8b8e4d81a561d2
+  data.tar.gz: 979f4f44623c038cf2b3b2df72224d9919c99b18
+SHA512:
+  metadata.gz: 7c6665e619166c5ded3db1d15d556c8eb85f90f7db483ed199938344d2184e0158d27df6da8f81501702c9f57504849a82cd996203db65cc22870662f15bf26c
+  data.tar.gz: 5d9700cade367146152ac4d1653e950381fa2a7b995443fba3b765b3ed909654bc2e48a2c54245e43bc6b3f6eba1d4a102bf530fb1d1b6b97fb1598aefee3144

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/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Ryo Nakamura
+
+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,73 @@
+# Faraday::Lazyable
+A request is never sent till a response have need.
+
+## Installation
+```
+gem install faraday-lazyable
+```
+
+## Usage
+```ruby
+require "faraday-lazyable"
+
+connection = Faraday.new do |connection|
+  connection.use Faraday::Lazyable
+  connection.adapter :net_http
+  connection.response :logger
+end
+
+# A dummy response is returned.
+response = connection.get("http://example.com")
+
+# The HTTP request is sent when any method call happened to the response.
+response.status #=> 200
+```
+
+## Example
+Suppose that you are building a client web application for your API server.
+Your controller sends HTTP request to the server.
+You're trying to cache the HTTP request
+by using [Fragment Cache](http://guides.rubyonrails.org/caching_with_rails.html) in the view layer
+to improve performance.
+
+### Controller
+```ruby
+class RecipesController < ApplicationController
+  def show
+    @recipe = client.get("http://example.com/recipes/#{params[:id]}")
+  end
+
+  private
+
+  def client
+    Faraday.new
+  end
+end
+```
+
+### View
+```erb
+<% cache do %>
+  <article class="recipe">
+    <h1><%= @recipe.title %></h1>
+    <p><%= @recipe.description %></p>
+  </article>
+<% end %>
+```
+
+### Problem
+But you found that you cannot cache the HTTP request this way
+because the HTTP request is already sent at the controller.
+
+### Solution
+Faraday::Lazyable fits this type of problem.
+The response (`@recipe`) will become lazy-evaluated
+and the HTTP request will never be sent till `@recipe.title` is called at the view.
+
+```ruby
+def client
+  Faraday.new do |connection|
+    connection.use Faraday::Lazyable
+  end
+end
+```

data/Rakefile

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

data/faraday-lazyable.gemspec

@@ -0,0 +1,23 @@
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'faraday/lazyable/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "faraday-lazyable"
+  spec.version       = Faraday::Lazyable::VERSION
+  spec.authors       = ["Ryo Nakamura"]
+  spec.email         = ["r7kamura@gmail.com"]
+  spec.summary       = "A request is never sent till a response have need."
+  spec.homepage      = "https://github.com/r7kamura/faraday-lazyable"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  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 "faraday"
+  spec.add_development_dependency "bundler", "~> 1.5"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec", "2.14.1"
+end

data/lib/faraday-lazyable.rb

@@ -0,0 +1 @@
+require "faraday/lazyable"

data/lib/faraday/lazyable.rb

@@ -0,0 +1,15 @@
+require "faraday"
+require "faraday/lazyable/dummy_response"
+require "faraday/lazyable/version"
+
+module Faraday
+  class Lazyable
+    def initialize(app)
+      @app = app
+    end
+
+    def call(env)
+      DummyResponse.new { @app.call(env) }
+    end
+  end
+end

data/lib/faraday/lazyable/dummy_response.rb

@@ -0,0 +1,27 @@
+module Faraday
+  class Lazyable
+    class DummyResponse < BasicObject
+      instance_methods.each do |method_name|
+        undef_method(method_name) unless method_name == :__send__
+      end
+
+      def initialize(&block)
+        @block = block
+      end
+
+      def respond_to?(method_name)
+        __response__.respond_to?(method_name)
+      end
+
+      private
+
+      def method_missing(method_name, *args, &block)
+        __response__.__send__(method_name, *args, &block)
+      end
+
+      def __response__
+        @response ||= @block.call
+      end
+    end
+  end
+end

data/lib/faraday/lazyable/version.rb

@@ -0,0 +1,5 @@
+module Faraday
+  class Lazyable
+    VERSION = "0.0.1"
+  end
+end

data/spec/faraday/lazyable_spec.rb

@@ -0,0 +1,80 @@
+require "spec_helper"
+
+describe Faraday::Lazyable do
+  let(:client) do
+    Faraday.new do |connection|
+      connection.use Faraday::Lazyable
+      connection.adapter :test, stubs
+    end
+  end
+
+  let(:stubs) do
+    Faraday::Adapter::Test::Stubs.new do |stub|
+      stub.get(url) do
+        history << true
+        [response_status, response_headers, response_body]
+      end
+    end
+  end
+
+  let(:url) do
+    "/"
+  end
+
+  let(:response_status) do
+    200
+  end
+
+  let(:response_headers) do
+    {}
+  end
+
+  let(:response_body) do
+    "OK"
+  end
+
+  let(:history) do
+    []
+  end
+
+  context "till any method is called to the response" do
+    it "does not send any request" do
+      response = client.get(url)
+      history.should be_empty
+      response.body
+      history.should_not be_empty
+    end
+  end
+
+  context "after any method is called to the response" do
+    it "behaves like a real response" do
+      response = client.get(url)
+      response.status.should == response_status
+      response.headers.should == response_headers
+      response.body.should == response_body
+      response.should be_a Faraday::Response
+    end
+  end
+
+  context "even if 2 methods are called to the response" do
+    it "sends only 1 request" do
+      response = client.get(url)
+      response.headers
+      response.body
+      history.size.should == 1
+    end
+  end
+
+  context "when undefined method is called to the response" do
+    it "raises NoMethodError" do
+      response = client.get(url)
+      expect { response.undefined_method }.to raise_error(NoMethodError)
+    end
+
+    it "sends a request" do
+      response = client.get(url)
+      response.undefined_method rescue nil
+      history.size.should == 1
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,8 @@
+$LOAD_PATH.unshift File.expand_path("../../lib", __FILE__)
+require "faraday-lazyable"
+
+RSpec.configure do |config|
+  config.treat_symbols_as_metadata_keys_with_true_values = true
+  config.run_all_when_everything_filtered = true
+  config.filter_run :focus
+end

metadata

@@ -0,0 +1,115 @@
+--- !ruby/object:Gem::Specification
+name: faraday-lazyable
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Ryo Nakamura
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-01-28 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: faraday
+  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.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.5'
+- !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.14.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 2.14.1
+description: 
+email:
+- r7kamura@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- faraday-lazyable.gemspec
+- lib/faraday-lazyable.rb
+- lib/faraday/lazyable.rb
+- lib/faraday/lazyable/dummy_response.rb
+- lib/faraday/lazyable/version.rb
+- spec/faraday/lazyable_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/r7kamura/faraday-lazyable
+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.0.3
+signing_key: 
+specification_version: 4
+summary: A request is never sent till a response have need.
+test_files:
+- spec/faraday/lazyable_spec.rb
+- spec/spec_helper.rb
+has_rdoc: