class Browshot

Attributes

base[R]

@!attribute [r] Base URL for all API requests. You should use the default base provided by the library. Be careful if you decide to use HTTP instead of HTTPS as your API key could be sniffed and your account could be used without your consent.

debug[R]

@!attribute [r] print debug output to the standard output

key[R]

@!attribute [r] API key

Public Class Methods

new(key='', debug=false, base='https://api.browshot.com/api/v1/') click to toggle source

New client

@param key [String] API key @param debug [Boolean] Set to true to print debug output to the standard output. false (disabled) by default. @param base [String] Base URL for all API requests. You should use the default base provided by the library. Be careful if you decide to use HTTP instead of HTTPS as your API key could be sniffed and your account could be used without your consent.

# File lib/browshot.rb, line 34
def initialize(key='', debug=false, base='https://api.browshot.com/api/v1/')
        @key = key || ''
        @base = base || 'https://api.browshot.com/api/v1/'
        @debug = debug || false
end

Public Instance Methods

account_info(parameters={}) click to toggle source

Return information about the user account. See {browshot.com/api/documentation#account_info} for the response format.

# File lib/browshot.rb, line 247
def account_info(parameters={})
        return return_reply('account/info', parameters)
end

api_version() click to toggle source

Return the API version handled by the library. Note that this library can usually handle new arguments in requests without requiring an update.

# File lib/browshot.rb, line 41
def api_version()
        return "1.16"
end

batch_create(id=0, file='', parameters={}) click to toggle source

Request multiple screenshots from a text file. See browshot.com/api/documentation#batch_create for the response format.

See browshot.com/api/documentation#batch_create for the full list of possible arguments.

@param id [Integer] Instance ID @param file [String] Path to the text file which contains the list of URLs

# File lib/browshot.rb, line 227
def batch_create(id=0, file='', parameters={})
        parameters[:instance_id] = id
        parameters[:file] = file

        return return_post_reply('batch/create', parameters)
end

batch_info(id=0, parameters={}) click to toggle source

Get information about a screenshot batch requested previously. See {browshot.com/api/documentation#batch_info} for the response format.

See browshot.com/api/documentation#batch_info for the full list of possible arguments.

@param id [Integer] Batch ID

# File lib/browshot.rb, line 239
def batch_info(id=0,  parameters={})
        parameters[:id] = id

        return return_reply('batch/info', parameters)
end

browser_info(id=0) click to toggle source

Return the details of a browser. See browshot.com/api/documentation#browser_info for the response format.

@param id [Integer] Browser ID

# File lib/browshot.rb, line 100
def browser_info(id=0)
        return return_reply('browser/info', { 'id' => id })
end

browser_list() click to toggle source

Return the list of browsers. See browshot.com/api/documentation#browser_list for the response format.

# File lib/browshot.rb, line 93
def browser_list()
        return return_reply('browser/list')
end

instance_info(id=0) click to toggle source

Return the details of an instance. See browshot.com/api/documentation#instance_info for the response format.

@param id [Integer] Instance ID

# File lib/browshot.rb, line 87
def instance_info(id=0)
        return return_reply('instance/info', { 'id' => id })
end

instance_list() click to toggle source

Return the list of instances. See browshot.com/api/documentation#instance_list for the response format.

# File lib/browshot.rb, line 80
def instance_list()
        return return_reply('instance/list')
end

screenshot_create(url='', parameters={}) click to toggle source

Request a screenshot. See browshot.com/api/documentation#screenshot_create for the response format.

@param url [String] URL of the website to create a screenshot of.

# File lib/browshot.rb, line 108
def screenshot_create(url='', parameters={})
        parameters[:url] = url
        return return_reply('screenshot/create', parameters)
end

screenshot_delete(id=0, parameters={}) click to toggle source

Delete details of a screenshot. See browshot.com/api/documentation#screenshot_delete for the response format.

@param id [Integer] screenshot ID

# File lib/browshot.rb, line 169
def screenshot_delete(id=0, parameters={})
        parameters[:id] = id
        return return_reply('screenshot/delete', parameters)
end

screenshot_host(id=0, hosting='browshot', parameters={}) click to toggle source

Hot a screenshot or thumbnail. See browshot.com/api/documentation#screenshot_host for the response format.

@param id [Integer] screenshot ID @param hosting ['s3', 'browshot'] hosting option: s3 or browshot

# File lib/browshot.rb, line 152
def screenshot_host(id=0, hosting='browshot', parameters={})
        parameters[:id] = id
        parameters[:hosting] = hosting
        return return_reply('screenshot/host', parameters)
end

screenshot_html(id=0, parameters={}) click to toggle source

Get the HTML code of the rendered page. See browshot.com/api/documentation#screenshot_html for the response format.

See browshot.com/api/documentation#screenshot_html for the full list of possible arguments.

@param id [Integer] screenshot ID

# File lib/browshot.rb, line 207
def screenshot_html(id=0, parameters={})
        parameters[:id] = id

        return return_string('screenshot/html', parameters)
end

screenshot_info(id=0, parameters={}) click to toggle source

Get information about a screenshot requested previously. See browshot.com/api/documentation#screenshot_info for the response format.

@param id [Integer] screenshot ID

# File lib/browshot.rb, line 116
def screenshot_info(id=0, parameters={})
        parameters[:id] = id
        return return_reply('screenshot/info', parameters)
end

screenshot_list(parameters={}) click to toggle source

Get details about screenshots requested. See browshot.com/api/documentation#screenshot_list for the response format.

# File lib/browshot.rb, line 122
def screenshot_list(parameters={})
        return return_reply('screenshot/list', parameters)
end

screenshot_multiple(parameters={}) click to toggle source

Request multiple screenshots. See browshot.com/api/documentation#screenshot_multiple for the response format.

See browshot.com/api/documentation#screenshot_multiple for the full list of possible arguments.

# File lib/browshot.rb, line 217
def screenshot_multiple(parameters={})
        return return_reply('screenshot/multiple', parameters)
end

screenshot_search(url='', parameters={}) click to toggle source

Get details about screenshots requested. See browshot.com/api/documentation#screenshot_search for the response format.

@param url [String] URL string to match

# File lib/browshot.rb, line 177
def screenshot_search(url='', parameters={})
        parameters[:url] = url
        return return_reply('screenshot/search', parameters)
end

screenshot_share(id=0, parameters={}) click to toggle source

Share a screenshot. See browshot.com/api/documentation#screenshot_share for the response format.

@param id [Integer] screenshot ID

# File lib/browshot.rb, line 161
def screenshot_share(id=0, parameters={})
        parameters[:id] = id
        return return_reply('screenshot/share', parameters)
end

screenshot_thumbnail(id=0, parameters={}) click to toggle source

Retrieve the screenshot, or a thumbnail. See browshot.com/api/documentation#screenshot_thumbnails for the response format.

@eturn an empty string if the image could not be retrieved. @param id [Integer] screenshot ID

# File lib/browshot.rb, line 130
def screenshot_thumbnail(id=0, parameters={})
        parameters[:id] = id

        begin
    url = make_url('screenshot/thumbnail', parameters)
    response = fetch(url.to_s)
    case response
        when Net::HTTPSuccess     then 
            return response.response.body
        else
            return ''
    end
rescue Exception => e
    puts "{e.message}" if (@debug)
    raise e
end
end

screenshot_thumbnail_file(id=0, file='', parameters={}) click to toggle source

Retrieve the screenshot, or a thumbnail, and save it to a file. See browshot.com/api/documentation#screenshot_thumbnails for the response format.

See browshot.com/api/documentation#screenshot_thumbnails for the full list of possible arguments.

@param id [Integer] screenshot ID @param file [String] Local file name to write to.

# File lib/browshot.rb, line 189
def screenshot_thumbnail_file(id=0, file='', parameters={})
        content = screenshot_thumbnail(id, parameters);

        if (content != '')
                File.open(file, 'w') {|f| f.write(content) }
                return file
        else
                puts "No thumbnail retrieved\n" if (@debug)
                return ''
        end
end

simple(parameters={}) click to toggle source

Retrieve a screenshot with one call. See {browshot.com/api/documentation#simple} for the full list of possible arguments.

@return [Array<Symbol, Symbol>] !{:code => 200, :png => <content>} in case of success

# File lib/browshot.rb, line 48
def simple(parameters={})
    begin
        url = make_url('simple', parameters)
        response = fetch(url.to_s)
        case response
            when Net::HTTPSuccess     then 
                return {:code => response.code, :png => response.response.body}
            else
                return {:code => response.code, :png => ''}
        end
    rescue Exception => e
        puts "{e.message}" if (@debug)
        raise e
    end
end

simple_file(file='', parameters={}) click to toggle source

Save a screenshot to a file with one call, and save it to a file. See {browshot.com/api/documentation#simple} for the full list of possible arguments.

@param file [String] Local file name to write to. @param parameters [Array<Symbol, Symbol>] Additional options @return [Array<Symbol, Symbol>] !{:code => 200, :file => <file_name>} in case of success

# File lib/browshot.rb, line 69
def simple_file(file='', parameters={})
    data = self.simple(parameters)
    if (data[:png].length > 0)
        File.open(file, 'w') {|f| f.write(data[:png]) }
        return {:code => data[:code], :file => file}
    else
        return {:code => data[:code], :file => ''}
    end
end

Private Instance Methods

fetch(url, limit=32) click to toggle source

# File lib/browshot.rb, line 337
def fetch(url, limit=32)
    raise ArgumentError, 'HTTP redirect too deep' if (limit == 0)

    uri = URI.parse(url)
    http = Net::HTTP.new(uri.host, uri.port)
    http.open_timeout = 240
    http.read_timeout = 240

    request = Net::HTTP::Get.new(uri.request_uri, {'User-Agent' => 'Browshot Ruby 1.14'})
    if (uri.scheme == 'https')
        http.use_ssl = true
        http.verify_mode = OpenSSL::SSL::VERIFY_NONE
    end
    response = http.request(request)

    case response
        when Net::HTTPRedirection then 
            path = response['location']
            url = URL.new( URI.join(@base, path).to_s )
            return fetch(url.to_s, limit - 1)
        else
            return response
    end
end

make_url(action='', parameters={}) click to toggle source

# File lib/browshot.rb, line 253
def make_url(action='', parameters={})
        url =  "#{@base}#{action}?key=#{@key}"
        
        
        parameters.each_pair do |key, value|
                if (key == 'urls')
                        value.each { |val|
                          url += '&url=' + CGI::escape(val.to_s)
                        }
                elsif (key == 'instances')
                        value.each { |instance|
                          url += '&instance_id=' + CGI::escape(instance.to_s)
                        }
                else
                        url += "&#{key}=" + CGI::escape(value.to_s)
                end
        end

        puts "#{url}" if (@debug)

        return url
end

post(url, file='') click to toggle source

# File lib/browshot.rb, line 362
def post(url, file='')
    raise ArgumentError, 'Missing file to upload' if (file == '')
  
    uri = URI.parse(url)
    http = Net::HTTP.new(uri.host, uri.port)
    http.open_timeout = 240
    http.read_timeout = 240
    
    boundary = "AaB03x"
    
    post_body = []
    post_body << "--#{boundary}\r\n"
    post_body << "Content-Disposition: form-data; name=\"file\"; filename=\"#{File.basename(file)}\"\r\n"
    post_body << "Content-Type: text/plain\r\n"
    post_body << "\r\n"
    post_body << File.read(file)
    post_body << "\r\n--#{boundary}--\r\n"

    request = Net::HTTP::Post.new(uri.request_uri, {'User-Agent' => 'Browshot Ruby 1.14'})
    request.body = post_body.join
    request["Content-Type"] = "multipart/form-data, boundary=#{boundary}"
    
    if (uri.scheme == 'https')
        http.use_ssl = true
        http.verify_mode = OpenSSL::SSL::VERIFY_NONE
    end

    return http.request(request)
end

return_post_reply(action='', parameters={}) click to toggle source

# File lib/browshot.rb, line 288
def return_post_reply(action='', parameters={})
        begin
                content = return_post_string(action, parameters)

                json_decode = JSON.parse(content)
                return json_decode
        rescue Exception => e
                puts "{e.message}" if (@debug)
                raise e
        end
end

return_post_string(action='', parameters={}) click to toggle source

# File lib/browshot.rb, line 316
def return_post_string(action='', parameters={})
        begin
                file = parameters[:file]
                parameters.delete(:file)
                url = make_url(action, parameters)
                
                response = post(url,file)

                case response
                  when Net::HTTPSuccess     then 
                      return response.response.body
                  else
                      puts "Error from #{url}: #{response.code}" if (@debug)
                      return response.response.body
                end
        rescue Exception => e
                puts "{e.message}" if (@debug)
                raise e
        end
end

return_reply(action='', parameters={}) click to toggle source

# File lib/browshot.rb, line 276
def return_reply(action='', parameters={})
        begin
                content = return_string(action, parameters)

                json_decode = JSON.parse(content)
                return json_decode
        rescue Exception => e
                puts "{e.message}" if (@debug)
                raise e
        end
end

return_string(action='', parameters={}) click to toggle source

# File lib/browshot.rb, line 300
def return_string(action='', parameters={})
        begin
                url = make_url(action, parameters)
                
                response = Net::HTTP.get_response(URI(url))

                if (response.code == 200)
                        puts "Error from #{url}: #{response.code}" if (@debug)
                end
                return response.response.body
        rescue Exception => e
                puts "{e.message}" if (@debug)
                raise e
        end
end