grabz_it 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 grabz_it.gemspec
+gemspec

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2012 TODO: Write your name
+
+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,29 @@
+# GrabzIt
+
+TODO: Write a gem description
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'grabz_it'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install grabz_it
+
+## Usage
+
+TODO: Write usage instructions here
+
+## 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/grabz_it.gemspec

@@ -0,0 +1,19 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/grabz_it/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.authors       = ["Eric Berry"]
+  gem.email         = ["cavneb@gmail.com"]
+  gem.description   = "Ruby interface to the GrabzIt (grabz.it) service"
+  gem.summary       = "Ruby interface to the GrabzIt (grabz.it) service"
+  gem.homepage      = "https://github.com/cavneb/grabz_it"
+
+  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          = "grabz_it"
+  gem.require_paths = ["lib"]
+  gem.version       = GrabzIt::VERSION
+  
+  gem.add_development_dependency('rspec')
+end

data/lib/grabz_it/client.rb

@@ -0,0 +1,251 @@
+module GrabzIt
+  class Client
+    attr_accessor :app_key, :app_secret, :url, :callback_url, :browser_width, :browser_height, 
+                  :output_width, :output_height, :custom_id, :format, :delay
+
+    API_BASE_URL = "http://grabz.it/services/"
+
+    ##
+    # Initialize the +GrabzIt::Client+ class
+    #
+    # @param [String] app_key Application Key provided by grabz.it
+    # @param [String] app_secret Application Secret provided by grabz.it
+    #
+    # @raise [ArgumentError] Exception raised if the app_key or app_secret is not provided
+    #
+    def initialize(app_key, app_secret)
+      @app_key = app_key
+      @app_secret = app_secret
+      raise(ArgumentError, "You must provide app_key and app_secret") unless @app_key && @app_secret
+    end
+
+    ##
+    # Calls the GrabzIt web service to take the screenshot. Warning, this is a SYNCHONOUS method and can take up to
+    # 5 minutes before a response.
+    #
+    # @param [String] target_path File path that the file should be saved to (including file name and extension)
+    # @param [Hash] options Data that is to be passed to the web service
+    # @option options [String]  :url The URL that the screenshot should be made of
+    # @option options [String]  :callback_url The handler the GrabzIt web service should call after it has completed its work
+    # @option options [String]  :custom_id A custom identifier that you can pass through to the screenshot webservice. This will be returned with the callback URL you have specified.
+    # @option options [Integer] :browser_width The width of the browser in pixels
+    # @option options [Integer] :browser_height The height of the browser in pixels
+    # @option options [Integer] :output_width The width of the resulting thumbnail in pixels
+    # @option options [Integer] :output_height The height of the resulting thumbnail in pixels
+    # @option options [String]  :format The format the screenshot should be in: bmp8, bmp16, bmp24, bmp, gif, jpg, png
+    # @option options [Integer] :delay The number of milliseconds to wait before taking the screenshot
+    # 
+    # @return [GrabzIt::Response] The parsed response.
+    #
+    # @example
+    #   client = GrabzIt::Client.new('TEST_KEY', 'TEST_SECRET')
+    #   options = {
+    #     :url            => 'http://grabz.it',
+    #     :callback_url   => 'http://example.com/callback',
+    #     :browser_width  => 1024,
+    #     :browser_height => 768,
+    #     :output_width   => 800,
+    #     :output_height  => 600,
+    #     :custom_id      => '12345',
+    #     :format         => 'png',
+    #     :delay          => 1000
+    #   }
+    #   response = client.take_picture(options)
+    #
+    def save_picture(target_path, options = {})
+      response = take_picture(options)
+
+      # Wait for the response to be ready
+      iterations = 0
+      while true do
+        status = get_status(response.screenshot_id)
+
+        if status.failed?
+          raise "The screenshot did not complete with errors: " + status.message
+
+        elsif status.available?
+          image = get_picture(response.screenshot_id)
+          image.save(target_path)
+          break
+        end
+
+        # Check again in 1 second with a max of 5 minutes
+        if iterations <= (5 * 60)
+          sleep(1)
+        else
+          raise Timeout::Error
+        end
+      end
+
+      true
+    end
+
+    ##
+    # Calls the GrabzIt web service to take the screenshot.
+    #
+    # @param [Hash] options Data that is to be passed to the web service
+    # @option options [String]  :url The URL that the screenshot should be made of
+    # @option options [String]  :callback_url The handler the GrabzIt web service should call after it has completed its work
+    # @option options [String]  :custom_id A custom identifier that you can pass through to the screenshot webservice. This will be returned with the callback URL you have specified.
+    # @option options [Integer] :browser_width The width of the browser in pixels
+    # @option options [Integer] :browser_height The height of the browser in pixels
+    # @option options [Integer] :output_width The width of the resulting thumbnail in pixels
+    # @option options [Integer] :output_height The height of the resulting thumbnail in pixels
+    # @option options [String]  :format The format the screenshot should be in: bmp8, bmp16, bmp24, bmp, gif, jpg, png
+    # @option options [Integer] :delay The number of milliseconds to wait before taking the screenshot
+    # 
+    # @return [GrabzIt::Response] The parsed response.
+    #
+    # @example
+    #   client = GrabzIt::Client.new('TEST_KEY', 'TEST_SECRET')
+    #   options = {
+    #     :url            => 'http://grabz.it',
+    #     :callback_url   => 'http://example.com/callback',
+    #     :browser_width  => 1024,
+    #     :browser_height => 768,
+    #     :output_width   => 800,
+    #     :output_height  => 600,
+    #     :custom_id      => '12345',
+    #     :format         => 'png',
+    #     :delay          => 1000
+    #   }
+    #   response = client.take_picture(options)
+    #
+    def take_picture(options = {})
+      parse_options(options)
+      action = "takepicture.ashx"
+      response_body = query_api(action, generate_params)
+      response = Response.new(response_body)
+      raise response.message if response.message
+      response
+    end
+
+    ##
+    # Get the current status of a GrabzIt screenshot.
+    #
+    # @param [String] screenshot_id The id of the screenshot provided by the GrabzIt api
+    # 
+    # @return [GrabzIt::Status] The parsed status.
+    #
+    # @example
+    #   client = GrabzIt::Client.new('TEST_KEY', 'TEST_SECRET')
+    #   status = client.get_status('Y2F2bmViQGdtYWlsLmNvbQ==-20943258e37c4fc28c4977cd76c40f58')
+    #
+    def get_status(screenshot_id)
+      action = "getstatus.ashx"
+      response_body = query_api(action, { :id => screenshot_id })
+      status = Status.new(response_body)
+      raise status.message if status.message
+      status
+    end
+
+    ##
+    # Get the current status of a GrabzIt screenshot.
+    #
+    # @param [String] screenshot_id The id of the screenshot provided by the GrabzIt api
+    # 
+    # @return [GrabzIt::Status] The parsed status.
+    #
+    # @example
+    #   client = GrabzIt::Client.new('TEST_KEY', 'TEST_SECRET')
+    #   status = client.get_status('Y2F2bmViQGdtYWlsLmNvbQ==-20943258e37c4fc28c4977cd76c40f58')
+    #
+    def get_cookies(domain)
+      action = "getcookies.ashx"
+      sig = Digest::MD5.hexdigest(@app_secret + "|" + domain)
+      params = {
+        :key => URI.escape(@app_key),
+        :domain => URI.escape(domain),
+        :sig => sig
+      }
+      response_body = query_api(action, params)
+      cookie_jar = CookieJar.new(response_body)
+      raise cookie_jar.message if cookie_jar.message
+      cookie_jar
+    end
+
+    ##
+    # Get the screenshot image
+    #
+    # @param [String] screenshot_id The id of the screenshot provided by the GrabzIt api
+    # 
+    # @return [GrabzIt::Image] The image object
+    #
+    # @example
+    #   client = GrabzIt::Client.new('TEST_KEY', 'TEST_SECRET')
+    #   image = client.get_image('Y2F2bmViQGdtYWlsLmNvbQ==-20943258e37c4fc28c4977cd76c40f58')
+    #   puts image.content_type
+    #   => 'image/png'
+    #   puts image.size
+    #   => 129347
+    #   image.save("/tmp/myimage.png")
+    #   File.exist?("/tmp/myimage.png")
+    #   => true
+    #
+    def get_picture(screenshot_id)
+      action = "getpicture.ashx"
+      response = query_api(action, { :id => screenshot_id })
+      image = Image.new(response)
+      image
+    end
+
+  private
+
+    # Helper method that performs the request
+    def query_api(action, params)
+      uri = URI("#{API_BASE_URL}#{action}")
+      uri.query = URI.encode_www_form(params)
+      res = Net::HTTP.get_response(uri)
+      res.body
+    end
+
+    # Convert the options into the instance variable values
+    def parse_options(options={})
+      options = options.symbolize_keys
+      @url            = options[:url] || ''
+      @callback_url   = options[:callback_url]   || ''
+      @browser_width  = options[:browser_width]  || ''
+      @browser_height = options[:browser_height] || ''
+      @output_width   = options[:output_width]   || ''
+      @output_height  = options[:output_height]  || ''
+      @custom_id      = options[:custom_id]      || ''
+      @format         = options[:format]         || ''
+      @delay          = options[:delay]          || ''
+    end
+
+    # Generate the params that are to be used in the request
+    def generate_params
+      {
+        :key      => URI.escape(@app_key),
+        :url      => URI.escape(@url),
+        :width    => @output_width,
+        :height   => @output_height,
+        :format   => @format,
+        :bwidth   => @browser_width,
+        :bheight  => @browser_height,
+        :callback => URI.escape(@callback_url),
+        :customid => URI.escape(@custom_id),
+        :delay    => @delay,
+        :sig      => generate_signature
+      }
+    end
+
+    # Generate the signature that is used in the request
+    def generate_signature
+      sig = []
+      sig << @app_secret
+      sig << @url
+      sig << @callback_url
+      sig << @format
+      sig << @output_height
+      sig << @output_width
+      sig << @browser_height
+      sig << @browser_width
+      sig << @custom_id
+      sig << @delay
+
+      Digest::MD5.hexdigest(sig.join('|'))
+    end
+
+  end
+end

