screenshot_machine 0.0.1

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in screenshot_machine.gemspec
+gemspec

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Consti
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,79 @@
+# ScreenshotMachine
+
+A gem to create screenshots of webpages by using the [ScreenshotMachine.com](http://screenshotmachine.com) API.
+
+You will need a (free) account to get started.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'screenshot_machine'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install screenshot_machine
+
+## Usage
+
+Using ScreenshotMachine is quite simple
+
+```ruby
+require 'screenshot_machine'
+
+ScreenshotMachine.configure do |config|
+  config.key = '012345abcdefg'
+end
+
+website_url = "http://google.com/?q=great+gem"
+sm = ScreenshotMachine::Generator.new(website_url)
+# Returns a binary stream of the file
+sm.screenshot
+```
+
+You can also config all API Parameters
+
+```ruby
+require 'screenshot_machine'
+
+ScreenshotMachine.configure do |config|
+  config.key        = '012345abcdefg'
+  config.size       = 'X'
+  config.format     = 'PNG'
+  config.cacheLimit = 2
+  config.timeout    = 400
+end
+```
+
+### Exceptions
+
+```ruby
+# ScreenshotMachine::Exceptions::InvalidUrl
+# Raised when the website_url can not be resolved by ScreenshotMachine.com
+ScreenshotMachine::Generator.new("http://non-existing-example123.com").screenshot
+# ScreenshotMachine::Exceptions::InvalidUrl: WARNING: Invalid URL
+
+# ScreenshotMachine::Exceptions::InvalidKey
+# Raised when your API key is not set or invalid
+ScreenshotMachine::Generator.new("http://non-existing-example123.com").screenshot
+# ScreenshotMachine::Exceptions::InvalidKey: ERROR: Invalid API KEY
+
+# ScreenshotMachine::Exceptions::NoCredits
+# Raised when there are not sufficient credits in your ScreenshotMachine.com account.
+ScreenshotMachine::Generator.new("http://example.com").screenshot
+# ScreenshotMachine::Exceptions::NoCredits: ERROR: No Credits for API
+```
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Added some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,2 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"

data/lib/screenshot_machine.rb

@@ -0,0 +1,18 @@
+require "uri"
+require "open-uri"
+require "screenshot_machine/version"
+require "screenshot_machine/configuration"
+
+module ScreenshotMachine
+  extend Configuration
+
+  API_URL = "http://api.screenshotmachine.com/"
+  
+  module Exceptions
+    class InvalidUrl < StandardError; end
+    class InvalidKey < StandardError; end
+    class NoCredits < StandardError; end
+  end
+end
+
+require "screenshot_machine/generator"

data/lib/screenshot_machine/configuration.rb

@@ -0,0 +1,41 @@
+module ScreenshotMachine
+  module Configuration
+    # An array of valid keys in the options hash when configuring TweetStream.
+    VALID_PARAMS_KEYS = [
+      :size,
+      :format,
+      :cacheLimit,
+      :timeout,
+      :url,
+      :key].freeze
+
+     # @private
+    attr_accessor *VALID_PARAMS_KEYS
+
+    # When this module is extended, set all configuration options to their default values
+    def self.extended(base)
+      base.reset
+    end
+
+    # Convenience method to allow configuration options to be set in a block
+    def configure
+      yield self
+    end
+
+    # Create a hash of options and their values
+    def options
+      Hash[*VALID_PARAMS_KEYS.map {|key| [key, send(key)] }.flatten]
+    end
+
+    # 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
+    end
+  end
+end

data/lib/screenshot_machine/generator.rb

@@ -0,0 +1,42 @@
+module ScreenshotMachine
+  class Generator
+    
+    attr_accessor *Configuration::VALID_PARAMS_KEYS
+    
+    def initialize(url, options={})
+      merged_options = ScreenshotMachine.options.
+        merge({ :url => url }).
+        merge(options)
+      Configuration::VALID_PARAMS_KEYS.each do |key|
+        send("#{key}=", merged_options[key])
+      end
+    end
+
+    def screenshot
+      @screenshot ||= begin
+        response = open(screenshot_url)
+        case response.meta["x-screenshotmachine-response"]
+        when "invalid_url"
+          raise Exceptions::InvalidUrl, "WARNING: Invalid URL"
+        when "invalid_key"
+          raise Exceptions::InvalidKey, "ERROR: Invalid API KEY"
+        when "no_credits"
+          raise Exceptions::NoCredits,  "ERROR: No Credits for API"
+        end
+        response.read
+      end
+    end
+
+    private
+
+      def params
+        Hash[*Configuration::VALID_PARAMS_KEYS.map {|key| [key, send(key)] }.flatten]
+      end
+
+      def screenshot_url
+        uri = URI.parse(API_URL)
+        uri.query = URI.escape(params.map{|k,v| "#{k}=#{v}"}.join('&'))
+        uri.to_s
+      end
+  end
+end

data/lib/screenshot_machine/version.rb

@@ -0,0 +1,3 @@
+module ScreenshotMachine
+  VERSION = "0.0.1"
+end

data/screenshot_machine.gemspec

@@ -0,0 +1,17 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/screenshot_machine/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.authors       = ["Constantin Hofstetter"]
+  gem.email         = ["consti@consti.de"]
+  gem.description   = %q{Screenshot Machine Gem}
+  gem.summary       = %q{This gem returns a screenshot of a webpage, using the ScreenshotMachine.com API (free account required).}
+  gem.homepage      = ""
+
+  gem.files         = `git ls-files`.split($\)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.name          = "screenshot_machine"
+  gem.require_paths = ["lib"]
+  gem.version       = ScreenshotMachine::VERSION
+end

metadata

@@ -0,0 +1,56 @@
+--- !ruby/object:Gem::Specification
+name: screenshot_machine
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Constantin Hofstetter
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-03-05 00:00:00.000000000 Z
+dependencies: []
+description: Screenshot Machine Gem
+email:
+- consti@consti.de
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- lib/screenshot_machine.rb
+- lib/screenshot_machine/configuration.rb
+- lib/screenshot_machine/generator.rb
+- lib/screenshot_machine/version.rb
+- screenshot_machine.gemspec
+homepage: ''
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: This gem returns a screenshot of a webpage, using the ScreenshotMachine.com
+  API (free account required).
+test_files: []