phantom_menace 0.0.1 → 0.0.2

data/.autotest

@@ -0,0 +1,7 @@
+require 'autotest/restart'
+
+Autotest.add_hook :initialize do |at|
+  at.add_mapping(/.*/) do |f, _|
+    at.files_matching(/.*.rb$/)
+  end
+end

data/CHANGELOG.md

@@ -0,0 +1,9 @@
+## 0.0.2 (2012-06-10)
+
+* Added Browser#find
+* Added Browser#render
+
+## 0.0.1 (2012-06-08)
+
+* First release
+* Browser has methods #find_all_links and #goto

data/README.md

@@ -1,4 +1,4 @@
-# phantom-menace
+# phantom_menace
 
 A real headless "browser." It uses phantomjs and provides an API like a
 real browser does. Much like poltergeist but decoupled from capybara.
@@ -11,7 +11,7 @@ It is perfect for scraping or doing any browser related tasks.
 ## Install
 
 ```sh
-gem install phantom-menace
+gem install phantom_menace
 ```
 
 ## Getting Started
@@ -43,3 +43,30 @@ When the server is running, run the example by doing.
 ```sh
 bundle exec ruby examples/simple.rb
 ```
+
+## Running The Tests
+
+Unfortunately, we still don't have an automated test suite to run the
+different services.
+
+We have to run three things.
+
+1. The `phantom_menace` binary
+
+```sh
+bundle exec ./bin/phantom_menace
+```
+
+2. The sinatra test server - This serves the files needed for the tests
+   instead of hitting third party sites. This ensures that we can run
+   the tests without internet.
+
+```sh
+bundle exec ruby ./spec/test_server/server.rb
+```
+
+3. Finally we can run the specs
+
+```sh
+bundle exec rake spec
+```

data/Rakefile

@@ -1,2 +1,9 @@
 #!/usr/bin/env rake
 require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+desc "Run all specs"
+RSpec::Core::RakeTask.new(:spec)
+
+desc "Default: run specs."
+task default: :spec

data/bin/phantom_menace.coffee

@@ -1,17 +1,6 @@
 USER_AGENT = 'Mozilla/5.0 (Windows; U; Windows NT 5.1; en-US) ' +
   'AppleWebKit/A.B (KHTML, like Gecko) Chrome/X.Y.Z.W Safari/A.B.'
 
-class Page
-  constructor: ->
-    @_loaded = false
-    @_page = require('webpage').create()
-
-  open: (url) ->
-    @_page.open url
-
-  isLoaded: ->
-    @_loaded
-
 class Browser
   constructor: ->
     # This is the response container
@@ -26,36 +15,32 @@ class Browser
   click: (left, top) ->
     @page.sendEvent left, top
 
-  find: (selector) ->
+  find: (data) ->
     console.log 'Finding it'
-
-    ret = @page.evaluate ->
+    onEvaluate = (eArgs) ->
       elements = []
-      jQuery('a').each (i, obj) ->
+      jQuery(eArgs.selector).each (i, obj) ->
         attrs = {}
         attrs[attr.name] = attr.value for attr in obj.attributes
-
         elements.push
           attrs: attrs
           text:  jQuery(obj).text()
           pos:   jQuery(obj).offset()
       elements
 
+    ret = @page.evaluate(onEvaluate, { selector: data.selector })
+
     @resp =
       success: true
       ret: ret
 
     @state = 'default'
 
-
-  findAll: ->
-    console.log 'Finding all'
-
   goforward: ->
     console.log 'Going forward a page'
 
-  goto: (url) ->
-    @page.open decodeURIComponent(url)
+  goto: (data) ->
+    @page.open decodeURIComponent(data.url)
 
   goback: ->
     this.goto @history.pop
@@ -66,8 +51,10 @@ class Browser
   reload: ->
     this.goto @history[@history.length - 1]
 
-  render: ->
-    @page.render()
+  render: (data) ->
+    @page.render(data.filename)
+    @resp = success: true
+    @state = 'default'
 
   content: ->
     @page.content
@@ -118,23 +105,21 @@ class Server
     @server.listen 8080, this._handleRequest
 
   _handleRequest: (req, res) =>
-    params = req.post
+    params = JSON.parse(req.post.payload)
 
     if @browser[params.command]
       @browser.runCommand(params.command, params.data)
       this._runLoop(req, res)
     else
       res.statusCode = 200
-      res.write JSON.stringify({
+      res.write JSON.stringify
         success: false
         message: "Command not found"
-      })
       res.close()
 
   _runLoop: (req, res) =>
     setTimeout =>
       console.log 'THE STATE: ' + @browser.state
-
       if @browser.state is 'loading'
         this._runLoop(req, res)
       else if @browser.state is 'default'

data/lib/phantom_menace/browser.rb

@@ -3,28 +3,65 @@ require "uri"
 require "json"
 
 module PhantomMenace
+  # PhantomMenace::Browser
+  #
+  # Creates a Browser that you can interact with. Exposes methods like
+  # how you would find a real browser.
+  #
+  # == Example
+  #
+  #   browser = PhantomMenace::Browser.new
+  #   browser.goto "http://facebook.com"
+  #
+  # Look at the API for more methods.
   class Browser