data/lib/grabz_it/cookie.rb

@@ -0,0 +1,5 @@
+module GrabzIt
+  class Cookie
+    attr_accessor :name, :value, :domain, :path, :http_only, :expires, :type
+  end
+end

data/lib/grabz_it/cookie_jar.rb

@@ -0,0 +1,35 @@
+module GrabzIt
+  class CookieJar
+    attr_accessor :cookies, :message
+
+    def initialize(xml)
+      @cookies = []
+      doc = REXML::Document.new(xml)
+      @message = doc.root.elements['Message'].text
+      begin
+        add_cookies(doc.root.elements.to_a("//WebResult/Cookies/Cookie"))
+      rescue => ex
+        raise "Invalid Response: #{xml}"
+      end
+    end
+
+  private
+
+    def add_cookies(xml_cookies)
+      xml_cookies.each do |c|
+        cookie = Cookie.new
+        cookie.name      = c.elements['Name'].text
+        cookie.value     = c.elements['Value'].text
+        cookie.domain    = c.elements['Domain'].text
+        cookie.path      = c.elements['Path'].text
+        cookie.http_only = (c.elements['HttpOnly'].text == 'True')
+        cookie.type      = c.elements["Type"].text
+        if c.elements['Expires']
+          cookie.expires = c.elements['Expires'].text
+        end
+        @cookies << cookie
+      end
+    end
+
+  end
+end

