crossbrowsertesting-gem 0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 10a609d074bd06edaf8c7c1730f1610d61ded928
+  data.tar.gz: 6a729c664d48a8cfdecf7dd3b9d8c60acd9c1117
+SHA512:
+  metadata.gz: d3852c836124b355cd86674aaa07881909253fa98fd5353904d70c3b7f132dfab5250948420589064c33cc13c61b44a37c32dd3381f12a5c7b85804ac6a0c40d
+  data.tar.gz: 7d5d0e11365a6ea7858ef1a2a7df139860ffab87bea3169b06c6170f7167e3a465fb6fbdfa321e260b469e9642e98bb016b29e7f0e5c48d42a5957fff2f86965

data/.gitignore

@@ -0,0 +1 @@
+lib/.DS_Store

data/Gemfile

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

data/README.md

@@ -0,0 +1,117 @@
+# CrossBrowserTesting Screenshots
+
+A ruby gem for [CrossBrowserTesting](http://crossbrowsertesting.com)'s screenshots API.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'crossbrowsertesting-gem'
+
+And then execute:
+
+    bundle
+
+Or install it yourself as:
+
+    gem install crossbrowsertesting-gem
+
+## Examples of use
+
+If you are not using Rails, you'll need to require the gem:
+
+``` ruby
+require 'CBT'
+```
+
+### Create a client
+Creates a new client instance.
+
+``` ruby
+client = CBT.new('username', 'password')
+```
+
+###API
+
+#### Take a screenshot
+Queues up a request for a screenshot
+
+``` ruby
+params = {
+  :url => 'http://darrennix.com',
+  :delay => 5,
+}
+request = client.take_screenshot(params)
+```
+
+#### Check the status of a screenshot request
+Returns true or false for completion status
+
+``` ruby
+test = request[:test][:id]
+version = request[:test][:version][:id]
+completed = client.status(test, version)
+```
+
+#### Load the full results of a screenshot request
+``` ruby
+results = client.results(test, version)
+
+results[:test][:version][:results].each do |screenshot|
+    puts screenshot[:images][:fullpage]
+end
+```
+
+#### Get available os and browsers
+Fetches all available browsers.
+
+Rather than using this list to construct a set of browsers for testing, I recommend saving a list of
+browser configurations through the main site and then referencing that list by name in your "take_screenshot" params.
+
+``` ruby
+puts client.browsers 	#returns a hash
+
+{
+    :error=>0, 
+    :message=>"", 
+    :oss=>[
+        {
+            :name=>"Android 4.0 Simulator", 
+            :api_name=>"Android4.0", 
+            :type=>"Android", 
+            :version=>"4.0", 
+            :device=>"mobile", 
+            :icon=>"http://crossbrowsertesting.com/images/software_logos/android15.png", 
+            :browsers=>[
+                {
+                    :name=>"Android Browser 4.0", 
+                    :api_name=>"Android4.0", 
+                    :type=>"Android Browser", 
+                    :version=>"4.0", 
+                    :device=>"mobile", 
+                    :major_browser=>1, 
+                    :icon=>"http://crossbrowsertesting.com/images/software_logos/android-browser15.png",
+                    :default_config=>"Android4.0"
+                }
+            ], 
+            :other_software=>[
+                {
+                    :name=>"Base install - no additional software added", 
+                    :type=>"None", 
+                    :version=>"", 
+                    :icon=>"http://crossbrowsertesting.com/images/software_logos/15.png"
+                }
+            ], 
+            :resolutions=>[
+                {
+                    :name=>"480x800", 
+                    :width=>480, 
+                    :height=>800, 
+                    :default=>1
+                }
+            ]
+        },
+        ...
+    ]
+}
+```

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/cbt.gemspec

@@ -0,0 +1,19 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+
+Gem::Specification.new do |s|
+  s.name        = "crossbrowsertesting-gem"
+  s.version     = '0.1'
+  s.authors     = ["Darren Nix"]
+  s.email       = ["low@darrennix.com"]
+  s.homepage    = "http://darrennix.com"
+  s.summary     = "Ruby helper for crossbrowsertesting.com API"
+  s.description = "Ruby helper for crossbrowsertesting.com API"
+
+  s.files         = `git ls-files`.split("\n")
+  s.require_paths = ["lib"]
+
+  s.add_development_dependency "rake"
+  s.add_dependency("yajl-ruby", "1.1.0")
+
+end

data/lib/crossbrowsertesting-gem.rb

@@ -0,0 +1,63 @@
+require "base64"
+require "net/http"
+require "yajl"
+
+class CBT
+        
+  API = "http://crossbrowsertesting.com/api/v2/screenshots"
+  
+  def initialize(username=nil, password=nil)
+    raise "Expected username and password" unless username && password
+    @username = username
+    @password = password
+  end
+  
+  def browsers
+    make_post_request('browsers')
+  end
+  
+  def take_screenshot(params)
+    make_post_request('run', params)
+  end
+  
+  def status(test, version)
+    response = make_post_request("#{test}/version/#{version}/status")
+    
+    puts "-----------status #{test} #{version}"
+    puts response
+    response[:complete] == 1 ? true : false
+  end
+
+  def results(test, version)
+    make_post_request("#{test}/version/#{version}/show")
+  end
+
+  private
+  
+  def make_post_request(action, params = {})
+    params[:format] = 'json'
+    uri = URI("#{API}/#{action}")
+    request = Net::HTTP::Post.new(uri)
+    request.set_form_data(params)
+    request.basic_auth(@username, @password)
+    result = Net::HTTP.start(uri.hostname, uri.port) {|http|
+      http.request(request)
+    }
+    
+    parser = Yajl::Parser.new(:symbolize_keys => true)
+    begin
+      output = parser.parse(result.body)[:response]
+      if output[:error] != 0 
+        raise GeneralError, output[:message]
+      end
+    rescue Yajl::ParseError
+      raise GeneralError, result.body
+    end
+    
+    output
+  end
+
+  class GeneralError < StandardError
+  end
+  
+end #Client    

metadata

@@ -0,0 +1,77 @@
+--- !ruby/object:Gem::Specification
+name: crossbrowsertesting-gem
+version: !ruby/object:Gem::Version
+  version: '0.1'
+platform: ruby
+authors:
+- Darren Nix
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-06-22 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: yajl-ruby
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.1.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.1.0
+description: Ruby helper for crossbrowsertesting.com API
+email:
+- low@darrennix.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- README.md
+- Rakefile
+- cbt.gemspec
+- lib/crossbrowsertesting-gem.rb
+homepage: http://darrennix.com
+licenses: []
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.0.3
+signing_key: 
+specification_version: 4
+summary: Ruby helper for crossbrowsertesting.com API
+test_files: []