ruby_vsts 0.1.1

data/spec/spec_helper.rb

@@ -0,0 +1,25 @@
+require 'rspec'
+require 'webmock/rspec'
+require 'simplecov'
+require 'simplecov-json'
+require 'codeclimate-test-reporter'
+
+SimpleCov.configure do
+  root File.join(File.dirname(__FILE__), '..')
+  project_name 'Ruby VSTS Client'
+  add_filter 'spec'
+end
+
+SimpleCov.start
+
+RSpec.configure do |config|
+  config.order = 'random'
+end
+
+WebMock.disable_net_connect!
+
+require 'ruby_vsts'
+
+def fixtures_path
+  File.dirname(__FILE__) + '/fixtures/'
+end

data/spec/vsts/base_model_spec.rb

@@ -0,0 +1,10 @@
+require "spec_helper"
+
+describe VSTS::BaseModel do
+  it "can convert camelcase to underlines" do
+    m = described_class.new
+    expect(m.underscore("AbcDef")).to eq("abc_def")
+    expect(m.underscore("ABCDef")).to eq("abc_def")
+    expect(m.underscore("abcDefGhi")).to eq("abc_def_ghi")
+  end
+end

data/spec/vsts/change_spec.rb

@@ -0,0 +1,25 @@
+require "spec_helper"
+
+describe VSTS::Change do
+  before do
+    VSTS.reset
+    VSTS.configure do |config|
+      config.personal_access_token = "test_token"
+      config.base_url = "https://test.visualstudio.local/"
+      config.debug = false
+    end
+
+    # stub one changeset
+    stub_request(:get, /test.visualstudio.local\/.*?\/changesets\/\d+\?/)
+      .to_return(status: 200, body: File.new(fixtures_path + "tfvc_changeset_by_id.json"))
+    # stub changes in a changeset
+    stub_request(:get, /test.visualstudio.local\/.*?\/changesets\/\d+\/changes\?/)
+      .to_return(status: 200, body: File.new(fixtures_path + "tfvc_changeset_changes.json"))
+  end
+
+  let(:changes) { VSTS::Changeset.find(16).changes }
+
+  it "creates Item objects for changes" do
+    expect(changes[0].item).to be_a(VSTS::Item)
+  end
+end

data/spec/vsts/changeset_spec.rb

@@ -0,0 +1,145 @@
+require "spec_helper"
+
+# rubocop:disable Metrics/BlockLength
+describe VSTS::Changeset do
+  before do
+    VSTS.reset
+    VSTS.configure do |config|
+      config.personal_access_token = "test_token"
+      config.base_url = "https://test.visualstudio.local/"
+      config.debug = false
+    end
+  end
+
+  describe "finding a single changeset" do
+    before do
+      # stub one changeset
+      stub_request(:get, /test.visualstudio.local\/.*?\/changesets\/\d+\?/)
+        .to_return(status: 200, body: File.new(fixtures_path + "tfvc_changeset_by_id.json"))
+    end
+
+    let(:changeset) { described_class.find(16) }
+
+    it "can find a Changeset instance by id" do
+      expect(changeset).to be_a(described_class)
+    end
+
+    it "can create an Identity instance for the author of the changeset" do
+      expect(changeset.author).to be_a(VSTS::Identity)
+    end
+
+    it "can fill in Changeset instance fields from the response" do
+      expect(changeset.author.display_name).to eq("Chuck Reinhart")
+    end
+
+    it "can download changes" do
+      expect(changeset).to respond_to(:changes)
+    end
+  end
+
+  describe "finding a list of changesets" do
+    before do
+      # stub list of changesets (the same response for any query)
+      stub_request(:get, /test.visualstudio.local\/.*?\/changesets\?/)
+        .to_return(status: 200, body: File.new(fixtures_path + "tfvc_changesets_list.json"))
+    end
+
+    let(:expected_url) { "https://test.visualstudio.local/DefaultCollection/_apis/tfvc/changesets" }
+
+    it "can find a list of changesets as an array" do
+      changeset_list = described_class.find_all
+      expect(changeset_list).to be_an(Array)
+      expect(changeset_list[0]).to be_a(described_class)
+    end
+
+    it "can find all changesets" do
+      changeset_list = described_class.find_all
+      expect(changeset_list.length).to eq(18)
+    end
+
+    it "can request a page at a time" do
+      described_class.find_all(top: 20, skip: 100)
+      query = {
+        "$top" => 20,
+        "$skip" => 100,
+        "api-version" => "1.0"
+      }
+      expect(a_request(:get, expected_url).with(query: query)).to have_been_made.once
+    end
+
+    it "can sort results" do
+      described_class.find_all(orderBy: "id desc")
+      query = {
+        "$orderBy" => "id desc",
+        "api-version" => "1.0"
+      }
+      expect(a_request(:get, expected_url).with(query: query)).to have_been_made.once
+    end
+
+    describe "filtering" do
+      it "can filter by item path" do
+        described_class.find_all(itemPath: "$/Fabrikam-Fiber-TFVC/Program.cs")
+        query = {
+          "searchCriteria.itemPath" => "$/Fabrikam-Fiber-TFVC/Program.cs",
+          "api-version" => "1.0"
+        }
+        expect(a_request(:get, expected_url).with(query: query)).to have_been_made.once
+      end
+
+      it "can filter by author" do
+        described_class.find_all(author: "fabrikamfiber3@hotmail.com")
+        query = {
+          "searchCriteria.author" => "fabrikamfiber3@hotmail.com",
+          "api-version" => "1.0"
+        }
+        expect(a_request(:get, expected_url).with(query: query)).to have_been_made.once
+      end
+
+      it "can filter by range of IDs" do
+        described_class.find_all(fromId: 10, toId: 20)
+        query = {
+          "searchCriteria.fromId" => 10,
+          "searchCriteria.toId" => 20,
+          "api-version" => "1.0"
+        }
+        expect(a_request(:get, expected_url).with(query: query)).to have_been_made.once
+      end
+
+      it "can filter by date range" do
+        described_class.find_all(fromDate: "03-01-2017", toDate: "03-18-2017-2:00PM")
+        query = {
+          "searchCriteria.fromDate" => "03-01-2017",
+          "searchCriteria.toDate" => "03-18-2017-2:00PM",
+          "api-version" => "1.0"
+        }
+        expect(a_request(:get, expected_url).with(query: query)).to have_been_made.once
+      end
+    end
+  end
+
+  describe "downloading changes in a changeset" do
+    before do
+      # stub one changeset
+      stub_request(:get, /test.visualstudio.local\/.*?\/changesets\/\d+\?/)
+        .to_return(status: 200, body: File.new(fixtures_path + "tfvc_changeset_by_id.json"))
+      # stub changes in a changeset
+      stub_request(:get, /test.visualstudio.local\/.*?\/changesets\/\d+\/changes\?/)
+        .to_return(status: 200, body: File.new(fixtures_path + "tfvc_changeset_changes.json"))
+    end
+
+    let(:changes) { described_class.find(16).changes }
+
+    it "can get changes as an Array" do
+      expect(changes).to be_an(Array)
+    end
+
+    it "creates the required amount of changes" do
+      expect(changes.length).to eq(1)
+    end
+
+    it "creates Change instances" do
+      expect(changes[0]).to be_a(VSTS::Change)
+    end
+  end
+end
+# rubocop:enable Metrics/BlockLength

