headless-rails 0.0.2 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 3430eeda993cfbe14e78e0db458e45ffcff310f7
-  data.tar.gz: aaacaea9451a308e118149656d1b7b7bf7e994f2
+  metadata.gz: f8f528076eccde288b3cec6d1fe33dcbddbea353
+  data.tar.gz: 0ac9c6ce2bb2856dd14b8c24588d4fd546e0408d
 SHA512:
-  metadata.gz: f15c29d05d3386ef1c52c9212d20d938958afc61014b6db81f87941d978e5d7eb890b4580112d1e08074418a9cd1f86aa27fd54b8a675258749dbb247d74d616
-  data.tar.gz: 366451b773dd444f436e02af981271c39bcc5e0a9489c8c69fb8c6cc71abcd1a3005b22cdb6e7df70d2937dbb214e0c8d38c638b93dfea81b2400cea21db0a97
+  metadata.gz: 4ec9616d598293f33e8876f5649e14b5bbfaee4fa7da824bd6b0990cb701025ed26799c9171c91b476cd57e68bad63b3ece0b2cbc7b63b6737b0df041d9614f9
+  data.tar.gz: ab7267fdb39ab4699200ccc3ca0cb0943697209c2c95eb0ba5d55c7970ce9c38b6bfc5106d1452f48b54dc44e3abc43dd6ba645026e29401cadc7821964e83fb

data/README.md

@@ -1,5 +1,7 @@
 # Headless::Rails
 