data/lib/grabz_it/hash.rb

@@ -0,0 +1,47 @@
+class Hash
+
+  # Return a new hash with all keys converted to symbols, as long as
+  # they respond to +to_sym+.
+  #
+  #   { 'name' => 'Rob', 'years' => '28' }.symbolize_keys
+  #   #=> { :name => "Rob", :years => "28" }
+  def symbolize_keys
+    dup.symbolize_keys!
+  end
+
+  # Destructively convert all keys to symbols, as long as they respond
+  # to +to_sym+. Same as +symbolize_keys+, but modifies +self+.
+  def symbolize_keys!
+    keys.each do |key|
+      self[(key.to_sym rescue key) || key] = delete(key)
+    end
+    self
+  end
+
+  def to_params
+    params = ''
+    stack = []
+
+    each do |k, v|
+      if v.is_a?(Hash)
+        stack << [k,v]
+      else
+        params << "#{k}=#{v}&"
+      end
+    end
+
+    stack.each do |parent, hash|
+      hash.each do |k, v|
+        if v.is_a?(Hash)
+          stack << ["#{parent}[#{k}]", v]
+        else
+          params << "#{parent}[#{k}]=#{v}&"
+        end
+      end
+    end
+
+    params.chop! # trailing &
+    params
+  end
+
+end

data/lib/grabz_it/image.rb

@@ -0,0 +1,20 @@
+module GrabzIt
+  class Image
+    attr_accessor :image_bytes, :content_type, :size
+
+    def initialize(response)
+      begin
+        @image_bytes = response.body
+        @size = @image_bytes ? @image_bytes.size : 0
+        @content_type = response.header['content-type']
+      rescue => ex
+        raise "Invalid Response"
+      end
+    end
+
+    def save(path)
+      File.open(path, 'wb') { |s| s.write(@image_bytes) }
+    end
+
+  end
+end