data/spec/vsts/configuration_spec.rb

@@ -0,0 +1,43 @@
+require "spec_helper"
+
+# rubocop:disable Metrics/BlockLength
+describe VSTS::Configuration do
+  before do
+    VSTS.reset
+    VSTS.configure do |config|
+      config.personal_access_token = "test_token"
+      config.base_url = "https://testurl.local/"
+      config.collection = "testcollection"
+      config.team_project = "testproject"
+      config.area = "testarea"
+      config.api_version = "9.9-test"
+      config.debug = true
+    end
+  end
+
+  it "has an accessible configuration" do
+    expect(VSTS.configuration).to be_a(described_class)
+  end
+
+  it "has its fields configured" do
+    expect(VSTS.configuration.personal_access_token).to eq("test_token")
+    expect(VSTS.configuration.base_url).to eq("https://testurl.local/")
+    expect(VSTS.configuration.collection).to eq("testcollection")
+    expect(VSTS.configuration.team_project).to eq("testproject")
+    expect(VSTS.configuration.area).to eq("testarea")
+    expect(VSTS.configuration.api_version).to eq("9.9-test")
+    expect(VSTS.configuration.debug).to eq(true)
+  end
+
+  it "can be reconfigured" do
+    VSTS.configuration.debug = false
+    expect(VSTS.configuration.debug).to eq(false)
+  end
+
+  it "can be reset" do
+    VSTS.reset
+    expect(VSTS.configuration.personal_access_token).to eq("")
+    expect(VSTS.configuration.base_url).to eq("")
+  end
+end
+# rubocop:enable Metrics/BlockLength

data/spec/vsts/item_spec.rb

