ruby_vsts 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: f231587e2fb121259d565337ac2563a0d903b383
+  data.tar.gz: 6767463306762c36b6989d39a6edc20e84d3db88
+SHA512:
+  metadata.gz: 1b5e22b6d5a3aa91e66fb8f752fc07beefa5dcc05653999586a9b878fbe79f1d0e16b8f9edbe2aacf76132ef52acbd759bc4efa6378c3076f7ed7aa5383817cb
+  data.tar.gz: f309cb3aa500a76dd3e16820a35cf5ef11d4cbd7ba83a73b59db3241a52d7d187461023722d86bde807671127b50e5969859798d66579e537c8d70f481e1567d

checksums.yaml.gz.sig

@@ -0,0 +1,3 @@
+3��Y���J��\�q'�HnB"0)��yU.��8 j�%�KX{�w7��_�ыa��0&ޏoV�-Џp���e6PC�p�!Z��P9��P�O�d���"M�R좕�ov��V�cz�ř�.��ag�y�<�	���}n���)�Gmg�z��n�.�)x��ZC�I1��
+h+cX}��\��}�
+?@�����N�"<ǭ�brԔo�Q���V9�r��,%�Xv	�&�u����ܟ>_S��1E���H�g�l"˕b_'-

data/.codeclimate.yml

@@ -0,0 +1,18 @@
+engines:
+  duplication:
+    enabled: true
+    config:
+      languages:
+        - ruby
+  fixme:
+    enabled: true
+  rubocop:
+    enabled: true
+ratings:
+  paths:
+    - lib/**
+    - "**.rb"
+
+exclude_paths:
+  - spec/**/*
+  - vendor/**/*

data/.gitignore

@@ -0,0 +1,25 @@
+# Gem builds
+pkg/
+*.gem
+
+# Bundler files
+.bundle
+Gemfile.lock
+
+# Ignore Byebug command history file.
+.byebug_history
+
+# SimpleCov code coverage reports
+/coverage
+
+# CodeClimate repo token to report code coverage
+# See https://codeclimate.com/repos/58ea190f4e4fc9029400296b/coverage_setup
+.codeclimate_repo_token
+
+# Yard documentation files
+.yardoc/
+doc/
+
+# Temporary backups, unneeded files
+*.old
+*.orig

data/.rspec

@@ -0,0 +1 @@
+--color

data/.rubocop.yml

@@ -0,0 +1,44 @@
+AllCops:
+  DisplayCopNames: true
+
+Rails:
+  Enabled: false
+
+Style/StringLiterals:
+  Enabled: false
+  # EnforcedStyle: double_quotes # if enabled, this can be single_quotes or double_quotes
+
+Style/SymbolArray:
+  Enabled: false
+
+Style/WordArray:
+  Enabled: false
+
+Style/RegexpLiteral:
+  Enabled: false
+
+Metrics/LineLength:
+  Max: 135
+  # To make it possible to copy or click on URIs in the code, we allow lines
+  # containing a URI to be longer than Max.
+  AllowHeredoc: true
+  AllowURI: true
+  URISchemes:
+    - http
+    - https
+
+Metrics/MethodLength:
+  CountComments: false  # count full line comments?
+  Max: 25
+
+Metrics/AbcSize:
+  # The ABC size is a calculated magnitude, so this number can be a Fixnum or
+  # a Float.
+  Max: 40
+
+Metrics/CyclomaticComplexity:
+  # even 15 may still be acceptable
+  Max: 10
+
+Metrics/PerceivedComplexity:
+  Max: 10

data/.yardopts

@@ -0,0 +1,8 @@
+--charset UTF-8
+--main README.md
+--title 'Ruby VSTS Documentation'
+--no-private
+--markup=markdown
+-
+LICENSE.txt
+README.md

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/LICENSE.txt

