headless-rails 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 21b0f92d77e15c80aa132104b24364189c1767e7
+  data.tar.gz: e1699ab35cbaabba74f93524a13bc4a3ee48952e
+SHA512:
+  metadata.gz: 1e08d9016ae46c03000e48464df75dd2a22c53d361eaf96bae8031914b23b57c823b98ca654c28ed7806603e43f9eb11a48e11f6a8e55f0d7445d62d2553a488
+  data.tar.gz: b4b5a0fb24e46b1eeaeecb52b5599b0a7a251d8e5c195a43212e4262efccec92d3601e5792aa55f18ada4f6c6fb6517bc2e9cddad99bf6663c0d5429848e69b9

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/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,9 @@
+language: ruby
+rvm:
+  - 1.8.7
+  - 1.9.3
+  - 2.0.0
+  - jruby-18mode # JRuby in 1.8 mode
+  - jruby-19mode # JRuby in 1.9 mode
+  - rbx-18mode
+  - rbx-19mode

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Matthew Rudy Jacobs
+
+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,42 @@
+# Headless::Rails
+
+API wrapper for the headlessapp.com service.
+
+Seamlessly integrate AJAX webcrawler support into your javascript application.
+
+Sign up at http://www.headlessapp.com and install the gem.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'headless-rails'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install headless-rails
+
+## Usage
+
+Open your ApplicationController,
+and add the following;
+
+    class ApplicationController < ActionController::Base
+      include Headless::Rails
+
+      before_filter :respond_to_ajax_crawlers
+    end
+
+That's it.
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/headless-rails.gemspec

@@ -0,0 +1,29 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'headless/rails/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "headless-rails"
+  spec.version       = Headless::Rails::VERSION
+  spec.authors       = ["Matthew Rudy Jacobs"]
+  spec.email         = ["MatthewRudyJacobs@gmail.com"]
+  spec.summary       = %q{ API wrapper for the HeadlessApp.com }
+  spec.description   = %q{ Seamlessly integrate headlessapp.com into your Rails application }
+
+  spec.homepage      = "http://www.headlessapp.com"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  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 "rest-client", "~> 1.6.7"
+  spec.add_dependency "json"
+  spec.add_dependency "rack"
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec"
+end

data/lib/headless/api_client.rb

@@ -0,0 +1,46 @@
+require "rest_client"
+require "json"
+
+module Headless
+  class APIClient
+
+    def self.crawl(url)
+      new.crawl(url)
+    end
+
+    def crawl(url)
+      APIResponse.new(get("/api/crawl", :url => url))
+    end
+
+    class APIResponse < Struct.new(:response)
+
+      def content
+        parsed_response["content"]
+      end
+
+      private
+
+      def parsed_response
+        @parsed_response ||= ::JSON.parse(response)
+      end
+    end
+
+    private
+
+    def get(path, params)
+      ::RestClient.get(url_for(path), :params => params)
+    end
+
+    def url_for(path)
+      "#{headless_protocol}://#{headless_host}#{path}"
+    end
+
+    def headless_host
+      "api.headlessapp.com"
+    end
+
+    def headless_protocol
+      "http"
+    end
+  end
+end

data/lib/headless/rails.rb

@@ -0,0 +1,19 @@
+require "headless/rails/version"
+require "headless/rails/escaped_fragment_extractor"
+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 = EscapedFragmentExtractor.call(request)
+        crawled = ::Headless::APIClient.crawl(url)
+        render text: crawled.content
+      end
+    end
+
+  end
+end

data/lib/headless/rails/escaped_fragment_extractor.rb

