yabbie 0.0.1 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 4b077117e7e234fc4ef117c47175007410dae56c
-  data.tar.gz: 9b15ca1f62cb27b3a1cc46b6ec852cd70af598f5
+  metadata.gz: 045f4caf54997ca331c1e5bd32c22987ce619283
+  data.tar.gz: fc9a0a723cdbbfd95cbff0b022bc266fc6819bae
 SHA512:
-  metadata.gz: 97192e23b459fe569616fba6fefbbc88680417fa566be0715871d59bc97f23925dd48750ef0476178dcd072e4fa10f3913acdbde067e3b01ba4f5c6540ec032d
-  data.tar.gz: b109aedaef19a8e8caf2d554484da9386de1628e4bc765efe988009d4994299822c710cec82d70018aa8abd4c28949caa7fd5120d82a1fb64b4f8a3f721178c1
+  metadata.gz: a97981fbdf90fe1944d80ea2eea26b3b1eed1e5aa94ade71d3e377d631ee1ffa6ba6c7d9d8f8a424a4635c8003ad79a04287b533653b25d67c2e6f20ac16e001
+  data.tar.gz: fc17735fedb7704d334923456a77ede6083a1bdbd4dbebf49fba579a81b04953b604e512cc7455fbf0694cf37ef3c8408ca0e8b6a650f62b77f8fe30c6a6b9fd

data/README.md

@@ -1,12 +1,12 @@
 # Yabbie
 
-TODO: Write a gem description
+Yabbie is a gem to wrap SlimerJS.
 
 ## Installation
 
 Add this line to your application's Gemfile:
 
-    gem 'yabbie'
+    gem 'yabbie', github: 'net-engine/yabbie'
 
 And then execute:
 
@@ -16,14 +16,35 @@ Or install it yourself as:
 
     $ gem install yabbie
 