@@ -0,0 +1,19 @@
+Copyright (c) 2017 Gabor Lengyel and Prodexity Ltd.
+
+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,47 @@
+# ruby_vsts
+An unofficial Microsoft Visual Studio Team Services (VSTS) API client in Ruby
+
+[![Code Climate](https://codeclimate.com/github/prodexity/ruby_vsts.png)](https://codeclimate.com/github/prodexity/ruby_vsts)
+[![Issue Count](https://codeclimate.com/github/prodexity/ruby_vsts/badges/issue_count.svg)](https://codeclimate.com/github/prodexity/ruby_vsts)
+[![Test Coverage](https://codeclimate.com/github/prodexity/ruby_vsts/badges/coverage.svg)](https://codeclimate.com/github/prodexity/ruby_vsts/coverage)
+
+## About
+This will be a Ruby gem to connect to the Microsoft Visual Studio online (VSTS) Rest API.
+It may also work with recent versions of TFS too. *Work is heavily in progress!*
+
+## Usage
+
+### Setup
+```ruby
+require 'ruby_vsts'
+
+VSTS.configure do |config|
+  config.personal_access_token = "YOUR_PERSONAL_ACCESS_TOKEN"
+  config.base_url = "https://YOUR_INSTANCE.visualstudio.com/"
+end
+```
+
+### Finding changesets
+```ruby
+VSTS::Changeset.find(72300) # find changeset by id
+VSTS::Changeset.find_all(author: "fabrikam13@hotmail.com") # find by author
+VSTS::Changeset.find_all(fromId: 1000, toId: 1200) # find by id range
+VSTS::Changeset.find_all(fromDate: "03-01-2017", toDate: "03-18-2017-2:00PM") # find by date range
+VSTS::Changeset.find_all(itemPath: "$/Fabrikam-Fiber-TFVC/Program.cs") # find by item path
+VSTS::Changeset.find_all(top: 20, skip: 100) # paging
+# ...
+```
+
+### Getting changes in a changeset
+```ruby
+changeset = VSTS::Changeset.find(72300)
+changes = changeset.changes
+```
+
+### Getting change items
+```ruby
+item = changes[0]
+file_contents = item.get # current version
+```
+
+Please see specs and the source code for further examples.

data/Rakefile

@@ -0,0 +1,14 @@
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:test)
+
+task test_and_report: [:test, :report_coverage]
+
+task :report_coverage do
+  ENV["CODECLIMATE_REPO_TOKEN"] = File.read(".codeclimate_repo_token") if File.exist?(".codeclimate_repo_token")
+  `codeclimate-test-reporter`
+end
+
+desc "Run tests and report coverage to CodeClimate"
+task default: :test_and_report

data/certs/ruby_vsts-gem-public_cert.pem

@@ -0,0 +1,21 @@
+-----BEGIN CERTIFICATE-----
+MIIDhTCCAm2gAwIBAgIBATANBgkqhkiG9w0BAQUFADBEMRIwEAYDVQQDDAlydWJ5
+X3ZzdHMxGTAXBgoJkiaJk/IsZAEZFglwcm9kZXhpdHkxEzARBgoJkiaJk/IsZAEZ
+FgNjb20wHhcNMTcwNDEyMDk1MzE1WhcNMTgwNDEyMDk1MzE1WjBEMRIwEAYDVQQD
+DAlydWJ5X3ZzdHMxGTAXBgoJkiaJk/IsZAEZFglwcm9kZXhpdHkxEzARBgoJkiaJ
+k/IsZAEZFgNjb20wggEiMA0GCSqGSIb3DQEBAQUAA4IBDwAwggEKAoIBAQCnth7a
+Innh/5+zT5rdwHMySmQG2qyuNh5ammn4ZleFvkZxDPpFb5Kn+BeoR8O3OWEe5WEs
+4FUR/43Ow1HzYMIJIIb6MxNZyZQj6Bm+cKZPctL/h0KjC7kG+2aRdUCsfFKoZvMZ
+69yHxtArNtbt6dIRsic8CHioQe0i6/7BVD/1OKKt600dt1K1zf7j7T8xWIdCwbO8
+zWE4GpEBnEA4mBPMKqAZmd+DsqrbCWPie8TdfGeWo71/7rUuCbAUpMq4Rh3SpmfV
+t0OQMShhuAaLoRLuIZ48hiC3ELAr9ZCK8rn5Ci2trLEVjyOvbq/QnwnGspydlyaN
+xzGpH5p82DwcUP5TAgMBAAGjgYEwfzAJBgNVHRMEAjAAMAsGA1UdDwQEAwIEsDAd
+BgNVHQ4EFgQUYZTJdcOOpive/ZTgo5EYhS98qUUwIgYDVR0RBBswGYEXcnVieV92
+c3RzQHByb2RleGl0eS5jb20wIgYDVR0SBBswGYEXcnVieV92c3RzQHByb2RleGl0
+eS5jb20wDQYJKoZIhvcNAQEFBQADggEBAFiM7TEAsjlwjCyCMlzw0Yq/igWgaaFP
+of+iPXZUC49YMTpXnQjNl9sE+cxHzkJzyM00YdeJ18DDtquIZ44Hdd30J9oleJ5g
+DgGCX4bCKg5WTBwqvd0ivATn9uxDxLF1VP/cl1MJPXhW8+Bhq2FzbyWvQuxHeFsI
+jJNJdpaL4UgxvhYECxAd1gzvIpRFbSqJJZVr8T4tYjfxyaGJxf9T5GbtYazYcRmP
+Pfk9fa2jjnmyUPewuJZHmwArB9oRryAdwWtOsvVZHZ1ulcmW+Pbo2IiYQHvl1zQH
+Z5Mw91gFnDov+9F9be4W5sZmbj640vetlJGLdMFheEZ2HSX+4fEZu1k=
+-----END CERTIFICATE-----

data/lib/ruby_vsts.rb

@@ -0,0 +1,33 @@
+require 'vsts/version'
+require 'vsts/configuration'
+require 'vsts/api_client'
+require 'vsts/api_response'
+require 'vsts/base_model'
+require 'vsts/identity'
+require 'vsts/item'
+require 'vsts/change'
+require 'vsts/changeset'
+
+# Base namespace for ruby_vsts
+module VSTS
+  class << self
+    attr_accessor :configuration
+    attr_accessor :logger
+  end
+
+  def self.configuration
+    @configuration ||= Configuration.new
+  end
+
+  def self.reset
+    @configuration = Configuration.new
+  end
+
+  def self.configure
+    yield(configuration)
+  end
+
+  def self.logger
+    @logger ||= Logger.new(STDOUT)
+  end
+end

data/lib/vsts/api_client.rb

@@ -0,0 +1,150 @@
+require 'rest-client'
+require 'base64'
+
+# VSTS namespace
+module VSTS
+  # API client for Visual Studio Team Services (VSTS)
+  # Manages access tokens and API versions, builds proper requests as expected by the VSTS API
+  class APIClient
+    # Make an API request
+    #
+    # @param method [Symbol] the method to be used, can be :get, :put, :post, :delete or :head (will be passed to RestClient)
+    # @param resource [String] the resource to request under the base_url (ie. "/changesets")
+    # @param opts [Hash] options for the request
+    # @option opts [Hash] :payload payload for the request (if any)
+    # @option opts [String] :api_version
+    # @option opts [String] :collection
+    # @option opts [String] :team_project
+    # @option opts [String] :area
+    # @option opts [Hash] :urlparams
+    # @return [Hash] request results as parsed from json
+    def self.request(method, resource, opts = {})
+      url = build_url(resource, opts)
+      VSTS.logger.debug("VSTS request: #{method} #{url}") if VSTS.configuration.debug
+      req = {
+        method: method,
+        url: url,
+        payload: opts[:payload],
+        headers: {
+          Authorization: authz_header_value,
+          Accept: "application/json",
+          "Content-Type" => "application/json"
+        }
+      }
+      resp = RestClient::Request.execute(req)
+      APIResponse.new(req, resp)
+    end
+
+    # Helper method for GET requests, calls #request
+    #
+    # @param resource [String] the resource to request under the base_url (ie. "/changesets")
+    # @param opts [Hash] query options, see #request
+    # @return [Hash] request results as parsed from json
+    def self.get(resource, opts = {})
+      request(:get, resource, opts)
+    end
+
+    # Helper method for POST requests, calls #request
+    #
+    # @param resource [String] the resource to request under the base_url (ie. "/changesets")
+    # @param payload [Hash] payload to be sent with the request, takes precedence over opts[:payload]
+    # @param opts [Hash] query options, see #request
+    # @return [Hash] request results as parsed from json
+    def self.post(resource, payload, opts = {})
+      opts[:payload] = payload
+      request(:post, resource, opts)
+    end
+
+    # Helper method for PUT requests, calls #request
+    #
+    # @param resource [String] the resource to request under the base_url (ie. "/changesets")
+    # @param payload [Hash] payload to be sent with the request, takes precedence over opts[:payload]
+    # @param opts [Hash] query options, see #request
+    # @return [Hash] request results as parsed from json
+    def self.put(resource, payload, opts = {})
+      opts[:payload] = payload
+      request(:put, resource, opts)
+    end
+
+    # Helper method for PATCH requests, calls #request
+    #
+    # @param resource [String] the resource to request under the base_url (ie. "/changesets")
+    # @param payload [Hash] payload to be sent with the request, takes precedence over opts[:payload]
+    # @param opts [Hash] query options, see #request
+    # @return [Hash] request results as parsed from json
+    def self.patch(resource, payload, opts = {})
+      opts[:payload] = payload
+      request(:patch, resource, opts)
+    end
+
+    # Helper method for DELETE requests, calls #request
+    #
+    # @param resource [String] the resource to request under the base_url (ie. "/changesets")
+    # @param opts [Hash] query options, see #request
+    # @return [Hash] request results as parsed from json
+    def self.delete(resource, opts = {})
+      request(:delete, resource, opts)
+    end
+
+    # Private class methods
+
+    # Builds VSTS url as described in https://www.visualstudio.com/en-us/docs/integrate/get-started/rest/basics
+    #
+    # @param resource [String] the VSTS resource
+    # @param opts [Hash] options hash, see #request
+    # @return [String] the request URL
+    # @private
+    def self.build_url(resource, opts = {})
+      base_url = VSTS.configuration.base_url.sub(%r{\/+$}, "")
+      api_version = opts[:api_version] || VSTS.configuration.api_version
+      collection = opts[:collection] || VSTS.configuration.collection
+      team_project = opts[:team_project] || VSTS.configuration.team_project
+      urlparams = opts[:urlparams] || {}
+      area = opts[:area] || VSTS.configuration.area
+      resource.sub!(%r{^\/+}, "")
+
+      base = [base_url, collection, team_project, "_apis", area, resource].compact.join("/")
+      urlparams["api-version"] ||= api_version
+      url_encoded_params = URI.encode_www_form(urlparams) # makes url params from Hash
+
+      base + "?" + url_encoded_params
+    end
+
+    # Calculate the Authorization header for the API based on the personal access token
+    #
+    # @return [String] the Authorization header value for Basic auth, ie. "Basic jrigf9404vvxsoi48t048fdj=="
+    # @private
+    def self.authz_header_value
+      "Basic " + Base64.strict_encode64(":" + VSTS.configuration.personal_access_token)
+    end
+
+    # Build URL parameters hash from options hash (used internally)
+    #
+    # @param opts [Hash] options hash with Symbol keys to build url parameters from
+    # @param paramnames [Array<String>, Array<Symbol>, Array<Array<String, String>>, Array<Hash>]
+    #                   list of VSTS URL parameter names and VSTS prefixes to filter from opts
+    # @return [Hash] url parameters hash
+    # @private
+    def self.build_params(opts, paramnames)
+      urlparams = {}
+      paramnames.each do |paramname_with_prefix|
+        case paramname_with_prefix
+        when String, Symbol
+          prefix = ""
+          paramname = paramname_with_prefix
+        when Array
+          prefix = paramname_with_prefix[0]
+          paramname = paramname_with_prefix[1]
+        when Hash
+          prefix = paramname_with_prefix.first[0]
+          paramname = paramname_with_prefix.first[1]
+        else
+          VSTS.logger.warn("Invalid type in paramlist in APIClient##build_params: #{paramname_with_prefix.class}")
+          next
+        end
+        urlparams["#{prefix}#{paramname}"] = opts[paramname] if opts[paramname]
+      end
+      urlparams
+    end
+  end
+end

data/lib/vsts/api_response.rb

@@ -0,0 +1,24 @@
+require 'json'
+
+# VSTS namespace
+module VSTS
+  # VSTS API response
+  class APIResponse
+    attr_accessor :request, :code, :body, :parsed
+
+    # Constructor
+    #
+    # @param request [Hash] the hash that was passed to RestClient as the request descriptor
+    # @param response [RestClient::Response]
+    def initialize(request, response)
+      @request = request
+      @code = response.code
+      @body = response.body
+      begin
+        @parsed = JSON.parse(@body)
+      rescue JSON::ParserError
+        @parsed = nil
+      end
+    end
+  end
+end