@@ -0,0 +1,55 @@
+require 'rack/utils'
+
+module Headless
+  module Rails
+    class EscapedFragmentExtractor < 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
+      end
+
+      private
+
+      def protocol
+        request.protocol
+      end
+
+      def host_with_port
+        request.host_with_port
+      end
+
+      def path
+        request.path
+      end
+
+      def hash_string
+        escaped_fragment
+      end
+
+      def escaped_fragment
+        request.GET[escaped_fragment_key]
+      end
+
+      def params_without_fragment
+        without = request.GET.dup
+        without.delete(escaped_fragment_key)
+        without
+      end
+
+      def escaped_fragment_key
+        ::Headless::Rails::ESCAPED_FRAGMENT_KEY
+      end
+
+      def query_string
+        ::Rack::Utils.build_query(params_without_fragment)
+      end
+    end
+  end
+end

data/lib/headless/rails/version.rb

@@ -0,0 +1,5 @@
+module Headless
+  module Rails
+    VERSION = "0.0.1"
+  end
+end

data/spec/headless/api_client_spec.rb

@@ -0,0 +1,16 @@
+require "spec_helper"
+
+RSpec.describe Headless::APIClient do
+
+  subject do
+    Headless::APIClient
+  end
+
+  describe "crawl" do
+    it "returns a response" do
+      response = subject.crawl("http://matthewrudy.com")
+      expect(response.content).to include("Matthew Rudy Jacobs")
+    end
+  end
+
+end

data/spec/headless/rails/escaped_fragment_extractor_spec.rb

@@ -0,0 +1,38 @@
+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

data/spec/headless/rails_spec.rb

@@ -0,0 +1,55 @@
+require 'spec_helper'
+
+RSpec.describe Headless::Rails do
+  it 'should have a version number' do
+    Headless::Rails::VERSION.should_not be_nil
+  end
+
+  let(:controller) do
+    double(:controller,
+      :request => request,
+      :params => {},
+      :render => nil,
+    )
+  end
+
+  let(:request) { double(:request) }
+  let(:headless_response)  { double(:headless_response, :content => :headless_content) }
+
+  describe "respond_to_ajax_crawlers" do
+    before do
+      controller.extend(Headless::Rails)
+    end
+
+    context "with no escaped_fragment" do
+      before do
+        controller.stub(:params).and_return({})
+      end
+
+      it "doesn't call render" do
+        expect(controller).to_not receive(:render)
+
+        controller.respond_to_ajax_crawlers
+      end
+
+      it "returns nil" do
+        value = controller.respond_to_ajax_crawlers
+        expect(value).to be_nil
+      end
+    end
+
+    context "with an escaped fragment" do
+      before do
+        controller.stub(:params).and_return({"_escaped_fragment_" => "something"})
+      end
+
+      it "extracts the fragment, fetches content from the api, and renders its" do
+        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)
+        expect(controller).to receive(:render).with(:text => :headless_content)
+
+        controller.respond_to_ajax_crawlers
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,2 @@
+$LOAD_PATH.unshift File.expand_path('../../lib', __FILE__)
+require 'headless/rails'

metadata

@@ -0,0 +1,148 @@
+--- !ruby/object:Gem::Specification
+name: headless-rails
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Matthew Rudy Jacobs
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-08-11 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rest-client
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.6.7
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.6.7
+- !ruby/object:Gem::Dependency
+  name: json
+  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: rack
+  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.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !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: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: ' Seamlessly integrate headlessapp.com into your Rails application '
+email:
+- MatthewRudyJacobs@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- .travis.yml
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- headless-rails.gemspec
+- lib/headless/api_client.rb
+- lib/headless/rails.rb
+- lib/headless/rails/escaped_fragment_extractor.rb
+- lib/headless/rails/version.rb
+- spec/headless/api_client_spec.rb
+- spec/headless/rails/escaped_fragment_extractor_spec.rb
+- spec/headless/rails_spec.rb
+- spec/spec_helper.rb
+homepage: http://www.headlessapp.com
+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: API wrapper for the HeadlessApp.com
+test_files:
+- spec/headless/api_client_spec.rb
+- spec/headless/rails/escaped_fragment_extractor_spec.rb
+- spec/headless/rails_spec.rb
+- spec/spec_helper.rb