+    # Navigates to the specified URL.
     def goto(url)
       options = {
         command: "goto",
-        data: url
+        data: { url: url }
       }
       post(options)
     end
 
     def find_all_links
       options = {
-        command: "find"
+        command: "find",
+        data: { selector: "a" }
       }
       post(options)["ret"].map do |node|
         PhantomMenace::Element.new(node)
       end
     end
 
+    # Uses jQuery's selector method. `$(sel)`
+    def find(sel)
+      options = {
+        command: "find",
+        data: { selector: sel }
+      }
+      post(options)["ret"].map do |node|
+        PhantomMenace::Element.new(node)
+      end
+    end
+
+    # Renders the loaded page in the specified path,
+    # if path is not given, defaults to the current
+    # directory.
+    def render(filename = nil)
+      filename ||= File.expand_path("../", __FILE__) + "/screenshot.png"
+      options = {
+        command: "render",
+        data: { filename: filename }
+      }
+      post(options)
+    end
+
     private
 
     def post(options)
-      req = Net::HTTP.post_form(URI.parse(URL), options)
+      data = { payload: options.to_json }
+      req = Net::HTTP.post_form(URI.parse(URL), data)
       JSON.parse(req.body)
     end
   end

data/lib/phantom_menace/version.rb

@@ -1,3 +1,3 @@
 module PhantomMenace
-  VERSION = "0.0.1"
+  VERSION = "0.0.2"
 end

data/phantom_menace.gemspec

@@ -18,4 +18,6 @@ Gem::Specification.new do |gem|
   gem.add_development_dependency "rspec"
   gem.add_development_dependency "rake"
   gem.add_development_dependency "phantomjs.rb"
+  gem.add_development_dependency "ZenTest"
+  gem.add_development_dependency "sinatra"
 end

data/spec/browser_spec.rb

@@ -1,5 +1,7 @@
 require 'phantom_menace'
 
+TEST_URL = "http://localhost:4567/index.html"
+
 describe PhantomMenace::Browser do
   before do
     @browser = PhantomMenace::Browser.new
@@ -7,16 +9,38 @@ describe PhantomMenace::Browser do
 
   describe "#goto" do
     it "responds with success if page opens successfully" do
-      resp = @browser.goto "http://google.com"
+      resp = @browser.goto TEST_URL
       resp["success"].should == true
     end
   end
 
   describe "#find_all_links" do
     it "responds with the links in the page" do
-      @browser.goto "http://google.com"
+      @browser.goto TEST_URL
       resp = @browser.find_all_links
-      resp.length.should_not be(0)
+      resp.length.should_not == 0
+    end
+  end
+
+  describe "#find" do
+    it "responds with the element found" do
+      @browser.goto TEST_URL
+      resp = @browser.find('#first_div')
+      resp.length.should_not == 0
+    end
+
+    it "responds with a blank array if nothing found" do
+      @browser.goto TEST_URL
+      resp = @browser.find('.non-existing-class')
+      resp.should be_empty
+    end
+  end
+
+  describe "#render" do
+    it "saves the file in the path specified" do
+      @browser.goto TEST_URL
+      resp = @browser.render
+      resp["success"].should == true
     end
   end
 end

data/spec/test_server/README.md

@@ -0,0 +1,10 @@
+# Test Server
+
+The test server is a sinatra based server that serves static files
+needed by the tests.
+
+## Running
+
+```sh
+bundle exec ruby server.rb
+```

data/spec/test_server/public/index.html

@@ -0,0 +1,11 @@
+<!DOCTYPE html>
+<html>
+  <head>
+    <title>Hello World</title>
+  </head>
+  <body>
+    <h1>Hello World</h1>
+    <a href="/first_link_href.html">The First Text</a>
+    <div id="first_div">I am the first div</div>
+  </body>
+</html>

data/spec/test_server/server.rb

@@ -0,0 +1 @@
+require "sinatra"

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: phantom_menace
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-06-08 00:00:00.000000000 Z
+date: 2012-06-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
@@ -59,6 +59,38 @@ dependencies:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: ZenTest
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: sinatra
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 description: Ruby Wrapper for Phantomjs with a Browser API
 email:
 - william.estoque@gmail.com
@@ -69,7 +101,10 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
+- .autotest
 - .gitignore
+- .rspec
+- CHANGELOG.md
 - Gemfile
 - LICENSE
 - README.md
@@ -84,6 +119,9 @@ files:
 - lib/phantom_menace/version.rb
 - phantom_menace.gemspec
 - spec/browser_spec.rb
+- spec/test_server/README.md
+- spec/test_server/public/index.html
+- spec/test_server/server.rb
 homepage: ''
 licenses: []
 post_install_message: 
@@ -96,18 +134,12 @@ required_ruby_version: !ruby/object:Gem::Requirement
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
-      segments:
-      - 0
-      hash: -1323133816147866598
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
-      segments:
-      - 0
-      hash: -1323133816147866598
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.24
@@ -116,3 +148,6 @@ specification_version: 3
 summary: Phantomjs based browser with a ruby wrapper
 test_files:
 - spec/browser_spec.rb
+- spec/test_server/README.md
+- spec/test_server/public/index.html
+- spec/test_server/server.rb