selenium_standalone_dsl 0.1.2 → 0.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e3693c0d5500983b794af7fdf98364312dad7641
-  data.tar.gz: f2c0ededad165e7f43ab72be4fe8f0503d7c2c45
+  metadata.gz: e5ca3a0d39428672502c8d0731e8732b129489bc
+  data.tar.gz: 6d0dbb1640ca9c44e908d576d19c4333c186157c
 SHA512:
-  metadata.gz: 0f62c910a6fc5d0ce9c95729b34bb512dfe79952f04493100354a825fd136d2655d197ca349313e6f2e3d66154298ef96523fec4c71ade5961953b37c5bd1738
-  data.tar.gz: f48cc8dd3eb385b692b0f99b0cce5a617830f379ece17b1c441a6f0e75c984cb7d2813ae748b4573930c7c36d475f5a7acab72049373cd23266a11aacb98a6a5
+  metadata.gz: a61ddd3963efa378873a5251bdaf75020ef3c3e5e3dd95963a947df25c6acdab595cdc903f57e1a87ccc84ab7ce6878eac7841cdc674eb2b723f4429b6c46379
+  data.tar.gz: 2128b1811e1e2bf2fd1dff2f257bc7618756259a15072ff82e50d4582376d870c09dd847e3e424207e9538bad26afd4b7d4d3960a4fff81f235b786ff2fb561a

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    selenium_standalone_dsl (0.1.2)
+    selenium_standalone_dsl (0.1.3)
       headless
       nokogiri
       selenium-webdriver

data/README.md

