screenshot_machine 0.0.2 → 0.0.3

data/.rspec

@@ -0,0 +1,3 @@
+--color
+--fail-fast
+--order random

data/.travis.yml

@@ -0,0 +1,3 @@
+language: ruby
+rvm:
+  - 1.9.3

data/Gemfile

@@ -1,4 +1,13 @@
 source 'https://rubygems.org'
 
+gem 'rake'
+
+group :test do
+  gem 'rspec', '>= 2.11'
+  gem 'simplecov', :require => false
+  gem 'webmock'
+end
+
+
 # Specify your gem's dependencies in screenshot_machine.gemspec
 gemspec

data/README.md

@@ -1,3 +1,5 @@
+[![Build Status](https://travis-ci.org/tupalo/screenshot_machine.png?branch=master)](https://travis-ci.org/tupalo/screenshot_machine)
+
 # ScreenshotMachine
 
 A gem to create screenshots of webpages by using the [ScreenshotMachine.com](http://screenshotmachine.com) API.

data/Rakefile

@@ -1,2 +1,8 @@
 #!/usr/bin/env rake
 require "bundler/gem_tasks"
+
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec)
+
+task :test => :spec
+task :default => :spec

data/lib/screenshot_machine.rb

@@ -13,6 +13,26 @@ module ScreenshotMachine
     class InvalidKey < StandardError; end
     class NoCredits < StandardError; end
   end
+
+  class << self
+    # Alias for ScreenshotMachine::Generator.new
+    #
+    # @return [ScreenshotMachine::Generator]
+    def new(url, options={})
+      ScreenshotMachine::Generator.new(url, options)
+    end
+
+    # Delegate to ScreenshotMachine::Generator
+    def method_missing(method, *args, &block)
+      return super unless new.respond_to?(method)
+      new.send(method, *args, &block)
+    end
+
+    # Delegate to ScreenshotMachine::Generator
+    def respond_to?(method, include_private = false)
+      new.respond_to?(method, include_private) || super(method, include_private)
+    end
+  end
 end
 
 require "screenshot_machine/generator"

data/lib/screenshot_machine/configuration.rb

@@ -12,6 +12,13 @@ module ScreenshotMachine
      # @private
     attr_accessor *VALID_PARAMS_KEYS
 
+    DEFAULT_SIZE        = "L"     # T, S, E, N, M, L, X, F
+    DEFAULT_FORMAT      = "JPG"   # JPG, GIF, PNG
+    DEFAULT_CACHELIMIT  = 14      # 0-14 in days
+    DEFAULT_TIMEOUT     = 200     # 0, 200, 400, 600, 800, 1000 in ms
+    DEFAULT_URL         = nil
+    DEFAULT_KEY         = nil
+
     # When this module is extended, set all configuration options to their default values
     def self.extended(base)
       base.reset
@@ -29,12 +36,12 @@ module ScreenshotMachine
 
     # Reset all configuration options to defaults
     def reset
-      self.size       = "L"     # T, S, E, N, M, L, X, F
-      self.format     = "JPG"   # JPG, GIF, PNG
-      self.cacheLimit = 14      # 0-14 in days
-      self.timeout    = 200     # 0, 200, 400, 600, 800, 1000 in ms
-      self.url        = nil
-      self.key        = nil
+      self.size       = DEFAULT_SIZE
+      self.format     = DEFAULT_FORMAT
+      self.cacheLimit = DEFAULT_CACHELIMIT      
+      self.timeout    = DEFAULT_TIMEOUT     
+      self.url        = DEFAULT_URL
+      self.key        = DEFAULT_KEY
       self
     end
   end

data/lib/screenshot_machine/version.rb

@@ -1,3 +1,3 @@
 module ScreenshotMachine
-  VERSION = "0.0.2"
+  VERSION = "0.0.3"
 end

data/spec/screenshot_machine/generator_spec.rb

@@ -0,0 +1,94 @@
+require 'spec_helper'
+
+describe ScreenshotMachine::Generator do
+  describe ".new" do
+    it "requires one argument" do
+      expect { ScreenshotMachine::Generator.new }.to raise_error(ArgumentError)
+      expect(ScreenshotMachine::Generator).to respond_to(:new).with(1).argument
+    end
+
+    it "takes an optional second argument" do
+      expect(ScreenshotMachine::Generator).to respond_to(:new).with(2).arguments
+    end
+
+    it "initializes with one argument" do
+      generator = ScreenshotMachine::Generator.new(true)
+      expect(generator).to be_kind_of(ScreenshotMachine::Generator)
+    end
+
+    it "takes the url as first argument" do
+      url = 'http://example.com'
+      generator = ScreenshotMachine::Generator.new(url)
+      expect(generator.url).to eq(url)
+    end
+
+    it "takes the options as second argument" do
+      url       = nil
+      options   = { :key => 'abc123' }
+      generator = ScreenshotMachine::Generator.new(url, options)
+      expect(generator.key).to eq(options[:key])
+    end
+  end
+
+  describe ".screenshot_url" do
+    let(:generator){ ScreenshotMachine::Generator.new("http://example.com") }
+
+    it "calls params" do
+      generator.should_receive(:params).and_return( { :a => 'b', :c => 'd' })
+      generator.send(:screenshot_url)
+    end
+
+    it "includes all params" do
+      generator.should_receive(:params).and_return( { :a => 'b', :c => 'd' })
+      expect(generator.send(:screenshot_url)).to match("a=b")
+    end
+
+    it "includes the API_URL" do
+      expect(generator.send(:screenshot_url)).to match(ScreenshotMachine::API_URL)
+    end
+  end
+
+  describe ".screenshot" do
+    let(:generator){ ScreenshotMachine::Generator.new("http://example.com") }
+
+    context "when a valid API call" do
+      it "returns a string" do
+        stub_request(:get, /api\.screenshotmachine\.com.*/)
+        expect(generator.screenshot.class).to eq(String)
+      end
+    end
+
+    context "when requesting an invalid URL" do
+      it "should raise an exception" do
+        stub_request(:get, /api\.screenshotmachine\.com.*/).
+          to_return(
+            :status => 200,  
+            :headers => { 'x-screenshotmachine-response' => 'invalid_url' } 
+          )
+        expect{ generator.screenshot }.to raise_error(ScreenshotMachine::Exceptions::InvalidUrl)
+      end
+    end
+
+    context "when requesting an invalid API KEY" do
+      it "should raise an exception" do
+        stub_request(:get, /api\.screenshotmachine\.com.*/).
+          to_return(
+            :status => 200,  
+            :headers => { 'x-screenshotmachine-response' => 'invalid_key' } 
+          )
+        expect{ generator.screenshot }.to raise_error(ScreenshotMachine::Exceptions::InvalidKey)
+      end
+    end
+
+    context "when requesting with no credits left" do
+      it "should raise an exception" do
+        stub_request(:get, /api\.screenshotmachine\.com.*/).
+          to_return(
+            :status => 200,  
+            :headers => { 'x-screenshotmachine-response' => 'no_credits' } 
+          )
+        expect{ generator.screenshot }.to raise_error(ScreenshotMachine::Exceptions::NoCredits)
+      end
+    end
+  end
+end

data/spec/screenshot_machine_spec.rb

@@ -0,0 +1,110 @@
+require 'spec_helper'
+
+describe ScreenshotMachine do
+  after do
+    ScreenshotMachine.reset
+  end
+
+  describe ".new" do
+    it "is a ScreenshotMachine::Generator" do
+      expect(ScreenshotMachine.new("")).to be_a ScreenshotMachine::Generator
+    end
+  end
+
+  describe ".size" do
+    it "returns the default size" do
+      expect(ScreenshotMachine.size).to eq(ScreenshotMachine::Configuration::DEFAULT_SIZE)
+    end
+  end
+
+  describe ".size=" do
+    it "sets the size" do
+      ScreenshotMachine.size = 'X'
+      expect(ScreenshotMachine.size).to eq('X')
+    end
+  end
+
+  describe ".format" do
+    it "returns the default format" do
+      expect(ScreenshotMachine.format).to eq(ScreenshotMachine::Configuration::DEFAULT_FORMAT)
+    end
+  end
+
+  describe ".format=" do
+    it "sets the format" do
+      ScreenshotMachine.format = 'PNG'
+      expect(ScreenshotMachine.format).to eq('PNG')
+    end
+  end
+
+
+  describe ".cacheLimit" do
+    it "returns the default cacheLimit" do
+      expect(ScreenshotMachine.cacheLimit).to eq(ScreenshotMachine::Configuration::DEFAULT_CACHELIMIT)
+    end
+  end
+
+  describe ".cacheLimit=" do
+    it "sets the cacheLimit" do
+      ScreenshotMachine.cacheLimit = 400
+      expect(ScreenshotMachine.cacheLimit).to eq(400)
+    end
+  end
+
+  describe ".timeout" do
+    it "returns the default timeout" do
+      expect(ScreenshotMachine.timeout).to eq(ScreenshotMachine::Configuration::DEFAULT_TIMEOUT)
+    end
+  end
+
+  describe ".timeout=" do
+    it "sets the timeout" do
+      ScreenshotMachine.timeout = 400
+      expect(ScreenshotMachine.timeout).to eq(400)
+    end
+  end
+
+  describe ".url" do
+    it "returns the default url" do
+      expect(ScreenshotMachine.url).to eq(ScreenshotMachine::Configuration::DEFAULT_URL)
+    end
+  end
+
+  describe ".url=" do
+    it "sets the url" do
+      ScreenshotMachine.url = 'http://example.com'
+      expect(ScreenshotMachine.url).to eq('http://example.com')
+    end
+  end
+
+  describe ".key" do
+    it "returns the default key" do
+      expect(ScreenshotMachine.key).to eq(ScreenshotMachine::Configuration::DEFAULT_KEY)
+    end
+  end
+
+  describe ".key=" do
+    it "sets the key" do
+      ScreenshotMachine.key = 'abcdefgh123456'
+      expect(ScreenshotMachine.key).to eq('abcdefgh123456')
+    end
+  end
+
+  describe ".configure" do
+    ScreenshotMachine::Configuration::VALID_PARAMS_KEYS.each do |key|
+      it "sets the #{key}" do
+        ScreenshotMachine.configure do |config|
+          config.send("#{key}=", key)
+          expect(ScreenshotMachine.send(key)).to eq(key)
+        end
+      end
+    end
+  end
+
+  describe ".options" do
+    it "returns the configuration as a hash" do
+      expect(ScreenshotMachine.options).to be_kind_of(Hash)
+    end
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,17 @@
+unless ENV['CI']
+  require 'simplecov'
+  SimpleCov.start do
+    add_group 'Tweetstream', 'lib/tweetstream'
+    add_group 'Specs', 'spec'
+  end
+end
+
+require 'screenshot_machine'
+require 'rspec'
+require 'webmock/rspec'
+
+RSpec.configure do |config|
+  config.expect_with :rspec do |c|
+    c.syntax = :expect
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: screenshot_machine
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
   prerelease: 
 platform: ruby
 authors:
@@ -19,6 +19,8 @@ extensions: []
 extra_rdoc_files: []
 files:
 - .gitignore
+- .rspec
+- .travis.yml
 - Gemfile
 - LICENSE
 - README.md
@@ -28,6 +30,9 @@ files:
 - lib/screenshot_machine/generator.rb
 - lib/screenshot_machine/version.rb
 - screenshot_machine.gemspec
+- spec/screenshot_machine/generator_spec.rb
+- spec/screenshot_machine_spec.rb
+- spec/spec_helper.rb
 homepage: ''
 licenses: []
 post_install_message: 
@@ -53,4 +58,7 @@ signing_key:
 specification_version: 3
 summary: This gem returns a screenshot of a webpage, using the ScreenshotMachine.com
   API (free account required).
-test_files: []
+test_files:
+- spec/screenshot_machine/generator_spec.rb
+- spec/screenshot_machine_spec.rb
+- spec/spec_helper.rb