https://github.com/lecantaloop/qwiq
QWIQ is a Quick Work Item Query library for Team Foundation Server / Visual Studio Online.
https://github.com/lecantaloop/qwiq
c-sharp identity linq microsoft nuget soap tfs tfs-api vsts wit workitem
Last synced: 24 days ago
JSON representation
QWIQ is a Quick Work Item Query library for Team Foundation Server / Visual Studio Online.
- Host: GitHub
- URL: https://github.com/lecantaloop/qwiq
- Owner: LeCantaloop
- License: other
- Created: 2015-03-03T00:09:52.000Z (about 10 years ago)
- Default Branch: develop
- Last Pushed: 2022-12-07T17:26:34.000Z (over 2 years ago)
- Last Synced: 2025-04-02T05:44:14.979Z (about 1 month ago)
- Topics: c-sharp, identity, linq, microsoft, nuget, soap, tfs, tfs-api, vsts, wit, workitem
- Language: C#
- Homepage:
- Size: 15 MB
- Stars: 13
- Watchers: 22
- Forks: 11
- Open Issues: 33
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
QWIQ
=======
[](https://github.com/LeCantaloop/Qwiq/blob/master/LICENSE) [](https://ci.appveyor.com/project/LeCantaloop/microsoft-qwiq/branch/develop)
[](https://myget.org/feed/qwiq/package/nuget/Qwiq.Core) [](https://myget.org/feed/qwiq/package/nuget/Qwiq.Core)
QWIQ is a **Q**uick **W**ork **I**tem **Q**uery library for Team Foundation Server / Visual Studio Online. If you do a lot of reading or writing of work items, this package is for you!
## What can it be used for?
Querying Team Foundation Server, of course! Instead of directly using the TFS Client OM, you could use QWIQ! It it made of packages designed to make working with Tfs/Vso a pleasure. Qwiq.Core is the no-frills base package, exposinng the raw types needed to read and write work items. Qwiq.Identity adds methods to simplify converting between your preferred method of identity (display names, user names) and TFS's identity classes. Qwiq.Linq provides a Linq query provider to be able to write Linq to query tfs. Qwiq.Mapper enables converting from IWorkItem, the raw Qwiq.Core type, to your own classes to enable strongly typed access to your WorkItems. Qwiq.Relatives extends Qwiq.Linq to enable slightly more complicated queries allowing for basic queries of related workitems. Qwiq.Mocks provides default implementations for commonly mocked classes within Qwiq, and should allow for getting up and unit testing quickly. Why use this over the Client OM? Glad you asked!
### 1. Easier to consume
Let's be honest, the TFS libraries are a pain to use. There are a lot of them, several are dynamically loaded, and a few are native. While we can't avoid it, you can! Just install the [`Qwiq.Core`](https://www.nuget.org/packages/Qwiq.Core/) package and everything will be in your \bin folder when you need it.
### 2. Easier to test
Qwiq makes testing your apps a breeze. Everything has an interface. Everything uses factories (or factory methods) instead of constructors. Install our [`Qwiq.Mocks`](https://www.nuget.org/packages/Qwiq.Mocks/) package for easy to use mocks, or mock what you need from out interfaces for your tests and go. No more messy, temperamental fakes, or adapters cluttering your code.
### 3. Easier to understand
How often do you update a work item? How often do you create a new security group? We stripped out the rarely used stuff to make interfaces cleaner and the relationships between types simpler. Missing something you can't live without? Send us a pull request!
## How to install it
We have two ways you can install our packages: through NuGet.org which contains our stable packages only, and MyGet.org, which contains vNext and stable packages.
If you want our vNext packages, [add our MyGet feed to your NuGet clients](https://docs.nuget.org/ndocs/tools/package-manager-ui#package-sources):
- v3 (VS 2015+ / NuGet 3.x): `https://www.myget.org/F/qwiq/api/v3/index.json`
- v2 (VS 2013 / NuGet 2.x): `https://www.myget.org/F/qwiq/api/v2`
Once the feed is configured, install via the nuget UI or via the nuget package manager console
### Install Core
From the NuGet package manager console
NuGet
```
PM> Install-Package Qwiq.Core
```
Or via the UI [Qwiq.Core](https://www.nuget.org/packages/Qwiq.Core/)
MyGet
```
PM> Install-Package Qwiq.Core -Source https://www.myget.org/F/qwiq/api/v3/index.json
```
Or via the UI [Qwiq.Core](https://www.myget.org/feed/qwiq/package/nuget/Qwiq.Core),
### Install Client
We now have two clients: one for SOAP, and one for REST
NuGet
```
PM> Install-Package Qwiq.Client.Soap
```
Or via the UI [Qwiq.Client.Soap](https://www.nuget.org/packages/Qwiq.Client.Soap/),
From the NuGet package manager console
MyGet
```
PM> Install-Package Qwiq.Client.Soap -Source https://www.myget.org/F/qwiq/api/v3/index.json
```
Or via the UI [Qwiq.Client.Soap](https://www.myget.org/feed/qwiq/package/nuget/Qwiq.Client.Soap),
### Basic Usage
For .NET
```csharp
using Qwiq;
using Qwiq.Credentials;
using Microsoft.VisualStudio.Services.Client;
...
// We support
// - OAuth2
// - Personal Access Token (PAT)
// - Username and password (BASIC)
// - Windows credentials (NTLM or Federated with Azure Active Directory)
// - Anonymous
// Use the full URI, including the collection. Example: https://QWIQ.VisualStudio.com/DefaultCollection
var uri = new Uri("[Tfs Tenant Uri]");
var options = new AuthenticationOptions(uri, AuthenticationTypes.Windows);
var store = WorkItemStoreFactory
.Default
.Create(options);
// Execute WIQL
var items = store.Query(@"
SELECT [System.Id]
FROM WorkItems
WHERE [System.WorkItemType] = 'Bug' AND State = 'Active'");
```
For PowerShell
```powershell
[Reflection.Assembly]::LoadFrom("E:\Path\To\Qwiq.Core.dll")
# Can use SOAP or REST clients here
[Reflection.Assembly]::LoadFrom("E:\Path\To\Qwiq.Client.Soap.dll")
$uri = [Uri]"[Tfs Tenant Uri]"
$options = New-Object Qwiq.Credentials.AuthenticationOptions $uri,Windows
$store = [Qwiq.Client.Soap.WorkItemStoreFactory]::Default.Create($options)
$items = $store.Query(@"
SELECT [System.Id]
FROM WorkItems
WHERE [System.WorkItemType] = 'Bug' AND State = 'Active'", $false)
```
## Contributing
**Getting started with Git and GitHub**
* [Setting up Git for Windows and connecting to GitHub](http://help.github.com/win-set-up-git/)
* [Forking a GitHub repository](http://help.github.com/fork-a-repo/)
* [The simple guide to GIT guide](http://rogerdudler.github.com/git-guide/)
* [Open an issue](https://github.com/MicrosoftEdge/Microsoft.Qwiq/issues) if you encounter a bug or have a suggestion for improvements/features
Once you're familiar with Git and GitHub, clone the repository and start contributing!