public Actor(Actor src)
{
this.name = src.Name;
this.Mbox = src.mbox;
this.mbox_sha1sum = src.mbox_sha1sum;
this.openid = src.openid;
this.account = src.account;
}
public ActivityState(string activityId, string stateId, Actor actor, string body, string contentType, string registrationId)
{
this.activityId = activityId;
this.stateId = stateId;
this.actor = actor;
this.body = body;
this.contentType = contentType;
this.registrationId = registrationId;
}
/// <summary>
/// Creates a statement with a verb from the predefined verb enumeration.
/// </summary>
/// <param name="actor">The actor in this statement</param>
/// <param name="verb">The PredefinedVerb of this statement</param>
/// <param name="statementTarget">The target statement</param>
public Statement(Actor actor, PredefinedVerbs verb, StatementTarget statementTarget)
: this(actor, new StatementVerb(verb), statementTarget)
{
}
public ActivityState(string activityId, string stateId, Actor actor, string body, string contentType)
: this(activityId, stateId, actor, body, contentType, null)
{
}
public void ActivityProfileTest()
{
TCAPI target = new TCAPI("https://cloud.scorm.com/ScormEngineInterface/TCAPI/CZSWMUZPSE", new BasicHTTPAuth("CZSWMUZPSE", "vwiuflgsY22FDXpHA4lwwe5hrnUXvcyJjW3fDrpH"));
Actor actor = new Actor("Mufasa", "mailto:[email protected]");
string[] profileIds = { "The Lion King", "The Fallen King", "The New King" };
string[] profileContents = {
"Mufasa rules his country as a proud and fair king of lions, celebrating his recently newborn son Simba.",
"Scar kills Mufasa, simply muttering the words 'Long Live the King'",
"Simba finally realizes he must follow in his fathers footsteps to save the kingdom from the evil Scar." };
string activityId = "example.com/TheLionKing";
string[] actual;
actual = target.GetActivityProfileIds(activityId);
//Assert.AreEqual(0, actual.Length);
ActivityProfile profile = new ActivityProfile();
profile.ActivityId = activityId;
profile.ProfileId = profileIds[0];
profile.Body = profileContents[0];
ActivityProfile pp = new ActivityProfile();
pp.ActivityId = activityId;
pp.ProfileId = profileIds[0];
pp.Body = profileContents[0];
target.SaveActivityProfile(profile, true, pp);
profile.ProfileId = profileIds[1];
profile.Body = profileContents[1];
target.SaveActivityProfile(profile);
profile.ProfileId = profileIds[2];
profile.Body = profileContents[2];
target.SaveActivityProfile(profile);
/*
ActivityProfile previous = new ActivityProfile();
previous.ProfileId = profileIds[2];
previous.Body = profileContents[1];
target.SaveActivityProfile(profile, false, previous);
*/
actual = target.GetActivityProfileIds(activityId);
Assert.AreEqual(3, actual.Length);
ActivityProfile apResult = target.GetActivityProfile(activityId, profileIds[0]);
Assert.AreEqual(profileContents[0], apResult.Body);
apResult = target.GetActivityProfile(activityId, profileIds[1]);
Assert.AreEqual(profileContents[1], apResult.Body);
apResult = target.GetActivityProfile(activityId, profileIds[2]);
Assert.AreEqual(profileContents[2], apResult.Body);
target.DeleteActivityProfile(activityId, profileIds[0]);
actual = target.GetActivityProfileIds(activityId);
Assert.AreEqual(2, actual.Length);
target.DeleteAllActivityProfile(activityId);
actual = target.GetActivityProfileIds(activityId);
Assert.AreEqual(0, actual.Length);
}
/// <summary>
///A test for GetActorProfile
///</summary>
//[TestMethod()]
public void GetActorProfileTest()
{
TinCanJsonConverter converter = new TinCanJsonConverter();
TCAPI target = new TCAPI("http://cloud.scorm.com/ScormEngineInterface/TCAPI/public", new BasicHTTPAuth("test", "password"));
Actor actor = new Actor("Example", "mailto:[email protected]");
string profileId = "Example";
ActorProfile actual;
actual = target.GetActorProfile(actor, profileId);
Console.Write(converter.SerializeToJSON(actual));
Assert.Inconclusive(INCONCLUSIVE_CONSOLE);
}
/// <summary>
///A test for DeleteAllActorProfile
///</summary>
//[TestMethod()]
public void DeleteAllActorProfileTest()
{
TCAPI target = new TCAPI("http://cloud.scorm.com/ScormEngineInterface/TCAPI/public", new BasicHTTPAuth("test", "password"));
Actor actor = new Actor("Example", "mailto:[email protected]"); // TODO: Initialize to an appropriate value
target.DeleteAllActorProfile(actor);
Assert.Inconclusive(INCONCLUSIVE);
}
/// <summary>
///A test for DeleteActivityState
///</summary>
//[TestMethod()]
public void DeleteActivityStateTest()
{
TCAPI target = new TCAPI("http://cloud.scorm.com/ScormEngineInterface/TCAPI/public", new BasicHTTPAuth("test", "password"));
Actor actor = new Actor("Example", "mailto:[email protected]");
string activityId = "example.com";
string registrationId = null;
string stateId = "Bananas";
target.DeleteActivityState(activityId, actor, stateId, registrationId);
Assert.Inconclusive(INCONCLUSIVE);
}
/// <summary>
/// A test for pushing and storing Actor Profiles, then deleting them.
/// </summary>
/// <remarks>This test should use a dummy actor, not a real one!</remarks>
//[TestMethod()]
public void ActorProfileTest()
{
TinCanJsonConverter converter = new TinCanJsonConverter();
TCAPI target = new TCAPI("https://cloud.scorm.com/ScormEngineInterface/TCAPI/CZSWMUZPSE", new BasicHTTPAuth("CZSWMUZPSE", "vwiuflgsY22FDXpHA4lwwe5hrnUXvcyJjW3fDrpH"));
Actor actor = new Actor("Mufasa", "mailto:[email protected]");
String[] profileIds = { "The Lion King", "The Fallen King", "The New King" };
String[] profileContents = {
"Mufasa rules his country as a proud and fair king of lions, celebrating his recently newborn son Simba.",
"Scar kills Mufasa, simply muttering the words 'Long Live the King'",
"Simba finally realizes he must follow in his fathers footsteps to save the kingdom from the evil Scar." };
// Clear all existing profiles.
target.DeleteAllActorProfile(actor);
NullableDateTime since = null;
string[] actual;
actual = target.GetActorProfileIds(actor, since);
Assert.AreEqual(0, actual.Length);
/* Save a new actor profile */
ActorProfile p1 = new ActorProfile();
p1.Actor = actor;
p1.ProfileId = profileIds[0];
p1.Body = profileContents[0];
ActorProfile pp = new ActorProfile();
pp.ProfileId = profileIds[0];
pp.Actor = actor;
pp.Body = profileContents[0];
target.SaveActorProfile(p1, pp, true);
actual = target.GetActorProfileIds(actor, since);
Assert.AreEqual(1, actual.Length);
p1.ProfileId = profileIds[1];
p1.Body = profileContents[1];
pp.ProfileId = profileIds[1];
target.SaveActorProfile(p1, pp, true);
actual = target.GetActorProfileIds(actor, since);
Assert.AreEqual(2, actual.Length);
p1.ProfileId = profileIds[2];
p1.Body = profileContents[2];
pp.ProfileId = profileIds[2];
target.SaveActorProfile(p1, pp, true);
actual = target.GetActorProfileIds(actor);
Assert.AreEqual(3, actual.Length);
// Ensure all the posted data matches
ActorProfile pResult = target.GetActorProfile(actor, profileIds[0]);
Assert.AreEqual(profileContents[0], pResult.Body);
pResult = target.GetActorProfile(actor, profileIds[1]);
Assert.AreEqual(profileContents[1], pResult.Body);
pResult = target.GetActorProfile(actor, profileIds[2]);
Assert.AreEqual(profileContents[2], pResult.Body);
target.DeleteActorProfile(actor, profileIds[0]);
actual = target.GetActorProfileIds(actor);
Assert.AreEqual(2, actual.Length);
target.DeleteAllActorProfile(actor);
actual = target.GetActorProfileIds(actor);
Assert.AreEqual(0, actual.Length);
}
/// <summary>
/// Retrieves a specific activity state
/// </summary>
/// <param name="activityId">The activity ID</param>
/// <param name="actor">The actor associated with the state</param>
/// <param name="stateId">The state document id</param>
/// <param name="registrationId">Optional registration ID</param>
/// <returns>The activity state</returns>
public ActivityState GetActivityState(string activityId, Actor actor, string stateId, string registrationId)
{
TinCanJsonConverter converter = new TinCanJsonConverter();
NameValueCollection nvc = new NameValueCollection();
string getResult;
ActivityState result = new ActivityState();
nvc["activityId"] = activityId;
switch (version)
{
case TCAPIVersion.TinCan090:
nvc["actor"] = converter.SerializeToJSON((Model.TinCan090.Actor)actor);
break;
default:
nvc["actor"] = converter.SerializeToJSON(actor);
break;
}
nvc["stateId"] = stateId;
if (!string.IsNullOrEmpty(registrationId))
nvc["registrationId"] = registrationId;
WebHeaderCollection whc;
getResult = HttpMethods.GetRequest(nvc, endpoint + ACTIVITY_STATE, authentification, out whc, versionString);
if (whc != null)
result.ContentType = whc["Content-Type"];
result.Body = getResult;
result.ActivityId = activityId;
result.Actor = actor;
result.RegistrationId = registrationId;
result.StateId = stateId;
return result;
}
/// <summary>
/// Retrieves a specific activity state
/// </summary>
/// <param name="activityId">The activity ID</param>
/// <param name="actor">The actor associated with the state</param>
/// <param name="stateId">The state document id</param>
/// <returns>The activity state</returns>
public ActivityState GetActivityState(string activityId, Actor actor, string stateId)
{
return GetActivityState(activityId, actor, stateId, null);
}
/// <summary>
/// Deletes all the actor profiles for a given actor
/// </summary>
/// <param name="actor">The actor to delete profiles from</param>
public void DeleteAllActorProfile(Actor actor)
{
TinCanJsonConverter converter = new TinCanJsonConverter();
NameValueCollection nvc = new NameValueCollection();
switch (version)
{
case TCAPIVersion.TinCan090:
nvc["actor"] = converter.SerializeToJSON((Model.TinCan090.Actor)actor);
break;
default:
nvc["actor"] = converter.SerializeToJSON(actor);
break;
}
HttpMethods.DeleteRequest(nvc, endpoint + ACTOR_PROFILE, authentification, versionString);
}
/// <summary>
/// Deletes the activity state
/// </summary>
/// <param name="activityId">The activity ID</param>
/// <param name="actor">The associated actor</param>
/// <param name="stateId">The state document key</param>
/// <param name="registrationId">Optional registration ID</param>
public void DeleteActivityState(string activityId, Actor actor, string stateId, string registrationId)
{
TinCanJsonConverter converter = new TinCanJsonConverter();
NameValueCollection nvc = new NameValueCollection();
nvc["activityId"] = activityId;
switch (version)
{
case TCAPIVersion.TinCan090:
nvc["actor"] = converter.SerializeToJSON((Model.TinCan090.Actor)actor);
break;
default:
nvc["actor"] = converter.SerializeToJSON(actor);
break;
}
nvc["stateId"] = stateId;
if (!string.IsNullOrEmpty(registrationId))
nvc["registrationId"] = registrationId;
HttpMethods.DeleteRequest(nvc, endpoint + ACTIVITY_STATE, authentification, versionString);
}
/// <summary>
/// Deletes the activity state
/// </summary>
/// <param name="activityId">The activity ID</param>
/// <param name="actor">The associated actor</param>
/// <param name="stateId">The state document key</param>
/// <param name="registrationId">Optional registration ID</param>
public void DeleteActivityState(string activityId, Actor actor, string stateId)
{
DeleteActivityState(activityId, actor, stateId, null);
}
public void GetActorProfileIdsTest()
{
TinCanJsonConverter converter = new TinCanJsonConverter();
TCAPI target = new TCAPI(new Uri("http://cloud.scorm.com/tc/public"), new BasicHTTPAuth("test", "password"));
Actor actor = new Actor("Example", "mailto:[email protected]");
NullableDateTime since = null;
string[] actual;
actual = target.GetActorProfileIds(actor, since);
Console.Write(converter.SerializeToJSON(actual));
Assert.Inconclusive(INCONCLUSIVE_CONSOLE);
}
public void ActivityStateTest()
{
TinCanJsonConverter converter = new TinCanJsonConverter();
TCAPI target = new TCAPI(new Uri("http://cloud.scorm.com/tc/public"), new BasicHTTPAuth("CZSWMUZPSE", "vwiuflgsY22FDXpHA4lwwe5hrnUXvcyJjW3fDrpH"));
Actor actor = new Actor("Mufasa", "mailto:[email protected]");
string[] stateIds = { "The Lion King", "The Fallen King", "The New King" };
string[] stateContents = {
"Mufasa rules his country as a proud and fair king of lions, celebrating his recently newborn son Simba.",
"Scar kills Mufasa, simply muttering the words 'Long Live the King'",
"Simba finally realizes he must follow in his fathers footsteps to save the kingdom from the evil Scar." };
string activityId = "example.com/TheLionKing";
string[] results = target.GetActivityStateIds(activityId, actor);
//Assert.AreEqual(0, results.Length);
ActivityState state = new ActivityState();
state.ActivityId = activityId;
state.Actor = actor;
state.StateId = stateIds[0];
state.Body = stateContents[0];
ActivityState previous = new ActivityState();
previous.ActivityId = activityId;
previous.Actor = actor;
previous.StateId = stateIds[0];
previous.Body = stateContents[0];
target.SaveActivityState(state, false, previous);
//target.SaveActivityState(state);
state.StateId = stateIds[1];
state.Body = stateContents[1];
target.SaveActivityState(state);
state.StateId = stateIds[2];
state.Body = stateContents[2];
target.SaveActivityState(state);
results = target.GetActivityStateIds(activityId, actor);
Assert.AreEqual(3, results.Length);
ActivityState asResult = target.GetActivityState(activityId, actor, stateIds[0]);
Assert.AreEqual(stateContents[0], asResult.Body);
asResult = target.GetActivityState(activityId, actor, stateIds[0]);
asResult = target.GetActivityState(activityId, actor, stateIds[1]);
Assert.AreEqual(stateContents[1], asResult.Body);
asResult = target.GetActivityState(activityId, actor, stateIds[2]);
Assert.AreEqual(stateContents[2], asResult.Body);
/*
target.DeleteActivityState(activityId, actor, stateIds[0]);
results = target.GetActivityStateIds(activityId, actor);
Assert.AreEqual(2, results.Length);
target.DeleteActivityState(activityId, actor, stateIds[1]);
target.DeleteActivityState(activityId, actor, stateIds[2]);
*/
results = target.GetActivityStateIds(activityId, actor);
}
public TinCanActor_JsonTarget(Actor actor)
: base(actor)
{
}
/// <summary>
/// Gets all the activity states for an activity
/// </summary>
/// <param name="activityId">The activity ID</param>
/// <param name="actor">The actor</param>
/// <returns>An array of activity state document keys</returns>
public string[] GetActivityStateIds(string activityId, Actor actor)
{
return GetActivityStateIds(activityId, actor, null, null);
}
/// <summary>
/// Test to ensure ETag collisions are not ignored.
/// </summary>
//[TestMethod()]
public void CollisionTest()
{
TinCanJsonConverter converter = new TinCanJsonConverter();
TCAPI target = new TCAPI("https://cloud.scorm.com/ScormEngineInterface/TCAPI/CZSWMUZPSE", new BasicHTTPAuth("CZSWMUZPSE", "vwiuflgsY22FDXpHA4lwwe5hrnUXvcyJjW3fDrpH"));
Actor actor = new Actor("Mufasa", "mailto:[email protected]");
string[] stateIds = { "The Lion King", "The Fallen King", "The New King" };
string[] stateContents = {
"Mufasa rules his country as a proud and fair king of lions, celebrating his recently newborn son Simba.",
"Scar kills Mufasa, simply muttering the words 'Long Live the King'",
"Simba finally realizes he must follow in his fathers footsteps to save the kingdom from the evil Scar." };
string activityId = "example.com/TheLionKing";
string[] results = target.GetActivityStateIds(activityId, actor);
ActivityState state = new ActivityState(activityId, stateIds[0], actor, stateContents[1], "text/plain");
ActivityState previous = new ActivityState(activityId, stateIds[0], actor, stateContents[0], "text/plain");
target.SaveActivityState(state);
state.Body = stateContents[2];
target.SaveActivityState(state, false, previous);
}
/// <summary>
/// Gets all the activity states for an activity
/// </summary>
/// <param name="activityId">The activity ID</param>
/// <param name="actor">The actor</param>
/// <param name="since">Exclusive start date</param>
/// <returns>An array of activity state document keys</returns>
public string[] GetActivityStateIds(string activityId, Actor actor, NullableDateTime since)
{
return GetActivityStateIds(activityId, actor, null, since);
}
/// <summary>
///A test for DeleteActorProfile
///</summary>
//[TestMethod()]
public void DeleteActorProfileTest()
{
TCAPI target = new TCAPI("http://cloud.scorm.com/ScormEngineInterface/TCAPI/public", new BasicHTTPAuth("test", "password"));
Actor actor = new Actor("Example", "mailto:[email protected]");
string profileId = "Example";
target.DeleteActorProfile(actor, profileId);
Assert.Inconclusive(INCONCLUSIVE);
}
/// <summary>
/// Gets all the activity states for an activity
/// </summary>
/// <param name="activityId">The activity ID</param>
/// <param name="actor">The actor</param>
/// <param name="registrationId">The registration ID</param>
/// <param name="since">Exclusive start date</param>
/// <returns>An array of activity state document keys</returns>
public string[] GetActivityStateIds(string activityId, Actor actor, string registrationId, NullableDateTime since)
{
string[] stateIds;
string getResult;
TinCanJsonConverter converter = new TinCanJsonConverter();
NameValueCollection nvc = new NameValueCollection();
nvc["activityId"] = activityId;
switch (version)
{
case TCAPIVersion.TinCan090:
nvc["actor"] = converter.SerializeToJSON((Model.TinCan090.Actor)actor);
break;
default:
nvc["actor"] = converter.SerializeToJSON(actor);
break;
}
if (!string.IsNullOrEmpty(registrationId))
nvc["registrationId"] = registrationId;
if (since != null)
nvc["since"] = since.Value.ToString(Constants.ISO8601_DATE_FORMAT);
getResult = HttpMethods.GetRequest(nvc, endpoint + ACTIVITY_STATE, authentification, versionString);
stateIds = (string[])converter.DeserializeJSON(getResult, typeof(string[]));
return stateIds;
}
/// <summary>
///A test for GetActivityState
///</summary>
//[TestMethod()]
public void GetActivityStateTest()
{
TinCanJsonConverter converter = new TinCanJsonConverter();
TCAPI target = new TCAPI("http://cloud.scorm.com/ScormEngineInterface/TCAPI/public", new BasicHTTPAuth("test", "password"));
Actor actor = new Actor("Example", "mailto:[email protected]");
string activityId = "example.com";
string registrationId = null;
string stateId = "Bananas";
ActivityState actual;
actual = target.GetActivityState(activityId, actor, stateId, registrationId);
Console.Write(converter.SerializeToJSON(actual));
Assert.Inconclusive(INCONCLUSIVE_CONSOLE);
}
/// <summary>
/// Retreives a complete actor given a partial actor
/// </summary>
/// <param name="partialActor">An actor containing at least one inverse functional property</param>
/// <returns></returns>
public Actor GetActor(Actor partialActor)
{
TinCanJsonConverter converter = new TinCanJsonConverter();
NameValueCollection nvc = new NameValueCollection();
string getResult;
Actor result = null;
switch (version)
{
case TCAPIVersion.TinCan090:
nvc["actor"] = converter.SerializeToJSON((Model.TinCan090.Actor)partialActor);
break;
default:
nvc["actor"] = converter.SerializeToJSON(partialActor);
break;
}
getResult = HttpMethods.GetRequest(nvc, endpoint + ACTORS, authentification, versionString);
switch (version)
{
case TCAPIVersion.TinCan095:
result = (Actor)converter.DeserializeJSON(getResult, typeof(Actor));
break;
case TCAPIVersion.TinCan090:
result = (Actor)((Model.TinCan090.Actor)converter.DeserializeJSON(getResult, typeof(Model.TinCan090.Actor)));
break;
}
return result;
}
/// <summary>
///A test for GetActor
///</summary>
//[TestMethod()]
public void GetActorTest()
{
TinCanJsonConverter converter = new TinCanJsonConverter();
TCAPI target = new TCAPI("http://cloud.scorm.com/ScormEngineInterface/TCAPI/public", new BasicHTTPAuth("test", "password"));
Actor partialActor = new Actor();
partialActor.Mbox = "mailto:[email protected]";
Actor fullActor = target.GetActor(partialActor);
Console.Write(converter.SerializeToJSON(fullActor));
Assert.Inconclusive(INCONCLUSIVE_CONSOLE);
}
/// <summary>
/// Retrieves an Actor profile
/// </summary>
/// <param name="actor">The actor that owns the profile</param>
/// <param name="profileId">The profile document key</param>
/// <returns></returns>
public ActorProfile GetActorProfile(Actor actor, string profileId)
{
ActorProfile result = new ActorProfile();
string getResult;
TinCanJsonConverter converter = new TinCanJsonConverter();
NameValueCollection nvc = new NameValueCollection();
switch (version)
{
case TCAPIVersion.TinCan090:
nvc["actor"] = converter.SerializeToJSON((Model.TinCan090.Actor)actor);
break;
default:
nvc["actor"] = converter.SerializeToJSON(actor);
break;
}
nvc["profileId"] = profileId;
WebHeaderCollection whc;
getResult = HttpMethods.GetRequest(nvc, endpoint + ACTOR_PROFILE, authentification, out whc, versionString);
if (whc != null)
result.ContentType = whc["Content-Type"];
result.ProfileId = profileId;
result.Actor = actor;
result.Body = getResult;
return result;
}
public ActivityState(string activityId, string stateId, Actor actor, string body)
: this(activityId, stateId, actor, body, DEFAULT_HEADER)
{
}
/// <summary>
/// Retrieves a list of all actor profile document keys
/// </summary>
/// <param name="actor">The actor that owns the document keys</param>
/// <returns>An array of profile document keys</returns>
public string[] GetActorProfileIds(Actor actor)
{
return GetActorProfileIds(actor, null);
}
/// <summary>
/// Retrieves a list of all actor profile document keys
/// </summary>
/// <param name="actor">The actor that owns the document keys</param>
/// <param name="since">Optional start date</param>
/// <returns>An array of profile document keys</returns>
public string[] GetActorProfileIds(Actor actor, NullableDateTime since)
{
TinCanJsonConverter converter = new TinCanJsonConverter();
NameValueCollection nvc = new NameValueCollection();
string[] getResult;
switch (version)
{
case TCAPIVersion.TinCan090:
nvc["actor"] = converter.SerializeToJSON((Model.TinCan090.Actor)actor);
break;
default:
nvc["actor"] = converter.SerializeToJSON(actor);
break;
}
if (since != null)
nvc["since"] = since.Value.ToString(Constants.ISO8601_DATE_FORMAT);
getResult = (string[])converter.DeserializeJSON(HttpMethods.GetRequest(nvc, endpoint + ACTOR_PROFILE, authentification, versionString), typeof(string[]));
return getResult;
}
/// <summary>
/// Creates a Statement with the minimum suggested properties
/// </summary>
/// <param name="actor">The actor in this statement</param>
/// <param name="verb">The verb in this statement</param>
/// <param name="statementTarget">The target of this statement</param>
public Statement(Actor actor, StatementVerb verb, StatementTarget statementTarget)
{
this.actor = actor;
this.verb = verb;
this._object = statementTarget;
}