appurify 0.5

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: b7d5bc4ad41dcb6b3ca21b0ac0e94f9a8b9bd03d
+  data.tar.gz: de2314d5b7d454c8fe341e27129bf785c4073d79
+SHA512:
+  metadata.gz: 33b869fbd81c20d9a7fd3c67b9bf471d74d6446c7b6acb73d698e690f2cb74b95d2d341ad095262b02f4c453971bd5c8d09c3ff2a03814adf0d1e92d9f3d113a
+  data.tar.gz: b16cb51f7486e3e0a1f3a0e99618ec54e0ea9b34e1e590b16cdd88e0acafcb1d5fe09dfcb9e7afbb0fb5d03af0617f78e5cfc74698edac6342f6fdf273211d3b

data/README.md

@@ -0,0 +1,54 @@
+# Appurify Gem
+
+The official Ruby client for the [Appurify](http://www.appurify.com) API.
+
+### Installation
+
+```
+gem install appurify
+```
+
+### Configuration
+
+```
+client = Appurify::Client.new(key, secret, options)
+```
+
+### Listing Device Types
+
+```
+device_types = client.device_types
+device_type_id = client.device_types.first["device_type_id"]
+```
+
+### Uploading An Application
+
+```
+response = client.upload_app_from_url(app_url)
+application_id = response["app_id"]
+```
+
+### Uploading A Test
+
+```
+test_type = "uiautomation"
+response = client.upload_test_from_url(test_url, test_type)
+test_id = response["test_id"]
+```
+
+### Starting A Test Run
+
+```
+response = client.run_test(device_type_id, application_id, test_id)
+test_run_id = response["test_run_id"]
+```
+
+### Retrieve Test Run Results
+
+```
+response = client.monitor_test(test_run_id)
+```
+
+### Contribution
+
+Found a bug or want to add a much needed feature?  Go for it and just send us the Pull Request!

data/lib/appurify.rb

@@ -0,0 +1,10 @@
+require 'open-uri'
+require 'json'
+require 'net/https'
+require 'rest-client'
+require 'appurify/version'
+require 'appurify/client'
+
+module Appurify
+  HOSTNAME = "live.appurify.com"
+end

data/lib/appurify/client.rb

@@ -0,0 +1,145 @@
+module Appurify
+  class Client
+    attr_accessor :scheme, :host, :port, :key, :secret, :request_timeout, :open_timeout, :last_request
+    
+    def initialize(key, secret, options={})
+      @key = key
+      @secret = secret
+      
+      @scheme, @host, @port, @request_timeout, @open_timeout = {
+        scheme: "https",
+        host: HOSTNAME,
+        port: 443,
+        request_timeout: 600,
+        open_timeout: 10
+      }.merge(options).values
+    end
+    
+    def access_token
+      unless access_token_active?
+        url = build_url("access_token", "generate")
+        data = {
+          :key => @key,
+          :secret => @secret
+        }
+
+        #result = post(url, data, false)
+        result = post(url, data)
+        @access_token = result["access_token"]
+        @access_token_ttl = result["ttl"]
+        @access_token_created = Time.now
+      end
+
+      @access_token
+    end
+    
+    def device_types
+      url = build_url("devices", "list")
+      get(url)
+    end
+    
+    def network_conditions
+      url = build_url("devices", "config/networks/list")
+      get(url)
+    end
+    
+    def upload_app_from_url(app_url)
+      url = build_url("apps", "upload")
+      data = {
+        :access_token => access_token,
+        :source_type => "url",
+        :source => app_url
+      }
+
+      post(url, data)
+    end
+
+    def upload_test_from_url(test_url, test_type)
+      url = build_url("tests", "upload")
+      data = {
+        :access_token => access_token,
+        :source_type => "url",
+        :test_type => test_type,
+        :source => test_url
+      }
+
+      post(url, data)
+    end
+    
+    def upload_device_conditions(test_id, conditions)
+      url = build_url("config", "upload")
+      file_data = "[appurify]\n" +  conditions.keys.collect{ |k| k.to_s + "=" + conditions[k].to_s }.join("\n")
+      
+      file = StringIO.new(file_data)
+      file.class.class_eval { attr_accessor :name }
+      file.class.class_eval { attr_accessor :path }
+      file.name = "config.cnf"
+      file.path = "config.cnf"
+      
+      data = {
+        :access_token => access_token,
+        :test_id => test_id,
+        :source => file
+      }
+      
+      post(url, data)
+    end
+
+    def run_test(device_type_id, app_id, test_id, async=1)
+      url = build_url("tests", "run")
+      data = {
+        :access_token => access_token,
+        :device_type_id => device_type_id,
+        :app_id => app_id,
+        :test_id => test_id,
+        :async => async
+      }
+
+      post(url, data)
+    end
+    
+    def monitor_test(test_run_id)
+      url = build_url("tests", "check")
+      params = { test_run_id: test_run_id }
+      get(url, params)
+    end
+    
+    private
+    
+    def access_token_active?
+      @access_token && Time.now < @access_token_created + @access_token_ttl
+    end
+    
+    def build_url(type, resource)
+      @scheme + "://" + [@host, "resource", type, resource].join("/") + "/"
+    end
+    
+    def get(url, params={})
+      @last_request = {
+        url: url,
+        request: params
+      }
+      
+      query_string_params = params.collect{ |p| "&#{p[0].to_s}=#{p[1].to_s}" }.join
+      result = RestClient::Request.execute(:method => :get, :url => "#{url}?access_token=#{access_token}#{query_string_params}", :timeout => @request_timeout, :open_timeout => @open_timeout)
+      @last_request[:response] = result
+      
+      JSON.parse(result)["response"]
+    end
+    
+    def post(url, data, capture_request=true)
+      if capture_request
+        @last_request = {
+          url: url,
+          request: data
+        }
+      end
+      
+      result = RestClient::Request.execute(:method => :post, :url => url, :payload => data, :timeout => @request_timeout, :open_timeout => @open_timeout)
+      @last_request[:response] = result if capture_request
+      
+      JSON.parse(result)["response"]
+    end
+    
+  end
+end

data/lib/appurify/version.rb

@@ -0,0 +1,3 @@
+module Appurify
+  VERSION = '0.5'
+end

data/spec/client/client_spec.rb

@@ -0,0 +1,130 @@
+require 'spec_helper'
+require 'fake_web'
+require 'timecop'
+
+describe Appurify do
+  
+  let (:key) { "7ks6hmigudkbx3uuipgmqllhcoqmxf5mq" }
+  let (:secret) { "270td4563wpj2auoct4yu4tqx5kv4kotp" }
+  
+  before do
+    FakeWeb.allow_net_connect = false
+  end
+  
+  describe "When configuring an Appurify Client" do
+    
+    it "should correctly configure the key and secret" do
+      client = Appurify::Client.new(key, secret)
+      client.key.should == key
+      client.secret.should == secret
+    end
+    
+    it "should correctly configure connection options" do
+      options = {
+        scheme: "http",
+        host: "staging.appurify.com",
+        port: 80,
+        request_timeout: 5,
+        open_timeout: 5
+      }
+      
+      client = Appurify::Client.new(key, secret, options)
+      client.scheme.should == options[:scheme]
+      client.host.should == options[:host]
+      client.port.should == options[:port]
+      client.request_timeout.should == options[:request_timeout]
+      client.open_timeout.should == options[:open_timeout]
+    end
+    
+  end
+  
+  describe "When using an Appurify Client" do
+    
+    let (:client) { Appurify::Client.new(key, secret) }
+    let (:token) { "e8k3jd64gfrgbtqrunaipx9pl34xkao6c" }
+    let (:ttl) { 86400 }
+    let (:application_id) { "lvq2g2y6hn0sr36k9i9mrcochh49tbww3" }
+    let (:test_id) { "d9yovkaekgg29c3d2nr4guhfppe0jewra" }
+    let (:test_type) { "ocunit" }
+    let (:device_type) { 1 }
+    let (:device_id) { 10 }
+    let (:app_url) { "https://www.cisimple.com/builds/1/build_steps/1/artifacts/cisimple.app.zip" }
+    let (:test_url) { "https://www.cisimple.com/builds/1/build_steps/1/artifacts/cisimple.octest.zip" }
+    
+    before do
+      mock_access_token_response(token, ttl)
+      mock_application_upload_response(application_id)
+      mock_test_upload_response(test_id, test_type)
+      mock_run_test_response
+      mock_monitor_test_response(token)
+      mock_upload_device_conditions_response
+      mock_device_types_response(token)
+      mock_network_conditions_response(token)
+    end
+    
+    it "should successfully retrieve an access token" do
+      client.access_token.should == token
+    end
+    
+    it "should cache access tokens" do
+      client.access_token
+      FakeWeb.clean_registry
+      mock_access_token_response
+      client.access_token.should == token
+    end
+    
+    it "should retrieve a new access token when the current one has expired" do
+      client.access_token
+      FakeWeb.clean_registry
+      expected_token = "2hmiusynojjtgxsnd6eqdop1lreeua56i"
+      mock_access_token_response(expected_token)
+      Timecop.travel(Time.now + ttl + 1)
+      client.access_token.should == expected_token
+    end
+    
+    it "should successfully upload an application from a url" do
+      response = client.upload_app_from_url(app_url)
+      response["id"].should == application_id
+    end
+    
+    it "should successfully upload a test from a url" do
+      response = client.upload_test_from_url(test_url, test_type)
+      response["id"].should == test_id
+      response["test_type"].should == test_type
+    end
+    
+    it "should successfully start a test on a device" do
+      test_run_id = 5
+      mock_run_test_response(test_run_id)
+      response = client.run_test(device_id, application_id, test_id)
+      response["test_run_id"].should == test_run_id
+    end
+    
+    it "should successfully monitor a test run" do
+      test_run_id = 5
+      mock_monitor_test_response(token, test_run_id)
+      response = client.monitor_test(test_run_id)
+      response["status"].should == "complete"
+    end
+    
+    it "should successfully retrieve the list of device types" do
+      response = client.device_types
+      response.count.should == 2
+    end
+    
+    it "should successfully retrieve the list of network conditions" do
+      client.network_conditions.count.should == 5
+    end
+    
+    it "should be able to execute a test end to end" do
+      device_type = client.device_types.first["id"]
+      app_id = client.upload_app_from_url(app_url)["id"]
+      test_id = client.upload_test_from_url(test_url, test_type)["id"]
+      client.upload_device_conditions(test_id, {:memory => 300, :network => 5})
+      test_run_id = client.run_test(device_type, app_id, test_id)["test_run_id"]
+      client.monitor_test(test_run_id)
+    end
+    
+  end
+  
+end

data/spec/spec_helper.rb

@@ -0,0 +1,62 @@
+require 'rspec'
+require 'appurify'
+
+RSpec.configure do |config|
+  config.color_enabled = true
+  config.formatter     = 'documentation'
+end
+
+def mock_access_token_response(token="r895ku94f167udxfukhkbntyclxvwl8sc", ttl=86400)
+  url = "https://live.appurify.com/resource/access_token/generate/"
+  response ="{\"meta\": {\"code\": 200, \"request_id\": 123.456}, \"response\": {\"access_token\": \"#{token}\", \"ttl\": #{ttl}}}"
+  FakeWeb.register_uri(:post, url, :body => response, :status => 200)
+end
+
+def mock_application_upload_response(application_id="qxp58i5tbaosgbq8nagosfkf490gs7spd")
+  url = "https://live.appurify.com/resource/apps/upload/"
+  response = "{\"meta\": {\"code\": 200, \"request_id\": 123}, \"response\": {\"name\": \"cisimple.app.zip\", \"test_type\": null, \"uploaded_on\": \"2013-03-13T21:39:59Z\", \"source_type\": \"url\", \"ttl\": 86400, \"id\": \"#{application_id}\", \"size\": 404423}}"
+  FakeWeb.register_uri(:post, url, :body => response, :status => 200)
+end
+
+def mock_test_upload_response(test_id="eh4x44nspdqcsva7v2nvabjesvoqvcn89", test_type="ocunit")
+  url = "https://live.appurify.com/resource/tests/upload/"
+  response = "{\"meta\": {\"code\": 200, \"request_id\": 452}, \"response\": {\"name\": \"cisimpleTests.octest.zip\", \"test_type\": \"#{test_type}\", \"uploaded_on\": \"2013-03-13T22:12:50Z\", \"source_type\": \"url\", \"ttl\": 86400, \"id\": \"#{test_id}\", \"size\": 7764}}"
+  FakeWeb.register_uri(:post, url, :body => response, :status => 200)
+end
+
+def mock_run_test_response(test_run_id=1)
+  url = "https://live.appurify.com/resource/tests/run/"
+  response = "{\"meta\": {\"code\": 200, \"request_id\": 123}, \"response\": { \"test_run_id\": #{test_run_id} }}"
+  FakeWeb.register_uri(:post, url, :body => response, :status => 200)
+end
+
+def mock_upload_device_conditions_response
+  url = "https://live.appurify.com/resource/config/upload/"
+  response = "{\"meta\": {\"code\": 200, \"request_id\": 123}, \"response\": { }}"
+  FakeWeb.register_uri(:post, url, :body => response, :status => 200)
+end
+
+def mock_monitor_test_response(access_token, test_run_id=1, status="complete")
+  url = "https://live.appurify.com/resource/tests/check/?access_token=#{access_token}&test_run_id=#{test_run_id}"
+  response = "{\"meta\": {\"code\": 200, \"request_id\": 123}, \"response\": { \"status\": \"#{status}\" }}"
+  FakeWeb.register_uri(:get, url, :body => response, :status => 200)
+end
+
+def mock_device_types_response(access_token)
+  url = "https://live.appurify.com/resource/devices/list/?access_token=#{access_token}"
+  response = "{\"meta\": {\"code\": 200, \"request_id\": 475}, \"response\": [{\"device_type_id\": 1, \"name\": \"4s\", \"battery\": true, \"brand\": \"iPhone\", \"os_name\": \"iOS\", \"os_version\": \"5.1.1\", \"has_available_device\": false, \"carrier\": null}, {\"device_type_id\": 2, \"name\": \"4\", \"battery\": true, \"brand\": \"iPhone\", \"os_name\": \"iOS\", \"os_version\": \"5.1.1\", \"has_available_device\": true, \"carrier\": null}]}"
+  FakeWeb.register_uri(:get, url, :body => response, :status => 200)
+end
+
+
+def mock_network_conditions_response(access_token)
+  url = "https://live.appurify.com/resource/devices/config/networks/list/?access_token=#{access_token}"
+  response = "{\"meta\": {\"code\": 200, \"request_id\": 9673}, \"response\": [
+    {\"network_id\": 29, \"network_group\": \"AT&T\", \"network_name\": \"4G_LTE\"}, 
+    {\"network_id\": 16, \"network_group\": \"AT&T\", \"network_name\": \"3G_4_Bars\"}, 
+    {\"network_id\": 17, \"network_group\": \"AT&T\", \"network_name\": \"3G_3_Bars\"}, 
+    {\"network_id\": 18, \"network_group\": \"AT&T\", \"network_name\": \"3G_2_Bars\"}, 
+    {\"network_id\": 19, \"network_group\": \"AT&T\", \"network_name\": \"3G_1_Bar\"}]}"
+  FakeWeb.register_uri(:get, url, :body => response, :status => 200)
+end
+

metadata

@@ -0,0 +1,108 @@
+--- !ruby/object:Gem::Specification
+name: appurify
+version: !ruby/object:Gem::Version
+  version: '0.5'
+platform: ruby
+authors:
+- Kevin Rohling
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-08-20 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rest-client
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.11'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.11'
+- !ruby/object:Gem::Dependency
+  name: fakeweb
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.30'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.30'
+- !ruby/object:Gem::Dependency
+  name: timecop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.60'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.60'
+description: API client for Appurify
+email:
+- support@appurify.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- README.md
+- lib/appurify.rb
+- lib/appurify/client.rb
+- lib/appurify/version.rb
+- spec/client/client_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/appurify/appurify-ruby
+licenses: []
+metadata: {}
+post_install_message: 
+rdoc_options:
+- --charset=UTF-8
+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.6
+signing_key: 
+specification_version: 4
+summary: Run tests using Appurify's mobile devices.
+test_files:
+- spec/client/client_spec.rb
+- spec/spec_helper.rb