Files
octokit.net/Octokit/Models/Response/License.cs
Mickaël Derriey 9c80b00e6f Merge master into dotnetcore (#1599)
* bugfix - PUT should have a payload for Mark as Read (#1579)

* bugfix - PUT should have a payload for Mark as Read

* also fix the Observable client test

* add integration tests for MarkRead methods

* Fixup MarkReadForRepository methods to specify a body in the PUT request

* Fix unit tests for regular and observable client

* helps if the new files are included in the test project :)

* Cloning ApiInfo object should work when some fields are null (#1580)

* Adjust ApiInfo.Clone() to work even if some elements (eg ETag) are null

* Remove c# 6 language feature and do it the old school way

* Add a test for cloning ApiInfo when some fields are null

* The 3 lists can never be null anyway so remove some un-needed statements

* Add test for null RateLimit

* Remove Rx-Main dependency from samples
This resolves #1592 - LINQPad doesn't understand how to restore this unlisted package and it's not actually needed in the samples.

* Adding RemovedFromProject and other missing EventInfoState types. (#1591)

* Adding missing review types to event info.

* Fixing whitespace.

* Reword `BaseRefChanged` comment

* Adding missing event types.

* Change response models 'Url' properties from `Uri` to `string` (#1585)

* Add convention test to ensure 'Url' properties are of type string

Closes #1582

* Change 'Url' properties from Uri to string

Global Find/Replace FTW!

* fix compilation errors in the integration tests project

* Extend 'Url' properties type check to request models

* Stick to convention tests naming convention

* Remove unused using directives in models

Changing from `Uri` to `string` means the `using System;`
directive was not needed anymore in some files

* Update exception message wording

* empty commit to trigger a new build - hopefully Travis passes

* add convention test to ensure request models have Uri 'Url' properties

* make request models 'Url' properties Uri

fix typo in convention test name

* revert some request models 'Url' properties as `string`

see https://github.com/octokit/octokit.net/pull/1585#issuecomment-297186728

* Change test so that all model types must have 'Url' properties of type string

 - Filter test input to only get types which have 'Url' properties
 - Merge response and request model types tests into one
 - Unparameterize the exception since we only check for the string type now

* Fix string.Format tokens

If this PR doesn't get rebased, it'll be my wall of shame FOREVER!

* and then it's even more embarrassing when the commit message says rebased but you really meant squashed

* Remove exclusion of `Release` from request models
2017-05-02 21:55:30 +10:00

104 lines
3.5 KiB
C#

using System.Collections.Generic;
using System.Collections.ObjectModel;
using System.Diagnostics;
using System.Globalization;
using System.Linq;
namespace Octokit
{
[DebuggerDisplay("{DebuggerDisplay,nq}")]
public class License : LicenseMetadata
{
public License(
string key,
string name,
string url,
string htmlUrl,
bool featured,
string description,
string category,
string implementation,
string body,
IEnumerable<string> required,
IEnumerable<string> permitted,
IEnumerable<string> forbidden) : base(key, name, url)
{
Ensure.ArgumentNotNull(htmlUrl, "htmlUrl");
Ensure.ArgumentNotNull(description, "description");
Ensure.ArgumentNotNull(category, "category");
Ensure.ArgumentNotNull(implementation, "implementation");
Ensure.ArgumentNotNull(body, "body");
Ensure.ArgumentNotNull(required, "required");
Ensure.ArgumentNotNull(permitted, "permitted");
Ensure.ArgumentNotNull(forbidden, "forbidden");
HtmlUrl = htmlUrl;
Featured = featured;
Description = description;
Category = category;
Implementation = implementation;
Body = body;
Required = new ReadOnlyCollection<string>(required.ToList());
Permitted = new ReadOnlyCollection<string>(permitted.ToList());
Forbidden = new ReadOnlyCollection<string>(forbidden.ToList());
}
public License()
{
}
/// <summary>
/// Url to the license on https://choosealicense.com
/// </summary>
public string HtmlUrl { get; protected set; }
/// <summary>
/// Whether the license is one of the licenses featured on https://choosealicense.com
/// </summary>
public bool Featured { get; protected set; }
/// <summary>
/// A description of the license.
/// </summary>
public string Description { get; protected set; }
/// <summary>
/// A group or family that the license belongs to such as the GPL family of licenses.
/// </summary>
public string Category { get; protected set; }
/// <summary>
/// Notes on how to properly apply the license.
/// </summary>
public string Implementation { get; protected set; }
/// <summary>
/// Set of codes for what is required under the terms of the license. For example, "include-copyright"
/// </summary>
public IReadOnlyList<string> Required { get; protected set; }
/// <summary>
/// Set of codes for what is permitted under the terms of the license. For example, "commercial-use"
/// </summary>
public IReadOnlyList<string> Permitted { get; protected set; }
/// <summary>
/// Set of codes for what is forbidden under the terms of the license. For example, "no-liability"
/// </summary>
public IReadOnlyList<string> Forbidden { get; protected set; }
/// <summary>
/// The text of the license
/// </summary>
public string Body { get; protected set; }
internal override string DebuggerDisplay
{
get
{
return string.Format(CultureInfo.InvariantCulture, "{0} Category: {1}", base.DebuggerDisplay, Category);
}
}
}
}