+## Dependency
+
+It relies on [SlimerJS](http://slimerjs.org), and a script that contains what you want to achieve.
+For the script, you can check our [default.js](https://github.com/net-engine/yabbie/blob/master/lib/yabbie/default.js). It does nothing but takes a png snapshot. It is just so that Yabbie does not fail if you don't provide one. Please don't rely on it.
+
 ## Usage
 
-TODO: Write usage instructions here
+    Yabbie::Slimer.new(html_file, options).to_file(file)
+
+For more usage, please investigate in the code while we don't build a nice README
+
+## Roadmap
+
+1. Add tests, sorry for that. :)
+
+## And the oscar goes to...
+
+This gem is inspired on [Shrimp](https://github.com/adjust/shrimp) gem.
+
+A huge thanks to all Shrimp contributors.
 
 ## Contributing
 
-1. Fork it ( https://github.com/[my-github-username]/yabbie/fork )
+1. Fork it (https://github.com/net-engine/yabbie/fork)
 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 a new Pull Request
+
+## License
+
+MIT

data/lib/yabbie/config.json

@@ -0,0 +1,4 @@
+{
+  "loadImages": true
+}
+

data/lib/yabbie/configuration.rb

@@ -0,0 +1,44 @@
+require 'tmpdir'
+
+module Yabbie
+  class Configuration
+    attr_accessor :default_options
+
+    [:format, :tmpdir, :timeout, :config_file, :error_log_file, :width, :height, :prepend_command, :script].each do |m|
+      define_method("#{m}=") do |val|
+        @default_options[m] = val
+      end
+    end
+
+    def initialize
+      @default_options = {
+        format:          'png',
+        tmpdir:          Dir.tmpdir,
+        timeout:         120000,
+        config_file:     File.expand_path('../config.json', __FILE__),
+        width:           600,
+        height:          600,
+        error_log_file:  Dir.tmpdir + "/log/yabbie_error.log",
+        prepend_command: '',
+        script:          'default.js'
+      }
+    end
+
+    def slimerjs
+      @slimerjs ||= `which slimerjs`.chomp
+    end
+  end
+
+  class << self
+    attr_accessor :configuration
+  end
+
+  def self.configuration
+    @configuration ||= Configuration.new
+  end
+
+  def self.configure
+    yield(configuration)
+  end
+end
+

data/lib/yabbie/default.js

@@ -0,0 +1,13 @@
+var webpage = require('webpage'),
+    system  = require('system');
+
+var url = system.args[1];
+
+webpage.open(url)
+  .then(function() {
+    webpage.viewportSize = { width: 650, height: 320 };
+    webpage.render('page.png', { onlyViewport: true });
+
+    slimer.exit();
+  });
+

data/lib/yabbie/exceptions.rb

@@ -0,0 +1,22 @@
+module Yabbie
+  class NoExecutableError < StandardError
+    def initialize
+      msg = "No slimerjs executable found at #{Yabbie.configuration.slimerjs}\n"
+      msg << ">> Please install slimerjs"
+      super(msg)
+    end
+  end
+
+  class ImproperSourceError < StandardError
+    def initialize(msg = nil)
+      super("Improper Source: #{msg}")
+    end
+  end
+
+  class RenderingError < StandardError
+    def initialize(msg = nil)
+      super("Rendering Error: #{msg}")
+    end
+  end
+end
+

data/lib/yabbie/slimer.rb

@@ -0,0 +1,100 @@
+require 'shellwords'
+
+module Yabbie
+  class Slimer
+    attr_accessor :source, :configuration
+    attr_reader :options, :result, :error
+
+    def initialize(url_or_file, options = {})
+      @source  = Source.new(url_or_file)
+      @options = Yabbie.configuration.default_options.merge(options)
+
+      raise NoExecutableError.new unless File.exists?(Yabbie.configuration.slimerjs)
+    end
+
+    def run
+      @error  = nil
+      @result = `#{cmd}`
+
+      unless $?.exitstatus == 0
+        @error  = @result
+        @result = nil
+      end
+
+      @result
+    end
+
+    def cmd
+      [
+        prepend_command,
+        Yabbie.configuration.slimerjs,
+        command_config_file,
+        command_error_log,
+        script,
+        @source.to_s.shellescape,
+        outfile,
+        width,
+        height,
+        format,
+        timeout
+      ].join(" ").strip
+    end
+
+    def render(path = nil)
+      @outfile = File.expand_path(path) if path
+      self.run
+      @outfile
+    end
+
+    def to_file(path = nil)
+      self.render(path)
+      File.new(@outfile)
+    end
+
+    def to_string(path = nil)
+      File.open(self.render(path)).read
+    end
+
+    private
+
+    def format
+      options[:format]
+    end
+
+    def timeout
+      options[:timeout]
+    end
+
+    def width
+      options[:width]
+    end
+
+    def height
+      options[:height]
+    end
+
+    def script
+      options[:script]
+    end
+
+    def prepend_command
+      options[:prepend_command]
+    end
+
+    def command_config_file
+      "--config=#{options[:config_file]}"
+    end
+
+    def command_error_log
+      "--error-log-file=#{options[:error_log_file]}"
+    end
+
+    def outfile
+      if @outfile
+        File.expand_path(@outfile)
+      else
+        "#{options[:tmpdir]}/#{Digest::MD5.hexdigest((Time.now.to_i + rand(9001)).to_s)}.#{format}"
+      end
+    end
+  end
+end

data/lib/yabbie/source.rb

@@ -0,0 +1,27 @@
+require 'uri'
+
+module Yabbie
+  class Source
+    def initialize(url_or_file)
+      @source = url_or_file
+      raise ImproperSourceError.new unless url? || file?
+    end
+
+    def url?
+      @source.is_a?(String) && @source.match(URI::regexp)
+    end
+
+    def file?
+      @source.kind_of?(File)
+    end
+
+    def html?
+      !(url? || file?)
+    end
+
+    def to_s
+      file? ? @source.path : @source
+    end
+  end
+end
+

data/lib/yabbie/version.rb

@@ -1,3 +1,3 @@
 module Yabbie
-  VERSION = "0.0.1"
+  VERSION = '0.0.3'
 end

data/lib/yabbie.rb

@@ -1,5 +1,6 @@
-require "yabbie/version"
+require 'yabbie/version'
+require 'yabbie/exceptions'
+require 'yabbie/source'
+require 'yabbie/slimer'
+require 'yabbie/configuration'
 
-module Yabbie
-  # Your code goes here...
-end

data/spec/fixtures/source_file.html

@@ -0,0 +1,2 @@
+<html>
+</html>

data/spec/spec_helper.rb

@@ -0,0 +1,7 @@
+require 'yabbie'
+require 'pry'
+
+RSpec.configure do |config|
+  config.order = 'random'
+end
+

data/spec/yabbie/configuration_spec.rb

@@ -0,0 +1,83 @@
+require 'spec_helper'
+
+describe Yabbie::Configuration do
+  subject { described_class.new }
+
+  describe 'accessors' do
+    context 'when values are not provided' do
+      it 'falls back to defaults' do
+        defaults = { format:          'png',
+          tmpdir:          Dir.tmpdir,
+          timeout:         120000,
+          config_file:     File.expand_path('../../../lib/yabbie/config.json', __FILE__),
+          width:           600,
+          height:          600,
+          error_log_file:  Dir.tmpdir + "/log/yabbie_error.log",
+          prepend_command: '',
+          script:          'default.js' }
+
+        expect(subject.default_options).to eq(defaults)
+      end
+    end
+
+    it 'defines accessor to format' do
+      subject.format = 'jpg'
+      expect(subject.default_options[:format]).to eq('jpg')
+    end
+
+    it 'defines accessor to tmpdir' do
+      subject.tmpdir = '/test'
+      expect(subject.default_options[:tmpdir]).to eq('/test')
+    end
+
+    it 'defines accessor to timeout' do
+      subject.timeout = '9'
+      expect(subject.default_options[:timeout]).to eq('9')
+    end
+
+    it 'defines accessor to config_file' do
+      subject.config_file = 'config.json'
+      expect(subject.default_options[:config_file]).to eq('config.json')
+    end
+
+    it 'defines accessor to error_log_file' do
+      subject.error_log_file = 'error.log'
+      expect(subject.default_options[:error_log_file]).to eq('error.log')
+    end
+
+    it 'defines accessor to width' do
+      subject.width = '100px'
+      expect(subject.default_options[:width]).to eq('100px')
+    end
+
+    it 'defines accessor to height' do
+      subject.height = '100px'
+      expect(subject.default_options[:height]).to eq('100px')
+    end
+
+    it 'defines accessor to prepend_command' do
+      subject.prepend_command = 'RAILS_ENV=production'
+      expect(subject.default_options[:prepend_command]).to eq('RAILS_ENV=production')
+    end
+
+    it 'defines accessor to script' do
+      subject.script = 'config/cool_slimerjs_stuff.js'
+      expect(subject.default_options[:script]).to eq('config/cool_slimerjs_stuff.js')
+    end
+  end
+
+  describe '#slimerjs' do
+    it 'finds where slimerjs is installed' do
+      allow(subject).to receive(:`).with('which slimerjs').and_return('/usr/bin/slimerjs')
+
+      expect(subject.slimerjs).to eq('/usr/bin/slimerjs')
+    end
+  end
+
+  describe '.configuration' do
+    it 'returns instance of configuration class' do
+      expect(Yabbie.configuration).to be_an_instance_of(described_class)
+    end
+  end
+end
+

data/spec/yabbie/slimer_spec.rb

@@ -0,0 +1,46 @@
+require 'spec_helper'
+
+describe Yabbie::Slimer do
+  let(:options) {
+    {
+      prepend_command: 'SLIMERJSLAUCHER=/app/firefox',
+      config_file:     'config.js',
+      error_log_file:  'error.log',
+      script:          'snapshot.js',
+      width:           10,
+      height:          10,
+      format:          'pdf',
+      tmpdir:          '/tmp',
+      timeout:         10
+    }
+  }
+
+  subject { described_class.new('http://google.com', options) }
+
+  before(:each) do
+    # Assume slimerjs is installed
+    allow(File).to receive(:exists?).and_return(true)
+    allow(Yabbie.configuration).to receive(:slimerjs).and_return('/usr/bin/slimerjs')
+    allow(Digest::MD5).to receive(:hexdigest).and_return('md5')
+  end
+
+  describe 'initialization' do
+    context 'when slimerjs is not present in the system' do
+      it 'raises no executable error' do
+        allow(File).to receive(:exists?).and_return(false)
+
+        expect {
+          described_class.new('http://google.com')
+        }.to raise_error(Yabbie::NoExecutableError)
+      end
+    end
+  end
+
+  describe '#cmd' do
+    it 'joins slimerjs options as a command' do
+      command = 'SLIMERJSLAUCHER=/app/firefox /usr/bin/slimerjs --config=config.js --error-log-file=error.log snapshot.js http://google.com /tmp/md5.pdf 10 10 pdf 10'
+
+      expect(subject.cmd).to eq(command)
+    end
+  end
+end

data/spec/yabbie/source_spec.rb

@@ -0,0 +1,30 @@
+require 'spec_helper'
+
+describe Yabbie::Source do
+  describe '#url?' do
+    let(:source) { described_class.new('http://google.com') }
+
+    it 'matches urls' do
+      expect(source).to be_url
+    end
+  end
+
+  describe '#file?' do
+    let(:file) { File.open('spec/fixtures/source_file.html') }
+    let(:source) { described_class.new(file) }
+
+    it 'matches files' do
+      expect(source).to be_file
+    end
+  end
+
+  describe 'initialization' do
+    context 'when argument is not url nor file' do
+      it 'raises improper source error' do
+        expect {
+          described_class.new('what is this?')
+        }.to raise_error(Yabbie::ImproperSourceError)
+      end
+    end
+  end
+end

data/yabbie.gemspec

@@ -20,7 +20,7 @@ Gem::Specification.new do |spec|
   spec.requirements  << 'slimerjs, v0.10 or greater'
 
   spec.add_development_dependency "bundler", "~> 1.6"
-  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rake", "~> 10.3"
   spec.add_development_dependency "rspec", "~> 3.0"
-  spec.add_development_dependency "pry-meta", "~> 0.0.7"
+  spec.add_development_dependency "pry-meta", "~> 0.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: yabbie
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.3
 platform: ruby
 authors:
 - Ricardo Bernardeli
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-06-17 00:00:00.000000000 Z
+date: 2014-08-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -28,16 +28,16 @@ dependencies:
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '10.3'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '10.3'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -58,14 +58,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.0.7
+        version: '0.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.0.7
+        version: '0.0'
 description: Delicious
 email:
 - ricardobcs@gmail.com
@@ -79,7 +79,18 @@ files:
 - README.md
 - Rakefile
 - lib/yabbie.rb
+- lib/yabbie/config.json
+- lib/yabbie/configuration.rb
+- lib/yabbie/default.js
+- lib/yabbie/exceptions.rb
+- lib/yabbie/slimer.rb
+- lib/yabbie/source.rb
 - lib/yabbie/version.rb
+- spec/fixtures/source_file.html
+- spec/spec_helper.rb
+- spec/yabbie/configuration_spec.rb
+- spec/yabbie/slimer_spec.rb
+- spec/yabbie/source_spec.rb
 - yabbie.gemspec
 homepage: https://github.com/net-engine/yabbie
 licenses:
@@ -106,4 +117,9 @@ rubygems_version: 2.2.2
 signing_key: 
 specification_version: 4
 summary: Yabbie. Like shrimp for PhantomJS, but for SlimerJS.
-test_files: []
+test_files:
+- spec/fixtures/source_file.html
+- spec/spec_helper.rb
+- spec/yabbie/configuration_spec.rb
+- spec/yabbie/slimer_spec.rb
+- spec/yabbie/source_spec.rb