@@ -1,9 +1,14 @@
 [![Gem Version](https://badge.fury.io/rb/selenium_standalone_dsl.svg)](https://badge.fury.io/rb/selenium_standalone_dsl)
+[![Build Status](https://travis-ci.org/acro5piano/selenium_standalone_dsl.svg?branch=master)](https://travis-ci.org/acro5piano/selenium_standalone_dsl)
 
 # Selenium Standalone DSL
 
 Gem for using Selenium webdriver simply.
 
+Let's scrape sites using JavaScript and iframe!
+
+This project aims to expanding Selenium and Nokogiri.
+
 ## Installation
 
 Ensure you have already installed Firefox:
@@ -39,7 +44,9 @@ gem install selenium_standalone_dsl
 ## Usage
 
 ```rb
-class YahooSearcher < SeleniumStandaloneDsl::Base
+require 'selenium_standalone_dsl'
+
+class YahooSearcher < SeleniumStandaloneDSL::Base
   def search_for_wikipedia
     visit 'https://www.yahoo.com/'
     fill_in 'p', with: 'wikipedia'
@@ -70,6 +77,23 @@ driver.search_for_wikipedia
 
 ```
 
+
+## Supported API
+
+| Method   | Summary                           | Arguments                | Remarks                        |
+|----------|-----------------------------------|--------------------------|--------------------------------|
+| click    | Click a button or link            | text of link, name, etc. |                                |
+| select   | Choose an option in select box    | option text              |                                |
+| visit    | Navigate firefox to a link        | link url                 |                                |
+| fill\_in | Fill in a input box               | element name             |                                |
+| search   | Search page source using Nokogiri |                          | Returns Nokogiri::XML::Element |
+
+### Options
+
+| Name      | Arguments                                     | Defalut     |
+|-----------|-----------------------------------------------|-------------|
+| :find\_by | :link\_text, :name, :id, :class, :css, :xpath | :link\_text |
+
 ## Development
 
 ```sh
@@ -79,7 +103,7 @@ bundle install --path vendor/bundle
 bundle exec rake install
 bundle exec rake spec
 ```
-    
+
 To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
 
 ## Roadmap
@@ -94,7 +118,7 @@ In my heart, `Selenium Spider` will have these features:
 
 ### Full JavaScript support
 
-Based on Selenium Standalone DSL, it comprehences JavaScript.
+Based on Selenium Standalone DSL which run Firefox headlessly, it comprehences JavaScript completely.
 
 ### PMC architecture
 
@@ -106,19 +130,21 @@ In PMC architecture, Page is for listing items and pagenation.
 
 Model is for extracting information from detail page and store data to database.
 
-Controller is for handle the above two.
+Controller is for handling the above two.
 
 ### Web-based task execution
 
 Scraping tasks are often multiply and difficult to arrange.
 
-Imagine Web-based task execution, definition, and scheduling like Jenkins.
+Imagine Web-based task execution, definition, csv-export and scheduling like Jenkins.
 
 ## TODO
 
-- [ ] Fix class name. Dsl => DSL
-- [ ] Log and config
-- [ ] TravisCI
+- [x] Fix module name. Dsl => DSL
+- [x] Defalut config
+- [x] Add API document
+- [x] TravisCI
+- [ ] Log
 
 ## Contributing
 

data/{demo.rb → examples/yahoo_searcher.rb}

@@ -1,7 +1,7 @@
 require 'bundler/setup'
 require 'selenium_standalone_dsl'
 
-class YahooSearcher < SeleniumStandaloneDsl::Base
+class YahooSearcher < SeleniumStandaloneDSL::Base
   def search_for_wikipedia
     visit 'https://www.yahoo.com/'
     fill_in 'p', with: 'wikipedia'

data/lib/selenium_standalone_dsl/base.rb

@@ -1,16 +1,13 @@
-module SeleniumStandaloneDsl
+module SeleniumStandaloneDSL
   class Base
     attr_reader :driver
 
-    # @param  Hash config
-    #         config = {
-    #             log_path: '/path/to/logs',
-    #             user_agent: 'Mozilla/5.0 (Windows NT 6.1) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/51.0.2704.84 Safari/537.36',
-    #         }
-    def initialize(config)
-      # Initialize instance variables
-      @config = config
-      @logger = Logger.new(@config[:log_path])
+    def initialize(log_path: '/tmp/selenium_standalone_dsl',
+                   user_agent: 'Selenium Standalone DSL', headless: false)
+
+      if headless
+        Headless.new(reuse: false, destroy_at_exit: true).start
+      end
 
       # Extends timeout
       client = Selenium::WebDriver::Remote::Http::Default.new
@@ -18,17 +15,13 @@ module SeleniumStandaloneDsl
 
       # Create profile so that each driver instance has its own cookie
       profile = Selenium::WebDriver::Firefox::Profile.new
-      profile['general.useragent.override'] = @config[:user_agent]
+      profile['general.useragent.override'] = user_agent
       profile.native_events = true
 
-      if @config[:headless]
-        headless = Headless.new(reuse: false, destroy_at_exit: true)
-        headless.start
-      end
-
       @driver = Selenium::WebDriver::Driver.for(:firefox, :http_client => client, :profile => profile)
 
-      @logger.info '=' * 150
+      @logger = Logger.new(log_path)
+      @logger.info '=' * 100
       @logger.info 'SeleniumStandaloneDsl started'
     end
 
@@ -116,10 +109,6 @@ module SeleniumStandaloneDsl
 
     def quit
       @driver.quit
-      if @config[:headless]
-        headless = Headless.new(reuse: false, destroy_at_exit: true)
-        headless.start
-      end
     end
   end
 end

data/lib/selenium_standalone_dsl/version.rb

@@ -1,3 +1,3 @@
-module SeleniumStandaloneDsl
-  VERSION = "0.1.2"
+module SeleniumStandaloneDSL
+  VERSION = "0.1.3"
 end

data/lib/selenium_standalone_dsl.rb

@@ -6,6 +6,6 @@ require 'nokogiri'
 require 'headless'
 
 
-module SeleniumStandaloneDsl
+module SeleniumStandaloneDSL
   ROOT_DIR = File.dirname(ENV['BUNDLE_GEMFILE']) || File.expand_path('../../', __FILE__)
 end

data/selenium_standalone_dsl.gemspec

@@ -5,7 +5,7 @@ require 'selenium_standalone_dsl/version'
 
 Gem::Specification.new do |spec|
   spec.name          = "selenium_standalone_dsl"
-  spec.version       = SeleniumStandaloneDsl::VERSION
+  spec.version       = SeleniumStandaloneDSL::VERSION
   spec.authors       = ["gosho-kazuya"]
   spec.email         = ["ketsume0211@gmail.com"]
 
@@ -27,9 +27,9 @@ Gem::Specification.new do |spec|
   spec.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
   spec.require_paths = ["lib"]
 
-  spec.add_dependency 'selenium-webdriver'
-  spec.add_dependency 'nokogiri'
-  spec.add_dependency 'headless'
+  spec.add_runtime_dependency 'selenium-webdriver'
+  spec.add_runtime_dependency 'nokogiri'
+  spec.add_runtime_dependency 'headless'
 
   spec.add_development_dependency "bundler", "~> 1.12"
   spec.add_development_dependency "rake", "~> 10.0"

data/spec/base_spec.rb

@@ -0,0 +1,60 @@
+require 'spec_helper'
+
+describe SeleniumStandaloneDSL::Base do
+  before :all do
+    @pid = Process.spawn('bundle e ruby spec/fixtures/app.rb')
+
+    config = {
+      log_path: '/tmp/selenium_standalone_dsl.log',
+      user_agent: 'Mozilla/5.0 (Windows NT 6.1) AppleWebKit/537.36 ' +
+                  '(KHTML, like Gecko) Chrome/51.0.2704.84 Safari/537.36',
+      headless: true,
+    }
+    @driver = SeleniumStandaloneDSL::Base.new(config)
+  end
+
+  after :all do
+    @driver.quit
+    Process.kill 9, @pid
+  end
+
+  it 'visit a site' do
+    expect { @driver.visit('http://localhost:4567') }.not_to raise_error
+  end
+
+  it 'click a link and follow href' do
+    @driver.visit 'http://localhost:4567/click'
+    expect { @driver.click('ClickMe') }.not_to raise_error
+    expect(@driver.driver.current_url).to eq 'http://localhost:4567/'
+  end
+
+  it 'fill_in a input box' do
+    @driver.visit 'http://localhost:4567/fill_in'
+    expect { @driver.fill_in('input_box', with: 'hoge') }.not_to raise_error
+  end
+
+  it 'close alert' do
+    @driver.visit 'http://localhost:4567/alert'
+    expect { @driver.prompt_ok }.not_to raise_error
+  end
+
+  it 'select a value in a select box' do
+    @driver.visit 'http://localhost:4567/select'
+    expect { @driver.select('an option', from: 'select_box') }.not_to raise_error
+    expect { @driver.select('an option', from: 'select_box', find_by: :name) }.not_to raise_error
+  end
+
+  it 'determine if the page has the text' do
+    @driver.visit 'http://localhost:4567/'
+    expect(@driver.has_element?(:text, 'Hello')).to be true
+    expect(@driver.has_element?(:text, 'Hogehogehoge')).to be false
+    expect(@driver.has_element?(:class, 'title')).to be true
+    expect(@driver.has_element?(:class, 'titleIsNotBlank')).to be false
+  end
+
+  it 'search with Nokogiri' do
+    @driver.visit 'http://localhost:4567/search'
+    expect(@driver.search('th:contains("title") + td').inner_html).to eq 'Hello'
+  end
+end
+

data/spec/selenium_standalone_dsl_spec.rb

@@ -1,64 +1,7 @@
 require 'spec_helper'
 
-describe SeleniumStandaloneDsl do
+describe SeleniumStandaloneDSL do
   it 'has a version number' do
-    expect(SeleniumStandaloneDsl::VERSION).not_to be nil
-  end
-
-  describe SeleniumStandaloneDsl::Base do
-    before :all do
-      @pid = Process.spawn('bundle e ruby spec/fixtures/app.rb')
-
-      config = {
-          log_path: '/tmp/selenium_standalone_dsl_spec.log',
-          user_agent: 'Mozilla/5.0 (Windows NT 6.1) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/51.0.2704.84 Safari/537.36',
-          headless: true,
-      }
-      @driver = SeleniumStandaloneDsl::Base.new(config)
-    end
-
-    after :all do
-      @driver.quit
-      Process.kill 9, @pid
-    end
-
-    it 'visit a site' do
-      expect { @driver.visit('http://localhost:4567') }.not_to raise_error
-    end
-
-    it 'click a link and follow href' do
-      @driver.visit 'http://localhost:4567/click'
-      expect { @driver.click('ClickMe') }.not_to raise_error
-      expect(@driver.driver.current_url).to eq 'http://localhost:4567/'
-    end
-
-    it 'fill_in a input box' do
-      @driver.visit 'http://localhost:4567/fill_in'
-      expect { @driver.fill_in('input_box', with: 'hoge') }.not_to raise_error
-    end
-
-    it 'close alert' do
-      @driver.visit 'http://localhost:4567/alert'
-      expect { @driver.prompt_ok }.not_to raise_error
-    end
-
-    it 'select a value in a select box' do
-      @driver.visit 'http://localhost:4567/select'
-      expect { @driver.select('an option', from: 'select_box') }.not_to raise_error
-      expect { @driver.select('an option', from: 'select_box', find_by: :name) }.not_to raise_error
-    end
-
-    it 'determine if the page has the text' do
-      @driver.visit 'http://localhost:4567/'
-      expect(@driver.has_element?(:text, 'Hello')).to be true
-      expect(@driver.has_element?(:text, 'Hogehogehoge')).to be false
-      expect(@driver.has_element?(:class, 'title')).to be true
-      expect(@driver.has_element?(:class, 'titleIsNotBlank')).to be false
-    end
-
-    it 'search with Nokogiri' do
-      @driver.visit 'http://localhost:4567/search'
-      expect(@driver.search('th:contains("title") + td').inner_html).to eq 'Hello'
-    end
+    expect(SeleniumStandaloneDSL::VERSION).not_to be nil
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: selenium_standalone_dsl
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.1.3
 platform: ruby
 authors:
 - gosho-kazuya
@@ -137,11 +137,12 @@ files:
 - LICENSE
 - README.md
 - Rakefile
-- demo.rb
+- examples/yahoo_searcher.rb
 - lib/selenium_standalone_dsl.rb
 - lib/selenium_standalone_dsl/base.rb
 - lib/selenium_standalone_dsl/version.rb
 - selenium_standalone_dsl.gemspec
+- spec/base_spec.rb
 - spec/selenium_standalone_dsl_spec.rb
 homepage: https://github.com/acro5piano/selenium_standalone_dsl
 licenses:
@@ -168,4 +169,5 @@ signing_key:
 specification_version: 4
 summary: Gem for using Selenium webdriver simply
 test_files:
+- spec/base_spec.rb
 - spec/selenium_standalone_dsl_spec.rb