leantesting 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 22d5bd235c58be20d11aa9b8fc8798b81dc4b132
+  data.tar.gz: 3c1ba69babb368011145075410b2c110cdfeb5d5
+SHA512:
+  metadata.gz: 71a387b4baebc3839106c12086b1873430f9df08c43a9e240afd32cc77c309fb955133b476b41812401361c608e75c50f1c309b4d8969afe4a42c55598802b41
+  data.tar.gz: a2136d22593969dce4bd1a288ce5f572e95da312f71ec2ea61b4c8698d58ea4adaa1c228162a1e93e13518efa954656f54167145fe93df3195dc528703b65a0f

data/Gemfile

@@ -0,0 +1,9 @@
+source "https://rubygems.org"
+
+gem 'json', '>=1.8'
+gem 'curb', '>=0.8'
+
+group :test do
+	gem 'minitest', '>=5.8', :require => 'minitest/autorun'
+	gem 'mocha', '>=1.1', :require => 'mocha/mini_test'
+end

data/LICENSE

@@ -0,0 +1,10 @@
+
+Copyright (c) 2015 Lean Testing
+
+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,348 @@
+# Lean Testing Ruby SDK
+
+**Ruby client for [Lean Testing API](https://leantesting.com/en/api-docs)**
+
+You can sign up for a Lean Testing account at [https://leantesting.com](https://leantesting.com).
+
+## Requirements
+
+* Ruby 2.0 or greater
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'leantesting'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install leantesting
+
+## Usage
+
+```ruby
+require 'leantesting'
+
+leantesting = LeanTesting::Client.new
+leantesting.attachToken('<token>')
+
+# Listing projects
+projects = leantesting.projects.all()
+
+# Fetching project bugs
+bugs = leantesting.projects.find(123).bugs.all()
+```
+
+----
+
+- Get Current **Token**
+```ruby
+leantesting.getCurrentToken
+```
+
+- Attach New **Token**
+```ruby
+leantesting.attachToken('<token>')
+```
+
+- Generate **Authorization URL**
+```ruby
+generatedURL = leantesting.auth.generateAuthLink(
+	'<client id>',
+	'<redirect URL>',
+	'<scope>',
+	'<random string>'
+)
+p generatedURL
+```
+
+- Exchange authorization code For **access token**
+```ruby
+token = leantesting.auth.exchangeAuthCode(
+	'<client id>',
+	'<client secret>',
+	'authorization_code',
+	'<auth code>',
+	'<redirect URL>'
+)
+p token
+```
+
+----
+
+- Get **User** Information
+```ruby
+leantesting.user.getInformation
+```
+
+- Get **User** Organizations
+```ruby
+leantesting.user.organizations.all.toArray
+```
+
+----
+
+- List All **Projects**
+```ruby
+leantesting.projects.all.toArray
+```
+
+- Create A New **Project**
+```ruby
+newProject = leantesting.projects.create({
+	'name' => 'Project135',
+	'organization_id' => 5779
+})
+p newProject.data
+```
+
+- Retrieve An Existing **Project**
+```ruby
+leantesting.projects.find(3515).data
+```
+
+
+- List **Project Sections**
+```ruby
+leantesting.projects.find(3515).sections.all.toArray
+```
+
+- Adding A **Project Section**
+```ruby
+newSection = leantesting.projects.find(3515).sections.create({
+	'name' => 'SectionName'
+})
+p newSection.data
+```
+
+
+- List **Project Versions**
+```ruby
+leantesting.projects.find(3515).versions.all.toArray
+```
+
+- Adding A **Project Version**
+```ruby
+newVersion = leantesting.projects.find(3515).versions.create({
+	'number' => 'v0.3.1104'
+})
+p newVersion.data
+```
+
+
+- List **Project Users**
+```ruby
+leantesting.projects.find(3515).users.all.toArray
+```
+
+
+- List **Bug Type Scheme**
+```ruby
+leantesting.projects.find(3515).bugTypeScheme.all.toArray
+```
+
+- List **Bug Status Scheme**
+```ruby
+leantesting.projects.find(3515).bugStatusScheme.all.toArray
+```
+
+- List **Bug Severity Scheme**
+```ruby
+leantesting.projects.find(3515).bugSeverityScheme.all.toArray
+```
+
+- List **Bug Reproducibility Scheme**
+```ruby
+leantesting.projects.find(3515).bugReproducibilityScheme.all.toArray
+```
+
+----
+
+- List All **Bugs** In A Project
+```ruby
+leantesting.projects.find(3515).bugs.all.toArray
+```
+
+- Create A New **Bug**
+```ruby
+newBug = leantesting.projects.find(3515).bugs.create({
+	'title' => 'Something bad happened...',
+	'status_id' => 1,
+	'severity_id' => 2,
+	'project_version_id' => 10242
+})
+p newBug.data
+```
+
+- Retrieve Existing **Bug**
+```ruby
+leantesting.bugs.find(38483).data
+```
+
+- Update A **Bug**
+```ruby
+updatedBug = leantesting.bugs.update(118622, {
+	'title' => 'Updated title',
+	'status_id' => 1,
+	'severity_id' => 2,
+	'project_version_id' => 10242
+})
+p updatedBug.data
+```
+
+- Delete A **Bug**
+```ruby
+leantesting.bugs.delete(118622)
+```
+
+----
+
+- List Bug **Comments**
+```ruby
+leantesting.bugs.find(38483).comments.all.toArray
+```
+
+----
+
+- List Bug **Attachments**
+```ruby
+leantesting.bugs.find(38483).attachments.all.toArray
+```
+
+- Upload An **Attachment**
+```ruby
+filePath = '/place/Downloads/Images/1370240743_2294218.jpg'
+newAttachment = leantesting.bugs.find(38483).attachments.upload(filePath)
+p newAttachment.data
+```
+
+- Retrieve An Existing **Attachment**
+```ruby
+leantesting.attachments.find(21515).data
+```
+
+- Delete An **Attachment**
+```ruby
+leantesting.attachments.delete(75258)
+```
+
+----
+
+- List **Platform Types**
+```ruby
+leantesting.platform.types.all.toArray
+```
+
+- Retrieve **Platform Type**
+```ruby
+leantesting.platform.types.find(1).data
+```
+
+
+- List **Platform Devices**
+```ruby
+leantesting.platform.types.find(1).devices.all.toArray
+```
+
+- Retrieve Existing **Device**
+```ruby
+leantesting.platform.devices.find(11).data
+```
+
+
+- List **OS**
+```ruby
+leantesting.platform.os.all.toArray
+```
+
+- Retrieve Existing **OS**
+```ruby
+leantesting.platform.os.find(1).data
+```
+
+- List **OS Versions**
+```ruby
+leantesting.platform.os.find(1).versions.all.toArray
+```
+
+
+- List **Browsers**
+```ruby
+leantesting.platform.browsers.all.toArray
+```
+
+- Retrieve Existing **Browser**
+```ruby
+leantesting.platform.browsers.find(1).data
+```
+
+- List **Browser Versions**
+```ruby
+leantesting.platform.browsers.find(1).versions.all.toArray
+```
+
+----
+
+- Using **Filters**
+```ruby
+leantesting.projects.find(3515).bugs.all({'limit' => 2, 'page' => 5}).toArray
+```
+
+- **Entity List** Functions
+```ruby
+browsers = leantesting.platform.browsers.all
+p browsers.total
+p browsers.totalPages
+p browsers.count
+p browsers.toArray
+```
+
+- **Entity List** Iterator
+When used in for loops, entity lists will automatically cycle to first page, regardless of `page` filter.
+After ending the loop, the entity list will **NOT** revert to first page or the initial instancing `page` filter setting in order not to cause useless API request calls.
+```ruby
+comments = leantesting.bugs.find(38483).comments.all({'limit' => 1})
+comments.each{ |page| p page }
+```
+
+- **Entity List** Manual Iteration
+```ruby
+comments = leantesting.bugs.find(38483).comments.all({'limit' => 1})
+p comments.toArray
+
+# Will return false if unable to move forwards
+comments.next;      p comments.toArray
+
+# Will return false if already on last page
+comments.last;      p comments.toArray
+
+# Will return false if unable to move backwards
+comments.previous;  p comments.toArray
+
+# Will return false if already on first page
+comments.first;     p comments.toArray
+```
+
+## Security
+
+Need to report a security vulnerability? Send us an email to support@crowdsourcedtesting.com or go directly to our security bug bounty site [https://hackerone.com/leantesting](https://hackerone.com/leantesting).
+
+## Development
+
+Install dependencies:
+
+```bash
+bundle install
+```
+
+## Tests
+
+Install dependencies as mentioned above, then you can run the test suite:
+
+```bash
+rake test
+```

data/Rakefile

@@ -0,0 +1,9 @@
+require 'rake/testtask'
+
+Rake::TestTask.new do |t|
+	t.libs << :test
+	t.test_files = Dir['tests/**/*Test.rb']
+	t.verbose = true
+end
+
+task default: [:test]

data/leantesting.gemspec

@@ -0,0 +1,20 @@
+Gem::Specification.new do |s|
+	s.name        = 'leantesting'
+	s.version     = '1.0.0'
+	s.date        = '2015-11-20'
+	s.platform    = Gem::Platform::RUBY
+	s.summary     = 'Lean Testing Ruby SDK'
+	s.description = 'Lean Testing Ruby SDK'
+	s.authors     = ['Marcel Bontaș']
+	s.email       = ['marcel.bontas@yandex.ru']
+	s.files       = Dir['lib/**/*', 'tests/**/*'] + ['Gemfile', 'leantesting.gemspec', 'LICENSE', 'Rakefile', 'README.md']
+	s.homepage    = 'https://leantesting.com/'
+	s.license     = 'proprietary'
+	s.require_path= 'lib'
+
+	s.add_dependency 'json', '~> 1.8'
+	s.add_dependency 'curb', '~> 0.8'
+
+	s.add_development_dependency 'minitest', '~> 5.8'
+	s.add_development_dependency 'mocha', '~> 1.1'
+end

data/lib/BaseClass/APIRequest.rb

@@ -0,0 +1,195 @@
+#
+# Represents an API Request definition.
+#
+# An APIRequest's parameters can be modified on demand and can be executed multiple times for the same instance.
+#
+class APIRequest
+
+	#
+	# Constructs API request definition.
+	#
+	# Arguments:
+	#	origin   Client -- Originating client reference
+	#	endpoint String     -- API endpoint
+	#	method   String     -- Method for cURL call - supports GET, POST, PUT or DELETE only
+	#	opts     Hash       -- (optional) Additional options to pass to request.
+	#							Request parameters (if any) must bep assed here.
+	#
+	# Exceptions:
+	#	SDKInvalidArgException if method is non-string.
+	#	SDKInvalidArgException if unsupported method is provided.
+	#	SDKInvalidArgException if endpoint is non-string.
+	#	SDKInvalidArgException if opts param is not a hash.
+	#
+	def initialize(origin, endpoint, method, opts = nil)
+		@default_ops = {									# Basic support for extended opts
+			'base_uri'	=> 'https://api.leantesting.com',	# assumed default for API base
+			'form_data'	=> false,							# sets content type to multipart/form-data if true
+			'params'	=> {}								# params to be pased in request
+		}
+
+		if !opts
+			opts = {}
+		end
+
+		if !method.is_a? String
+			raise SDKInvalidArgException, '`method` must be a string'
+		elsif !['GET', 'POST', 'PUT', 'DELETE'].include? method
+			raise SDKInvalidArgException, 'unsupported ' + method + ' `method`'
+		elsif !endpoint.is_a? String
+			raise SDKInvalidArgException, '`endpoint` must be a string'
+		elsif !opts.is_a? Hash
+			raise SDKInvalidArgException, '`opts` must be a hash'
+		end
+
+		@opts = @default_ops.clone
+		self.updateOpts(opts)
+
+		@origin		= origin
+		@endpoint	= endpoint
+		@method		= method
+	end
+
+	#
+	# Updates options list inside API request definition.
+	#
+	# Arguments:
+	#	opts Hash -- (optional) Additional options array to merge with previous option values
+	#
+	# Exceptions:
+	#	SDKInvalidArgException if opts param is not a hash.
+	#	SDKInvalidArgException if provided parameter list is non-hash parameter.
+	#
+	def updateOpts(opts = nil)
+		if !opts
+			opts = {}
+		end
+
+		if !opts.is_a? Hash
+			raise SDKInvalidArgException, '`opts` must be a hash'
+		elsif opts.has_key? 'params' && !opts['params'].is_a?(Hash)
+			raise SDKInvalidArgException '`opts[\'params\']` must be a hash'
+		end
+
+		@opts.merge!(opts)
+	end
+
+	#
+	# Executes cURL call as per current API definition state.
+	#
+	# Returns:
+	#	String -- Returns resulting data response from server (including errors and inconsistencies)
+	#
+	def call
+
+		ch = Curl::Easy.new
+
+		callUrl = @opts['base_uri'] + @endpoint
+
+		if @origin.getCurrentToken.is_a? String
+			ch.headers['Authorization'] = 'Bearer ' + @origin.getCurrentToken
+		end
+
+		ch.url = callUrl
+
+		ch.header_in_body = false
+
+		case @method
+		when 'GET'
+			callUrl += '?' + Curl::postalize(@opts['params'])
+			ch.url = callUrl
+
+			ch.http_get
+		when 'POST'
+			if @opts['form_data'] == true && (@opts.has_key? 'file_path')
+				ch.headers['Content-Type'] = 'multipart/form-data'
+				ch.multipart_form_post = true
+
+				ch.http_post(Curl::PostField.file('file', @opts['file_path']))
+			else
+				jsonData = JSON.generate(@opts['params'])
+
+				ch.headers['Content-Type'] = 'application/json'
+				ch.headers['Content-Length'] = jsonData.length
+
+				ch.http_post(jsonData)
+			end
+		when 'PUT'
+			jsonData = JSON.generate(@opts['params'])
+
+			ch.headers['Content-Type'] = 'application/json'
+			ch.headers['Content-Length'] = jsonData.length
+
+			ch.http_put(jsonData)
+		when 'DELETE'
+			ch.http_delete
+		end
+
+		curlData	= ch.body_str
+		curlStatus	= ch.status.to_i()
+
+		ch.close
+		ch = nil
+
+		{
+			'data' => curlData,
+			'status' => curlStatus
+		}
+	end
+
+	#
+	# Does cURL data interpretation
+	#
+	# Exceptions:
+	#	SDKErrorResponseException   if the remote response is an error.
+	#		A server response is interpreted as an error if obtained status code differs from expected status code.
+	#		Expected status codes are `200 OK` for GET/POST/PUT, `204 No Content` for DELETE.
+	#	SDKBadJSONResponseException if the remote response contains erronated or invalid JSON contents
+	#
+	# Returns:
+	#	Hash    -- In case of successful request, a JSON decoded object is returned.
+	#	Boolean -- If a DELETE request is issued, returns true if call is successful (exception otherwise).
+	#
+	def exec
+		if @origin.debugReturn && @origin.debugReturn.has_key?('data') && @origin.debugReturn.has_key?('status')
+
+			curlData = @origin.debugReturn['data']
+			curlStatus = @origin.debugReturn['status']
+
+		else
+
+			callReturn = call
+			curlData = callReturn['data']
+			curlStatus = callReturn['status']
+
+		end
+
+		if @method == 'DELETE'
+			expectedHTTPStatus = 204
+		else
+			expectedHTTPStatus = 200
+		end
+
+		if curlStatus != expectedHTTPStatus
+			raise SDKErrorResponseException, curlStatus.to_s() + ' - ' + curlData
+		end
+
+		if @method == 'DELETE'				# if DELETE request, expect no output
+			return true
+		end
+
+		begin
+			jsonData = JSON.parse(curlData)	# normally, expect JSON qualified output
+		rescue JSON::ParserError
+			raise SDKBadJSONResponseException, curlData
+		end
+
+		if jsonData.length.zero?
+			raise SDKUnexpectedResponseException, 'Empty object received'
+		end
+
+		return jsonData
+
+	end
+
+end