@@ -0,0 +1,74 @@
+require "spec_helper"
+
+# rubocop:disable Metrics/BlockLength
+describe VSTS::Item do
+  before do
+    VSTS.reset
+    VSTS.configure do |config|
+      config.personal_access_token = "test_token"
+      config.base_url = "https://test.visualstudio.local/"
+      config.debug = false
+    end
+
+    # stub one changeset
+    stub_request(:get, /test.visualstudio.local\/.*?\/changesets\/\d+\?/)
+      .to_return(status: 200, body: File.new(fixtures_path + "tfvc_changeset_by_id.json"))
+    # stub changes in a changeset
+    stub_request(:get, /test.visualstudio.local\/.*?\/changesets\/\d+\/changes\?/)
+      .to_return(status: 200, body: File.new(fixtures_path + "tfvc_changeset_changes.json"))
+    # stub item download
+    stub_request(:get, /test.visualstudio.local\/.*?\/items(\/|\?)/)
+      .to_return(status: 200, body: "test file\ncontents")
+  end
+
+  let(:item) { VSTS::Changeset.find(16).changes[0].item }
+  let(:expected_url) { "https://test.visualstudio.local/DefaultCollection/_apis/tfvc/items" }
+
+  it "downloads from the correct URL" do
+    query = {
+      "path" => "$/Fabrikam-Fiber-TFVC/AuthSample-dev/Code/AuthSample.cs",
+      "api-version" => "1.0"
+    }
+    item.get
+    expect(a_request(:get, expected_url).with(query: query)).to have_been_made.once
+  end
+
+  it "can be downloaded" do
+    expect(item.get).to eq("test file\ncontents")
+  end
+
+  it "can download a specific version" do
+    query = {
+      "path" => "$/Fabrikam-Fiber-TFVC/AuthSample-dev/Code/AuthSample.cs",
+      "versionType" => "changeset",
+      "version" => 1000,
+      "api-version" => "1.0"
+    }
+    item.get(versionType: :changeset, version: 1000)
+    expect(a_request(:get, expected_url).with(query: query)).to have_been_made.once
+  end
+
+  it "can download the previous version before the latest" do
+    query = {
+      "path" => "$/Fabrikam-Fiber-TFVC/AuthSample-dev/Code/AuthSample.cs",
+      "versionType" => "latest",
+      "versionOptions" => "previous",
+      "api-version" => "1.0"
+    }
+    item.get(versionType: :latest, versionOptions: :previous)
+    expect(a_request(:get, expected_url).with(query: query)).to have_been_made.once
+  end
+
+  it "can download the previous version before a given changeset" do
+    query = {
+      "path" => "$/Fabrikam-Fiber-TFVC/AuthSample-dev/Code/AuthSample.cs",
+      "versionType" => "changeset",
+      "version" => 1000,
+      "versionOptions" => "previous",
+      "api-version" => "1.0"
+    }
+    item.get(versionType: :changeset, version: 1000, versionOptions: :previous)
+    expect(a_request(:get, expected_url).with(query: query)).to have_been_made.once
+  end
+end
+# rubocop:enable Metrics/BlockLength

data/spec/vsts_spec.rb

@@ -0,0 +1,15 @@
+require 'spec_helper'
+
+describe VSTS do
+  describe 'versioning' do
+    it 'has a proper version' do
+      expect(VSTS::VERSION).to match(/\A\d+\.\d+\.\d+(-\w+)?\z/)
+    end
+  end
+
+  describe 'logging' do
+    it 'has a logger' do
+      expect(described_class.logger).to be_a(Logger)
+    end
+  end
+end

metadata

@@ -0,0 +1,253 @@
+--- !ruby/object:Gem::Specification
+name: ruby_vsts
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+platform: ruby
+authors:
+- Gabor Lengyel
+autorequire: 
+bindir: bin
+cert_chain:
+- |
+  -----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-----
+date: 2017-04-12 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rest-client
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.14'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.14'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.5'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.13'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.13'
+- !ruby/object:Gem::Dependency
+  name: simplecov-json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.2'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.48'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.48'
+- !ruby/object:Gem::Dependency
+  name: rubocop-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.15'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.15'
+- !ruby/object:Gem::Dependency
+  name: codeclimate-test-reporter
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+description: |2
+      An API client to the Microsoft Visual Studio online Rest APIs. It can connect to VSTS via the public API
+      and query VSTS with a personal access token. May also work with TFS.
+email: ruby_vsts@prodexity.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".codeclimate.yml"
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".yardopts"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- certs/ruby_vsts-gem-public_cert.pem
+- lib/ruby_vsts.rb
+- lib/vsts/api_client.rb
+- lib/vsts/api_response.rb
+- lib/vsts/base_model.rb
+- lib/vsts/change.rb
+- lib/vsts/changeset.rb
+- lib/vsts/configuration.rb
+- lib/vsts/identity.rb
+- lib/vsts/item.rb
+- lib/vsts/version.rb
+- ruby_vsts.gemspec
+- spec/fixtures/tfvc_changeset_by_id.json
+- spec/fixtures/tfvc_changeset_changes.json
+- spec/fixtures/tfvc_changesets_list.json
+- spec/spec_helper.rb
+- spec/vsts/base_model_spec.rb
+- spec/vsts/change_spec.rb
+- spec/vsts/changeset_spec.rb
+- spec/vsts/configuration_spec.rb
+- spec/vsts/item_spec.rb
+- spec/vsts_spec.rb
+homepage: https://github.com/prodexity/ruby_vsts/
+licenses:
+- MIT
+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.5.1
+signing_key: 
+specification_version: 4
+summary: An unofficial Microsoft Visual Studio Team Services (VSTS) API client in
+  Ruby
+test_files: []