data/lib/grabz_it/response.rb

@@ -0,0 +1,17 @@
+module GrabzIt
+  class Response
+    attr_accessor :result, :screenshot_id, :message
+    
+    def initialize(xml)
+      doc = REXML::Document.new(xml)
+      @result = doc.root.elements['Result'].text
+      @screenshot_id = doc.root.elements['ID'].text
+      @message = doc.root.elements['Message'].text
+    end
+
+    def successful?
+      @result == 'True'
+    end
+
+  end
+end

data/lib/grabz_it/status.rb

@@ -0,0 +1,21 @@
+module GrabzIt
+  class Status
+    attr_accessor :processing, :cached, :expired, :message
+
+    def initialize(xml)
+      doc = REXML::Document.new(xml)
+      @processing = (doc.root.elements['Processing'].text == 'True')
+      @cached     = (doc.root.elements['Cached'].text == 'True')
+      @expired    = (doc.root.elements['Expired'].text == 'True')
+      @message    = doc.root.elements['Message'].text
+    end
+
+    def failed?
+      !@processing && !@cached
+    end
+
+    def available?
+      @cached
+    end
+  end
+end

data/lib/grabz_it/version.rb

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

data/lib/grabz_it.rb

@@ -0,0 +1,8 @@
+require 'rexml/document'
+require 'digest/md5'
+require 'uri'
+require 'net/http'
+
+Dir[File.join(File.dirname(__FILE__), "grabz_it", "*rb")].each do |file|
+  require file
+end

data/spec/client_spec.rb

