spiderable 0.0.1

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 spiderable.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Nisarg Shah
+
+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,35 @@
+# Spiderable
+
+Adds support for rails applications. (Visit http://www.spiderable.org if you don't have an account)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'spiderable'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install spiderable
+
+## Usage
+
+Add a configuration file (config/spiderable.rb):
+
+    Spiderable::Config.token = '[YOUR TOKEN]'
+
+Thats it! To test it out, visit a url with ?_escaped_fragment_= at the end. 
+
+    http://mysite.com?_escaped_fragment_=
+
+## 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 @@
+require "bundler/gem_tasks"

data/lib/spiderable/config.rb

@@ -0,0 +1,11 @@
+module Spiderable
+  module Config
+    attr_accessor :token
+
+    extend self
+
+    def map
+      yield self
+    end
+  end
+end

data/lib/spiderable/connect.rb

@@ -0,0 +1,16 @@
+module Spiderable
+  module Connect
+    BASE_URL = 'http://www.spiderable.org'
+    
+    def self.get_url_contents(url)
+      contents = Faraday.get("#{BASE_URL}/api/v1/pages.json?url=#{url}&token=#{Config.token}")
+
+      if contents.status == 200
+        JSON.parse(contents.body)['contents']
+      else
+        contents.body
+      end
+    end
+
+  end
+end

data/lib/spiderable/railtie/engine.rb

@@ -0,0 +1,17 @@
+require 'spiderable/railtie/middleware'
+
+module Hashbang
+  module Railtie
+    class Engine < Rails::Engine
+      initializer "application_controller.initialize_spiderable" do |app|
+        if ['development', 'production'].include?(Rails.env)
+          app.config.middleware.use "Spiderable::Railtie::Middleware"
+        end
+      end
+
+      rake_tasks do
+        Dir[File.expand_path('../../tasks/*.rake',  __FILE__)].each { |f| load f }
+      end
+    end
+  end
+end

data/lib/spiderable/railtie/middleware.rb

@@ -0,0 +1,42 @@
+module Spiderable
+  module Crawler
+    extend self
+
+    def urlFromRack(environment)
+      url = []
+      url << environment['rack.url_scheme'] + '://'
+      url << environment['HTTP_HOST']
+      url << environment['REQUEST_PATH']
+      url << '?' unless environment['QUERY_STRING'].starts_with? '_escaped_fragment_'
+      url << environment['QUERY_STRING'].gsub(/(\&)?_escaped_fragment_=/, '')
+
+      url.join ''
+    end
+
+    def urlFromUrl(url)
+      url.gsub(/[\?\&]_escaped_fragment_=/, '')
+    end
+  end
+
+  module Railtie
+    class Middleware
+      def initialize(application)
+        @application = application
+      end
+
+      def call(environment)
+        is_bot = environment["HTTP_USER_AGENT"].match(/\(.*https?:\/\/.*\)/) ||
+                  environment['QUERY_STRING'].include?("_escaped_fragment_")
+
+        if is_bot
+          url  = Crawler.urlFromRack(environment)
+          html = Connect.get_url_contents(url)
+
+          [200, {"Content-Type" => "text/html; charset=utf-8"}, [html]]
+        else
+          @application.call(environment)
+        end
+      end
+    end
+  end
+end

data/lib/spiderable/version.rb

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

data/lib/spiderable.rb

@@ -0,0 +1,5 @@
+require "spiderable/version"
+require "faraday"
+require "spiderable/config"
+require "spiderable/connect"
+require 'spiderable/railtie/engine' if defined? Rails

data/spiderable.gemspec

@@ -0,0 +1,21 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'spiderable/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = "spiderable"
+  gem.version       = Spiderable::VERSION
+  gem.authors       = ["Spiderable"]
+  gem.email         = ["hello@spiderable.org"]
+  gem.description   = %q{Allows your rails application to be spiderable by crawlers}
+  gem.summary       = %q{Allows your rails application to be spiderable by crawlers}
+  gem.homepage      = "http://www.spiderable.org"
+
+  gem.files         = `git ls-files`.split($/)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.require_paths = ["lib"]
+
+  gem.add_runtime_dependency 'faraday'
+end

metadata

@@ -0,0 +1,73 @@
+--- !ruby/object:Gem::Specification
+name: spiderable
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Spiderable
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-04-06 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Allows your rails application to be spiderable by crawlers
+email:
+- hello@spiderable.org
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/spiderable.rb
+- lib/spiderable/config.rb
+- lib/spiderable/connect.rb
+- lib/spiderable/railtie/engine.rb
+- lib/spiderable/railtie/middleware.rb
+- lib/spiderable/version.rb
+- spiderable.gemspec
+homepage: http://www.spiderable.org
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: Allows your rails application to be spiderable by crawlers
+test_files: []