domreactor-redglass 0.0.5 → 0.0.6

data/.ruby-version

@@ -0,0 +1 @@
+1.9.3-p448

data/README.md

@@ -31,7 +31,7 @@ end
 
 # Send the page archives to DomReactor.
 DomReactorRedGlass.auth_token = '12345'
-DomReactorRedGlass.create_chain_reaction(page_url, "#{archive_location}/#{test_id}", opts)
+DomReactorRedGlass.create_chain_reaction("#{archive_location}/#{test_id}", opts)
 ```
 
 # License

data/domreactor-redglass.gemspec

@@ -6,7 +6,7 @@ require 'domreactor-redglass/version'
 Gem::Specification.new do |s|
   s.name          = 'domreactor-redglass'
   s.version       = DomReactorRedGlass::VERSION
-  s.date          = '2013-10-31'
+  s.date          = '2013-11-14'
   s.summary       = 'DomReactor plugin for RedGlass.'
   s.description   = 'Send RedGlass page archives to DomReactor for automated layout analysis.'
   s.authors       = ["Frank O'Hara", "Chris Lamb"]

data/example/domreactor_example.rb

@@ -24,4 +24,4 @@ end
 
 # Send the page archives to DomReactor.
 DomReactorRedGlass.auth_token = '12345'
-DomReactorRedGlass.create_chain_reaction('http://google.com', "#{archive_location}/#{test_id}", opts)
+DomReactorRedGlass.create_chain_reaction("#{archive_location}/#{test_id}", opts)

data/lib/domreactor-redglass/archive.rb

@@ -0,0 +1,50 @@
+class Archive
+  attr_reader :path, :opts
+
+  REQUIRED_ARCHIVE_FILES = %w(dom.json metadata.json screenshot.png source.html)
+
+  def initialize(path, opts={})
+    @path = path
+    @opts = opts
+  end
+
+  def meta_data
+    @meta_data = parse_json_file("#{path}/metadata.json")
+  end
+
+  def browser
+    meta_data[:browser]
+  end
+
+  def page_url
+    meta_data[:page_url]
+  end
+
+  def dom_elements
+    @dom_elements ||= File.open("#{path}/dom.json", 'rb') {|f| f.read}
+  end
+
+  def page_source
+    @page_source ||= File.open("#{path}/source.html") {|f| f.read}
+  end
+
+  def screenshot
+    @file ||= File.open("#{path}/screenshot.png")
+  end
+
+  def self.is_valid_page_archive?(file)
+    is_valid = false
+    if File.directory? file
+      dir_files = Dir.entries(file).delete_if {|name| name == '.' || name == '..'}
+      is_valid = dir_files.sort == REQUIRED_ARCHIVE_FILES.sort
+    end
+    is_valid
+  end
+
+  private
+
+  def parse_json_file(path)
+    json_str = File.open(path, 'rb') {|f| f.read}
+    JSON.parse(json_str, symbolize_names: true)
+  end
+end

data/lib/domreactor-redglass/archive_location.rb

@@ -0,0 +1,82 @@
+class ArchiveLocation
+  attr_reader :location, :opts
+
+  REQUIRED_BASELINE_BROWSER_CONFIG_KEYS = [:name, :version, :platform]
+
+  def initialize(location, opts={})
+    @location = location
+    @opts = opts
+  end
+
+  def archives
+    @archives ||= archive_list(location)
+  end
+
+  def validate!
+    detect_archive_location
+    detect_min_archive_quota
+    detect_baseline_browser
+  end
+
+  def detect_archive_location
+    unless File.directory?(location)
+      raise 'A valid archive location is required.'
+    end
+  end
+
+  def detect_min_archive_quota
+    raise 'At least two valid page archives are required.' unless sum_archive_count(location) >= 2
+  end
+
+  def detect_baseline_browser
+    unless opts[:baseline_browser] && is_valid_baseline_browser_config?(opts[:baseline_browser])
+      raise 'A valid baseline_browser configuration is required.'
+    end
+    unless has_baseline_archive?(location, opts)
+      raise 'A page archive that corresponds to the baseline browser configuration is required.'
+    end
+  end
+
+  def is_valid_baseline_browser_config?(baseline_browser_config)
+    baseline_browser_config.keys.sort == REQUIRED_BASELINE_BROWSER_CONFIG_KEYS.sort
+  end
+
+
+  private
+
+  def has_baseline_archive?(archive_location, config)
+    found_archive = false
+    Dir.foreach(archive_location) do |file|
+      next if file == '.' or file == '..'
+      path = "#{archive_location}/#{file}"
+      if Archive.is_valid_page_archive?(path)
+        if Archive.new(path).browser == config[:baseline_browser]
+          found_archive = true
+          break
+        end
+      end
+    end
+    found_archive
+  end
+
+  def sum_archive_count(archive_location)
+    archive_count = 0
+    Dir.foreach(archive_location) do |file|
+      next if file == '.' or file == '..'
+      archive_count += 1 if Archive.is_valid_page_archive?("#{archive_location}/#{file}")
+    end
+    archive_count
+  end
+
+  def archive_list(archive_location)
+    list = []
+    Dir.foreach(archive_location) do |file|
+      next if file == '.' or file == '..'
+      path = "#{archive_location}/#{file}"
+      if Archive.is_valid_page_archive? path
+        list << Archive.new(path)
+      end
+    end
+    list
+  end
+end

data/lib/domreactor-redglass/chain_reaction.rb

@@ -3,10 +3,9 @@ require 'rest-client'
 
 module DomReactorRedGlass
   class ChainReaction
-    attr_reader :id, :info, :page_url
+    attr_reader :id, :info
 
-    def initialize(page_url, opts)
-      @page_url = page_url
+    def initialize(opts)
       @opts = opts
       @info = info
     end
@@ -33,13 +32,9 @@ module DomReactorRedGlass
 
 
     def post_archives(archive_location)
-      Dir.foreach(archive_location) do |file|
-        next if file == '.' or file == '..'
-        path = "#{archive_location}/#{file}"
-        if is_valid_page_archive? path
-          payload = create_payload(path)
-          create_dom_gun_reaction(payload)
-        end
+      archive_location.archives.each do |archive|
+        payload = create_payload(archive)
+        create_dom_gun_reaction(payload)
       end
       start_reaction
     end
@@ -85,16 +80,15 @@ module DomReactorRedGlass
       JSON.parse(response, symbolize_names: true)[:chain_reaction]
     end
 
-    def create_payload(path)
-      meta_data = parse_json_file("#{path}/metadata.json")
+    def create_payload(archive)
       {
         auth_token: auth_token,
-        meta_data: meta_data,
-        web_browser_id: get_web_browser_info(meta_data[:browser])[:id],
-        page_url: meta_data[:page_url],
-        dom_elements: File.open("#{path}/dom.json", 'rb') {|f| f.read},
-        page_source: File.open("#{path}/source.html") {|f| f.read},
-        file: File.open("#{path}/screenshot.png")
+        meta_data: archive.meta_data,
+        web_browser_id: get_web_browser_info(archive.browser)[:id],
+        page_url: archive.page_url,
+        dom_elements: archive.dom_elements,
+        page_source: archive.page_source,
+        file: archive.screenshot
       }
     end
   end

data/lib/domreactor-redglass/config.rb

@@ -1,7 +1,6 @@
 module DomReactorRedGlass
   class Config
-    #DOMREACTOR_INIT_CHAIN_REACTION_URL = 'http://domreactor.com'
-    DOMREACTOR_INIT_CHAIN_REACTION_URL = 'http://localhost:3000'
+    DOMREACTOR_INIT_CHAIN_REACTION_URL = 'http://www.domreactor.com'
 
     class << self
       def url

data/lib/domreactor-redglass/version.rb

@@ -1,3 +1,3 @@
 module DomReactorRedGlass
-  VERSION = "0.0.5"
+  VERSION = "0.0.6"
 end

data/lib/domreactor-redglass.rb

@@ -1,12 +1,11 @@
 require 'domreactor-redglass/chain_reaction'
+require 'domreactor-redglass/archive'
+require 'domreactor-redglass/archive_location'
 require 'domreactor-redglass/config'
 require 'domreactor-redglass/version'
 
 module DomReactorRedGlass
 
-  REQUIRED_ARCHIVE_FILES = %w(dom.json metadata.json screenshot.png source.html)
-  REQUIRED_BASELINE_BROWSER_CONFIG_KEYS = [:name, :version, :platform]
-
   def auth_token=(auth_token)
     Config.auth_token=auth_token
   end
@@ -15,82 +14,13 @@ module DomReactorRedGlass
     Config.auth_token
   end
 
-  def create_chain_reaction(page_url, archive_location, opts)
-    detect_archive_location archive_location
-    detect_min_archive_quota archive_location
-    detect_baseline_browser archive_location, opts
-    @chain_reaction = ChainReaction.new(page_url, opts)
+  def create_chain_reaction(archive_location, opts)
+    archive_location = ArchiveLocation.new(archive_location, opts)
+    archive_location.validate!
+    @chain_reaction = ChainReaction.new(opts)
     @chain_reaction.post_archives(archive_location)
   end
 
-  def detect_archive_location(archive_location)
-    unless File.directory?(archive_location)
-      raise 'A valid archive location is required.'
-    end
-  end
-
-  def detect_min_archive_quota(archive_location)
-    raise 'At least two valid page archives are required.' unless sum_archive_count(archive_location) >= 2
-  end
-
-  def sum_archive_count(archive_location)
-    archive_count = 0
-    Dir.foreach(archive_location) do |file|
-      next if file == '.' or file == '..'
-      archive_count += 1 if is_valid_page_archive? "#{archive_location}/#{file}"
-    end
-    archive_count
-  end
-
-  def is_valid_page_archive?(file)
-    is_valid = false
-    if File.directory? file
-      dir_files = Dir.entries(file).delete_if {|name| name == '.' || name == '..'}
-      is_valid = true if dir_files == REQUIRED_ARCHIVE_FILES
-    end
-    is_valid
-  end
-
-  def detect_baseline_browser(archive_location, config)
-    unless config[:baseline_browser] && is_valid_baseline_browser_config?(config[:baseline_browser])
-      raise 'A valid baseline_browser configuration is required.'
-    end
-    unless has_baseline_archive?(archive_location, config)
-      raise 'A page archive that corresponds to the baseline browser configuration is required.'
-    end
-  end
-
-  def is_valid_baseline_browser_config?(baseline_browser_config)
-    baseline_browser_config.keys == REQUIRED_BASELINE_BROWSER_CONFIG_KEYS
-  end
-
-  def has_baseline_archive?(archive_location, config)
-    found_archive = false
-    Dir.foreach(archive_location) do |file|
-      next if file == '.' or file == '..'
-      path = "#{archive_location}/#{file}"
-      if is_valid_page_archive? path
-        if parse_json_file("#{path}/metadata.json")[:browser] == config[:baseline_browser]
-          found_archive = true
-          break
-        end
-      end
-    end
-    found_archive
-  end
-
-  def archive_metadata(archive_location)
-    metadata = []
-    Dir.foreach(archive_location) do |file|
-      next if file == '.' or file == '..'
-      path = "#{archive_location}/#{file}"
-      if is_valid_page_archive? path
-        metadata << parse_json_file("#{path}/metadata.json")
-      end
-    end
-    metadata
-  end
-
   def parse_json_file(path)
     json_str = File.open(path, 'rb') {|f| f.read}
     JSON.parse(json_str, symbolize_names: true)

data/spec/archive_location_spec.rb

@@ -0,0 +1,31 @@
+require 'spec_helper'
+
+describe ArchiveLocation do
+  describe '#detect_archive_location' do
+    it 'requires a valid archive location' do
+      expect { ArchiveLocation.new('/does_not_exist').detect_archive_location }
+      .to raise_error('A valid archive location is required.')
+    end
+  end
+  describe '#detect_min_archive_quota' do
+    it 'requires at last two valid page archives' do
+      expect { ArchiveLocation.new("#{SPEC_ROOT}/data/invalid_archive_by_quota").detect_min_archive_quota }
+      .to raise_error('At least two valid page archives are required.')
+    end
+  end
+  describe '#detect_baseline_browser' do
+    it 'requires a baseline_browser config' do
+      expect { ArchiveLocation.new('', {}).detect_baseline_browser }
+      .to raise_error('A valid baseline_browser configuration is required.')
+    end
+    it 'requires a valid baseline_browser config' do
+      expect { ArchiveLocation.new('', {baseline_browser: {name: '', version: ''}}).detect_baseline_browser }
+      .to raise_error('A valid baseline_browser configuration is required.')
+    end
+    it 'requires a corresponding page archive' do
+      expect { ArchiveLocation.new("#{SPEC_ROOT}/data/valid_archive", {
+          baseline_browser: {name: 'mosaic', version: '1.0', platform: 'darwin'}}).detect_baseline_browser }
+      .to raise_error('A page archive that corresponds to the baseline browser configuration is required.')
+    end
+  end
+end

data/spec/archive_spec.rb

@@ -0,0 +1,27 @@
+require 'spec_helper'
+
+describe Archive do
+  subject { Archive.new("test") }
+  let(:meta_data) do
+    {
+      browser: 'firefox',
+      page_url: 'www.example.com',
+    }
+  end
+  before { File.stub(:open) { meta_data.to_json } }
+  describe "#meta_data" do
+    it "parses the metadata json" do
+      expect(subject.meta_data).to eq(meta_data)
+    end
+  end
+  describe "#browser" do
+    it "returns the browser from the meta data" do
+      subject.browser.should eq("firefox")
+    end
+  end
+  describe "#page_url" do
+    it "returns the page_url from the meta data" do
+      subject.page_url.should eq("www.example.com")
+    end
+  end
+end

data/spec/chain_reaction_spec.rb

@@ -1,7 +1,7 @@
 require 'spec_helper'
 
 describe DomReactorRedGlass::ChainReaction do
-  let(:chain_reaction) { DomReactorRedGlass::ChainReaction.new('http://domreactor.com', {}) }
+  let(:chain_reaction) { DomReactorRedGlass::ChainReaction.new({}) }
   before do
     #stub chain reaction creation call
     RestClient.stub(:post) { {chain_reaction: {id: 42, some_info: 'yay'}}.to_json }
@@ -26,7 +26,7 @@ describe DomReactorRedGlass::ChainReaction do
     before do
       chain_reaction.stub(:create_payload)
       chain_reaction.stub(:create_dom_gun_reaction)
-      chain_reaction.post_archives("#{SPEC_ROOT}/data/valid_archive")
+      chain_reaction.post_archives(ArchiveLocation.new("#{SPEC_ROOT}/data/valid_archive"))
     end
     it 'creates the payload' do
       expect(chain_reaction).to have_received(:create_payload).twice

data/spec/domreactor_spec.rb

@@ -3,33 +3,6 @@ require 'spec_helper'
 include DomReactorRedGlass
 
 describe DomReactorRedGlass do
-  describe '.detect_archive_location' do
-    it 'requires a valid archive location' do
-      expect { DomReactorRedGlass.detect_archive_location('/does_not_exist') }
-      .to raise_error('A valid archive location is required.')
-    end
-  end
-  describe '.detect_min_archive_quota' do
-    it 'requires at last two valid page archives' do
-      expect { DomReactorRedGlass.detect_min_archive_quota("#{SPEC_ROOT}/data/invalid_archive_by_quota") }
-      .to raise_error('At least two valid page archives are required.')
-    end
-  end
-  describe '.detect_baseline_browser' do
-    it 'requires a baseline_browser config' do
-      expect { DomReactorRedGlass.detect_baseline_browser('', {}) }
-      .to raise_error('A valid baseline_browser configuration is required.')
-    end
-    it 'requires a valid baseline_browser config' do
-      expect { DomReactorRedGlass.detect_baseline_browser('', {baseline_browser: {name: '', version: ''}}) }
-      .to raise_error('A valid baseline_browser configuration is required.')
-    end
-    it 'requires a corresponding page archive' do
-      expect { DomReactorRedGlass.detect_baseline_browser("#{SPEC_ROOT}/data/valid_archive", {
-          baseline_browser: {name: 'mosaic', version: '1.0', platform: 'darwin'}}) }
-      .to raise_error('A page archive that corresponds to the baseline browser configuration is required.')
-    end
-  end
   describe '.auth_token' do
     it "sets the auth token" do
       DomReactorRedGlass.auth_token = 'abc123'
@@ -39,7 +12,7 @@ describe DomReactorRedGlass do
 
   describe '.create_chain_reaction' do
     it 'requires a valid archive location' do
-      expect { DomReactorRedGlass.create_chain_reaction('some_url', '/does_not_exist', {})}
+      expect { DomReactorRedGlass.create_chain_reaction('/does_not_exist', {})}
       .to raise_error('A valid archive location is required.')
     end
   end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: domreactor-redglass
 version: !ruby/object:Gem::Version
-  version: 0.0.5
+  version: 0.0.6
   prerelease: 
 platform: ruby
 authors:
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-10-31 00:00:00.000000000 Z
+date: 2013-11-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rest-client
@@ -149,6 +149,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - .gitignore
+- .ruby-version
 - Gemfile
 - LICENSE
 - README.md
@@ -156,9 +157,13 @@ files:
 - domreactor-redglass.gemspec
 - example/domreactor_example.rb
 - lib/domreactor-redglass.rb
+- lib/domreactor-redglass/archive.rb
+- lib/domreactor-redglass/archive_location.rb
 - lib/domreactor-redglass/chain_reaction.rb
 - lib/domreactor-redglass/config.rb
 - lib/domreactor-redglass/version.rb
+- spec/archive_location_spec.rb
+- spec/archive_spec.rb
 - spec/chain_reaction_spec.rb
 - spec/data/invalid_archive_by_quota/firefox_20.0_1369614643/dom.json
 - spec/data/invalid_archive_by_quota/firefox_20.0_1369614643/metadata.json
@@ -195,11 +200,13 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.24
+rubygems_version: 1.8.23
 signing_key: 
 specification_version: 3
 summary: DomReactor plugin for RedGlass.
 test_files:
+- spec/archive_location_spec.rb
+- spec/archive_spec.rb
 - spec/chain_reaction_spec.rb
 - spec/data/invalid_archive_by_quota/firefox_20.0_1369614643/dom.json
 - spec/data/invalid_archive_by_quota/firefox_20.0_1369614643/metadata.json