@@ -0,0 +1,223 @@
+require "spec_helper"
+
+describe GrabzIt::Client do
+
+  it "should raise an error when instanciating without the api_key or api_secret" do
+    lambda { GrabzIt::Client.new }.should raise_error(ArgumentError)
+  end
+
+  describe "with a valid api_key and api_secret" do
+    before(:each) do
+      @client = GrabzIt::Client.new('TEST_KEY', 'TEST_SECRET')
+      @options = {
+        :url            => 'http://grabz.it',
+        :callback_url   => 'http://example.com/callback',
+        :browser_width  => 1024,
+        :browser_height => 768,
+        :output_width   => 800,
+        :output_height  => 600,
+        :custom_id      => '12345',
+        :format         => 'png',
+        :delay          => 1000
+      }
+    end
+
+    ## ------------------------------------------------------------------------------------
+    # Take Picture
+    ## ------------------------------------------------------------------------------------
+    it "#take_picture" do
+      pending "unable to test without valid app_key and app_secret"
+    end
+
+    ## ------------------------------------------------------------------------------------
+    # Take Picture
+    ## ------------------------------------------------------------------------------------
+    describe "#take_picture" do
+      it "with successful response" do
+        xml = <<-EOF
+          <?xml version="1.0"?>
+          <WebResult xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
+            <Result>True</Result>
+            <ID>Y2F2bmViQGdtYWlsLmNvbQ==-20943258e37c4fc28c4977cd76c40f58</ID>
+            <Message />
+          </WebResult>
+        EOF
+        @client.stub!(:query_api).and_return(xml)
+        response = @client.take_picture(@options)
+
+        response.screenshot_id.should eq('Y2F2bmViQGdtYWlsLmNvbQ==-20943258e37c4fc28c4977cd76c40f58')
+        response.successful?.should be_true
+      end
+
+      it "with error response" do
+        xml = <<-EOF
+          <?xml version="1.0"?>
+          <WebResult xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
+            <Result>False</Result>
+            <ID />
+            <Message>Application Key not recognised.</Message>
+          </WebResult>
+        EOF
+        @client.stub!(:query_api).and_return(xml)
+
+        lambda{ @client.take_picture(@options) }.should raise_error(RuntimeError, "Application Key not recognised.")
+      end
+    end
+
+    ## ------------------------------------------------------------------------------------
+    # Get Status
+    ## ------------------------------------------------------------------------------------
+    describe "#get_status" do
+      it "with valid screenshot id" do
+        xml = <<-EOF
+          <?xml version="1.0"?>
+          <WebResult xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
+            <Processing>False</Processing>
+            <Cached>True</Cached>
+            <Expired>False</Expired>
+            <Message />
+          </WebResult>
+        EOF
+        @client.stub!(:query_api).and_return(xml)
+        status = @client.get_status('abcde12345')
+        
+        status.processing.should be_false
+        status.cached.should be_true
+        status.expired.should be_false
+        status.message.should be_nil
+      end
+
+      it "with invalid screenshot id" do
+        xml = <<-EOF
+          <?xml version="1.0"?>
+          <WebResult xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
+            <Processing>False</Processing>
+            <Cached>False</Cached>
+            <Expired>True</Expired>
+            <Message />
+          </WebResult>
+        EOF
+        @client.stub!(:query_api).and_return(xml)
+        status = @client.get_status('abcde12345')
+        
+        status.processing.should be_false
+        status.cached.should be_false
+        status.expired.should be_true
+        status.message.should be_nil
+      end
+    end
+
+    ## ------------------------------------------------------------------------------------
+    # Get Picture
+    ## ------------------------------------------------------------------------------------
+    describe "#get_picture" do
+      before(:each) do
+        raw_image = File.read(File.join(File.dirname(__FILE__), 'test_data', 'test_image.png'))
+        @mocked_response = Struct::MockHTTPResponse.new(raw_image, { 'content-type' => 'image/png' })
+      end
+
+      it "with valid screenshot id" do
+        @client.stub!(:query_api).and_return(@mocked_response)
+        image = @client.get_picture('YXBAMW9uMS5jb20=-4d164e5166134c31b95cd7b9d23e8ed5')
+        image.content_type.should eq('image/png')
+        image.size.should eq(129347)
+      end
+    end
+
+    ## ------------------------------------------------------------------------------------
+    # Get Cookies
+    ## ------------------------------------------------------------------------------------
+    describe "#get_cookies" do
+      it "with valid domain" do
+        xml = <<-EOF
+          <?xml version="1.0"?>
+          <WebResult xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
+            <Cookies>
+              <Cookie>
+                <Name>secure</Name>
+                <Value />
+                <Domain>accounts.google.com</Domain>
+                <Path>/</Path>
+                <HttpOnly>False</HttpOnly>
+                <Type>Global</Type>
+              </Cookie>
+              <Cookie>
+                <Name>PREF</Name>
+                <Value>ID=c8a1a3e41c52b4ed:TM=1346246013:LM=1346246013:S=_6o6Tap-5lKkES34</Value>
+                <Domain>.google.com</Domain>
+                <Path>/</Path>
+                <HttpOnly>False</HttpOnly>
+                <Expires>Sat, 30 Aug 2014 03:13:33 GMT</Expires>
+                <Type>Global</Type>
+              </Cookie>
+              <Cookie>
+                <Name>NID</Name>
+                <Value>63=zJWKTpnMjJjEhk_9wEEFWYccDWjY7hGrDUfe7csnveQGvD33jdtwOm5fcDh-eHLLwWMlNfzxrM9hwAeWhUkcFNCAjZitNIsewSHf4LCPbfqgaG8eSIMJ7X07p_Gx-bGz</Value>
+                <Domain>.google.com</Domain>
+                <Path>/</Path>
+                <HttpOnly>True</HttpOnly>
+                <Expires>Thu, 28 Feb 2013 14:32:20 GMT</Expires>
+                <Type>Global</Type>
+              </Cookie>
+            </Cookies>
+            <Message />
+          </WebResult>
+        EOF
+        @client.stub!(:query_api).and_return(xml)
+        cookie_jar = @client.get_cookies('google')
+        cookie_jar.cookies.size.should eq(3)
+        cookie_jar.cookies[0].name.should eq('secure')
+        cookie_jar.cookies[0].domain.should eq('accounts.google.com')
+      end
+
+      it "with invalid domain" do
+        xml = <<-EOF
+          <?xml version="1.0"?>
+          <WebResult xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
+            <Cookies />
+            <Message />
+          </WebResult>
+        EOF
+        @client.stub!(:query_api).and_return(xml)
+        cookie_jar = @client.get_cookies('fsoi')
+        cookie_jar.cookies.should be_empty
+      end
+    end
+
+    ## ------------------------------------------------------------------------------------
+    # Other
+    ## ------------------------------------------------------------------------------------
+
+    it "#parse_options" do
+      @client.send(:parse_options, @options)
+      @options.each do |k, val|
+        @client.send(k).should eq(val)
+      end
+    end
+
+    it "#generate_params" do
+      @client.send(:parse_options, @options)
+      params = @client.send(:generate_params)
+      
+      params[:key].should eq('TEST_KEY')
+      params[:url].should eq("http://grabz.it")
+      params[:width].should eq(800)
+      params[:height].should eq(600)
+      params[:format].should eq("png")
+      params[:bwidth].should eq(1024)
+      params[:bheight].should eq(768)
+      params[:callback].should eq("http://example.com/callback")
+      params[:customid].should eq("12345")
+      params[:delay].should eq(1000)
+      params[:sig].should eq("6419e21afbf4d178894bce8dafa91c6d")
+    end
+
+    it "#generate_signature" do
+      @client.send(:parse_options, @options)
+      signature = @client.send(:generate_signature)
+      signature.should eq('6419e21afbf4d178894bce8dafa91c6d')
+    end
+
+  end
+
+end