+[![Build Status](https://travis-ci.org/headlessapp/headless-rails.png?branch=master)](https://travis-ci.org/headlessapp/headless-rails)
+
 API wrapper for the headlessapp.com service.
 
 Seamlessly integrate AJAX webcrawler support into your javascript application.

data/lib/headless/ajax_crawler/request_matcher.rb

@@ -0,0 +1,32 @@
+module Headless
+  module AjaxCrawler
+    class RequestMatcher< Struct.new(:request)
+
+      def self.call(request)
+        new(request).match?
+      end
+
+      def match?
+        is_get? && has_escaped_fragment?
+      end
+
+      private
+
+      def is_get?
+        request.get?
+      end
+
+      def has_escaped_fragment?
+        get_params.has_key?(escaped_fragment_key)
+      end
+
+      def escaped_fragment_key
+        ::Headless::AjaxCrawler::ESCAPED_FRAGMENT_KEY
+      end
+
+      def get_params
+        request.GET
+      end
+    end
+  end
+end

data/lib/headless/{rails/escaped_fragment_extractor.rb → ajax_crawler/url_extractor.rb}

@@ -1,24 +1,26 @@
 require 'rack/utils'
 
 module Headless
-  module Rails
-    class EscapedFragmentExtractor < Struct.new(:request)
+  module AjaxCrawler
+    class UrlExtractor < Struct.new(:request)
 
       def self.call(request)
         new(request).call
       end
 
       def call
-        url = "#{protocol}#{host_with_port}#{path}"
-        url << "?#{query_string}" unless query_string.empty?
-        url << "##{hash_string}"  unless hash_string.empty?
+        url = "#{scheme}://#{host_with_port}#{path}"
+        url << "?#{query_string}"      unless query_string.empty?
+        url << "##{escaped_fragment}"  unless escaped_fragment.nil? || escaped_fragment.empty?
         url
       end
 
       private
 
-      def protocol
-        request.protocol
+      # delegate to request
+
+      def scheme
+        request.scheme
       end
 
       def host_with_port
@@ -29,22 +31,24 @@ module Headless
         request.path
       end
 
-      def hash_string
-        escaped_fragment
+      def get_params
+        request.GET
       end
 
+      # extract the fragment
+
       def escaped_fragment
-        request.GET[escaped_fragment_key]
+        get_params[escaped_fragment_key]
       end
 
       def params_without_fragment
-        without = request.GET.dup
+        without = get_params.dup
         without.delete(escaped_fragment_key)
         without
       end
 
       def escaped_fragment_key
-        ::Headless::Rails::ESCAPED_FRAGMENT_KEY
+        ::Headless::AjaxCrawler::ESCAPED_FRAGMENT_KEY
       end
 
       def query_string

data/lib/headless/ajax_crawler.rb

@@ -0,0 +1,8 @@
+require 'headless/ajax_crawler/request_matcher'
+require 'headless/ajax_crawler/url_extractor'
+
+module Headless
+  module AjaxCrawler
+    ESCAPED_FRAGMENT_KEY = "_escaped_fragment_".freeze
+  end
+end

data/lib/headless/rails/version.rb

@@ -1,5 +1,5 @@
 module Headless
   module Rails
-    VERSION = "0.0.2"
+    VERSION = "0.0.3"
   end
 end

data/lib/headless/rails.rb

@@ -1,17 +1,15 @@
 require "headless/rails/version"
-require "headless/rails/escaped_fragment_extractor"
+require "headless/ajax_crawler"
 require "headless/api_client"
 
 module Headless
   module Rails
 
-    ESCAPED_FRAGMENT_KEY = "_escaped_fragment_".freeze
-
     def respond_to_ajax_crawlers
-      if params.has_key?(ESCAPED_FRAGMENT_KEY)
-        url = ::Headless::Rails::EscapedFragmentExtractor.call(request)
+      if ::Headless::AjaxCrawler::RequestMatcher.call(request)
+        url = ::Headless::AjaxCrawler::UrlExtractor.call(request)
         crawled = ::Headless::APIClient.crawl(url)
-        render text: crawled.content if crawled.success?
+        render :text => crawled.content if crawled.success?
       end
     end
 

data/spec/headless/ajax_crawler/request_matcher_spec.rb

@@ -0,0 +1,37 @@
+require "spec_helper"
+require "headless/ajax_crawler/request_matcher"
+
+RSpec.describe Headless::AjaxCrawler::RequestMatcher do
+
+  describe "call" do
+
+    it "returns false with no fragment" do
+      request = request_for_uri("/user/matthewrudy")
+      expect(call(request)).to be_false
+    end
+
+    it "returns false with no fragment and some params" do
+      request = request_for_uri("/user/matthewrudy?foo=bar")
+      expect(call(request)).to be_false
+    end
+
+    it "returns true with an empty escaped_fragment" do
+      request = request_for_uri("/user/matthewrudy?_escaped_fragment_=")
+      expect(call(request)).to be_true
+    end
+
+    it "returns true with an escaped_fragment" do
+      request = request_for_uri("/user/matthewrudy?foo=bar&_escaped_fragment_=/show/twitter")
+      expect(call(request)).to be_true
+    end
+
+    it "returns false for a POST request, even with an escaped_fragment" do
+      request = post_request_for_uri("/user/matthewrudy?foo=bar&_escaped_fragment_=/show/twitter")
+      expect(call(request)).to be_false
+    end
+
+    def call(request)
+      described_class.call(request)
+    end
+  end
+end

data/spec/headless/ajax_crawler/url_extractor_spec.rb

@@ -0,0 +1,59 @@
+require 'spec_helper'
+require 'rack/request'
+
+RSpec.describe Headless::AjaxCrawler::UrlExtractor do
+
+  describe "call" do
+
+    let(:request) { request_for_uri(uri) }
+
+    subject do
+      described_class.call(request)
+    end
+
+    context "with no escaped_fragment" do
+
+      let(:uri) { "/user/matthewrudy" }
+
+      it "returns a full url" do
+        expect(subject).to eq "http://localhost:3000/user/matthewrudy"
+      end
+    end
+
+    context "with some params" do
+
+      let(:uri) { "/user/matthewrudy?foo=bar" }
+
+      it "keeps the params intact" do
+        expect(subject).to eq "http://localhost:3000/user/matthewrudy?foo=bar"
+      end
+    end
+
+    context "with an empty escaped_fragment" do
+
+      let(:uri) { "/user/matthewrudy?_escaped_fragment_=" }
+
+      it "returns a full url with the escaped fragment removed" do
+        expect(subject).to eq "http://localhost:3000/user/matthewrudy"
+      end
+    end
+
+    context "with an escaped_fragment" do
+
+      let(:uri) { "/user/matthewrudy?_escaped_fragment_=/show/twitter" }
+
+      it "returns the full url with an anchor appended" do
+        expect(subject).to eq "http://localhost:3000/user/matthewrudy#/show/twitter"
+      end
+    end
+
+    context "with an escaped_fragment and some params" do
+
+      let(:uri) { "/user/matthewrudy?foo=bar&_escaped_fragment_=/show/twitter" }
+
+      it "returns the full url with an anchor appended" do
+        expect(subject).to eq "http://localhost:3000/user/matthewrudy?foo=bar#/show/twitter"
+      end
+    end
+  end
+end

data/spec/headless/rails_spec.rb

@@ -9,11 +9,11 @@ RSpec.describe Headless::Rails do
     double(:controller,
       :request => request,
       :params => {},
-      :render => nil,
+      :render => nil
     )
   end
 
-  let(:request) { double(:request) }
+  let(:request) { request_for_uri("/user/matthewrudy?foo=bar") }
   let(:headless_response) { double(:headless_response, :success? => true, :content => :headless_content) }
 
   describe "respond_to_ajax_crawlers" do
@@ -22,6 +22,9 @@ RSpec.describe Headless::Rails do
     end
 
     context "with no escaped_fragment" do
+
+      let(:request) { request_for_uri("/user/matthewrudy?foo=bar") }
+
       before do
         controller.stub(:params).and_return({})
       end
@@ -39,11 +42,11 @@ RSpec.describe Headless::Rails do
     end
 
     context "with an escaped fragment" do
-      before do
-        controller.stub(:params).and_return({"_escaped_fragment_" => "something"})
 
-        expect(Headless::Rails::EscapedFragmentExtractor).to receive(:call).with(request).and_return(:a_url)
-        expect(Headless::APIClient).to receive(:crawl).with(:a_url).and_return(headless_response)
+      let(:request) { request_for_uri("/user/matthewrudy?foo=bar&_escaped_fragment_=/show/twitter") }
+
+      before do
+        expect(Headless::APIClient).to receive(:crawl).with("http://localhost:3000/user/matthewrudy?foo=bar#/show/twitter").and_return(headless_response)
       end
 
       it "extracts the fragment, fetches content from the api, and renders its" do

data/spec/spec_helper.rb

@@ -1,2 +1,7 @@
 $LOAD_PATH.unshift File.expand_path('../../lib', __FILE__)
 require 'headless/rails'
+require 'support/example_requests'
+
+RSpec.configure do |c|
+  c.include ExampleRequests
+end

data/spec/support/example_requests.rb

@@ -0,0 +1,48 @@
+module ExampleRequests
+
+  def request_env_for_uri(uri, http_verb="GET")
+    path, query = uri.split("?")
+
+    {
+      "SERVER_SOFTWARE"      => "thin 1.5.1 codename Straight Razor",
+      "HTTP_VERSION"         => "HTTP/1.1",
+      "HTTP_CONNECTION"      => "keep-alive",
+      "HTTP_ACCEPT"          => "text/html,application/xhtml+xml,application/xml;q=0.9,*/*;q=0.8",
+      "HTTP_USER_AGENT"      => "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_8_4) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/28.0.1500.95 Safari/537.36",
+      "HTTP_ACCEPT_ENCODING" => "gzip,deflate,sdch",
+      "HTTP_ACCEPT_LANGUAGE" => "en-GB,en;q=0.8,en-US;q=0.6,zh;q=0.4",
+      "HTTP_COOKIE"          => "foo=bar",
+      "GATEWAY_INTERFACE"    => "CGI/1.2",
+
+      "SCRIPT_NAME" => "",
+      "REMOTE_ADDR" => "127.0.0.1",
+
+      # http method
+      "REQUEST_METHOD" => http_verb,
+
+      # protocol
+      "SERVER_PROTOCOL" => "HTTP/1.1",
+      "rack.url_scheme" => "http",
+
+      # host and port
+      "SERVER_NAME" => "localhost",
+      "HTTP_HOST"   => "localhost:3000",
+      "SERVER_PORT" => "3000",
+
+      # path and query string
+      "REQUEST_PATH" => path,
+      "PATH_INFO"    => path,
+      "REQUEST_URI"  => uri,
+      "QUERY_STRING" => query,
+    }
+  end
+
+  def request_for_uri(uri)
+    ::Rack::Request.new(request_env_for_uri(uri))
+  end
+
+  def post_request_for_uri(uri)
+    ::Rack::Request.new(request_env_for_uri(uri, "POST"))
+  end
+
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: headless-rails
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
 platform: ruby
 authors:
 - Matthew Rudy Jacobs
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-08-11 00:00:00.000000000 Z
+date: 2013-08-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rest-client
@@ -109,16 +109,20 @@ files:
 - README.md
 - Rakefile
 - headless-rails.gemspec
+- lib/headless/ajax_crawler.rb
+- lib/headless/ajax_crawler/request_matcher.rb
+- lib/headless/ajax_crawler/url_extractor.rb
 - lib/headless/api_client.rb
 - lib/headless/api_response.rb
 - lib/headless/rails.rb
-- lib/headless/rails/escaped_fragment_extractor.rb
 - lib/headless/rails/version.rb
+- spec/headless/ajax_crawler/request_matcher_spec.rb
+- spec/headless/ajax_crawler/url_extractor_spec.rb
 - spec/headless/ap_response_spec.rb
 - spec/headless/api_client_spec.rb
-- spec/headless/rails/escaped_fragment_extractor_spec.rb
 - spec/headless/rails_spec.rb
 - spec/spec_helper.rb
+- spec/support/example_requests.rb
 homepage: http://www.headlessapp.com
 licenses:
 - MIT
@@ -144,8 +148,10 @@ signing_key:
 specification_version: 4
 summary: API wrapper for the HeadlessApp.com
 test_files:
+- spec/headless/ajax_crawler/request_matcher_spec.rb
+- spec/headless/ajax_crawler/url_extractor_spec.rb
 - spec/headless/ap_response_spec.rb
 - spec/headless/api_client_spec.rb
-- spec/headless/rails/escaped_fragment_extractor_spec.rb
 - spec/headless/rails_spec.rb
 - spec/spec_helper.rb
+- spec/support/example_requests.rb

data/spec/headless/rails/escaped_fragment_extractor_spec.rb

@@ -1,38 +0,0 @@
-require 'spec_helper'
-
-RSpec.describe Headless::Rails::EscapedFragmentExtractor do
-
-  def request_with_fragment(escaped_fragment)
-    double(:request,
-      :protocol => "http://",
-      :host_with_port => "localhost:3000",
-      :path => "/user/matthewrudy",
-      :GET => {
-        "_escaped_fragment_" => escaped_fragment,
-      }
-    )
-  end
-
-  describe "call" do
-
-    context "with an empty escaped_fragment" do
-      subject do
-        described_class.call(request_with_fragment(""))
-      end
-
-      it "returns a full url with the escaped fragment removed" do
-        expect(subject).to eq "http://localhost:3000/user/matthewrudy"
-      end
-    end
-
-    context "with an escaped_fragment" do
-      subject do
-        described_class.call(request_with_fragment("/show/twitter"))
-      end
-
-      it "returns the full url with an anchor appended" do
-        expect(subject).to eq "http://localhost:3000/user/matthewrudy#/show/twitter"
-      end
-    end
-  end
-end