data/spec/image_spec.rb

@@ -0,0 +1,27 @@
+require "spec_helper"
+
+describe GrabzIt::Image do
+  before(:each) do
+    raw_image = File.read(File.join(File.dirname(__FILE__), 'test_data', 'test_image.png'))
+    @mocked_response = Struct::MockHTTPResponse.new(raw_image, { 'content-type' => 'image/png' })
+  end
+
+  it "#initialize with successful response" do
+    image = GrabzIt::Image.new(@mocked_response)
+    image.content_type.should eq('image/png')
+    image.size.should eq(129347)
+  end
+
+  it "#initialize with failed response" do
+    lambda { image = GrabzIt::Image.new(nil) }.should raise_error(RuntimeError, "Invalid Response")
+  end
+
+  it "#save" do
+    image = GrabzIt::Image.new(@mocked_response)
+    target = "/tmp/grabz_it_text_image.png"
+    saved_image = image.save(target)
+    File.exist?(target).should be_true
+    File.delete(target) if File.exist?(target) # cleanup
+  end
+
+end

data/spec/response_spec.rb

@@ -0,0 +1,39 @@
+require "spec_helper"
+
+describe GrabzIt::Response do
+
+  it "#initialize with successful response" do
+    xml = <<-EOF
+<?xml version="1.0"?>
+<WebResult xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
+  <Result>True</Result>
+  <ID>Y2F2bmViQGdtYWlsLmNvbQ==-20943258e37c4fc28c4977cd76c40f58</ID>
+  <Message />
+</WebResult>
+    EOF
+
+    api_response = GrabzIt::Response.new(xml)
+    api_response.result.should eq('True')
+    api_response.screenshot_id.should eq('Y2F2bmViQGdtYWlsLmNvbQ==-20943258e37c4fc28c4977cd76c40f58')
+    api_response.message.should be_nil
+    api_response.successful?.should be_true
+  end
+
+  it "#initialize with invalid api key" do
+    xml = <<-EOF
+<?xml version="1.0"?>
+<WebResult xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
+  <Result>False</Result>
+  <ID />
+  <Message>Application Key not recognised.</Message>
+</WebResult>
+    EOF
+
+    api_response = GrabzIt::Response.new(xml)
+    api_response.result.should eq('False')
+    api_response.screenshot_id.should be_nil
+    api_response.message.should eq('Application Key not recognised.')
+    api_response.successful?.should be_false
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,6 @@
+Dir[File.join(File.dirname(__FILE__), "..", "lib", "*.rb")].each do |file|
+  require file
+end
+
+# Used to mock a response from the web service
+Struct.new "MockHTTPResponse", :body, :header

metadata

@@ -0,0 +1,88 @@
+--- !ruby/object:Gem::Specification
+name: grabz_it
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Eric Berry
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-08-29 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Ruby interface to the GrabzIt (grabz.it) service
+email:
+- cavneb@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- grabz_it.gemspec
+- image
+- lib/grabz_it.rb
+- lib/grabz_it/client.rb
+- lib/grabz_it/cookie.rb
+- lib/grabz_it/cookie_jar.rb
+- lib/grabz_it/hash.rb
+- lib/grabz_it/image.rb
+- lib/grabz_it/response.rb
+- lib/grabz_it/status.rb
+- lib/grabz_it/version.rb
+- spec/client_spec.rb
+- spec/image_spec.rb
+- spec/response_spec.rb
+- spec/spec_helper.rb
+- spec/test_data/test_image.png
+homepage: https://github.com/cavneb/grabz_it
+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: Ruby interface to the GrabzIt (grabz.it) service
+test_files:
+- spec/client_spec.rb
+- spec/image_spec.rb
+- spec/response_spec.rb
+- spec/spec_helper.rb
+- spec/test_data/test_image.png
+has_rdoc: