Language library refactor

LICENSE.txt

@@ -0,0 +1,7 @@
+Copyright (c) 2012 Toopher, Inc.
+
+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.

README.md

@@ -1,52 +1,104 @@
-#ToopherDotNet
+#ToopherDotNet [![Build Status](https://travis-ci.org/toopher/toopher-dotnet.png?branch=master)](https://travis-ci.org/toopher/toopher-dotnet)
 
-[![Build
-Status](https://travis-ci.org/toopher/toopher-dotnet.png?branch=master)](https://travis-ci.org/toopher/toopher-dotnet)
-
-#### Introduction
 ToopherDotNet is a Toopher API library that simplifies the task of interfacing with the Toopher API from DotNet programs.  It does not depend on any external libraries, and preconfigures the required OAuth and JSON functionality so you can focus on just using the API.
 
-#### Learn the Toopher API
-Make sure you visit (http://dev.toopher.com) to get acquainted with the Toopher API fundamentals.  The documentation there will tell you the details about the operations this API wrapper library provides.
-
-#### OAuth Authentication
-
-The first step to accessing the Toopher API is to sign up for an account at the development portal (http://dev.toopher.com) and create a "requester". When that process is complete, your requester is issued OAuth 1.0a credentials in the form of a consumer key and secret. Your key is used to identify your quester when Toopher interacts with your customers, and the secret is used to sign each request so that we know it is generated by you.  This library properly formats each request with your credentials automatically.
+### .NET Framework Version
+\>=4.5
 
-#### The Toopher Two-Step
-Interacting with the Toopher web service involves two steps: pairing, and authenticating.
+### C# Version
+\>=5.0
 
-##### Pair
-Before you can enhance your website's actions with Toopher, your customers will need to pair their phone's Toopher app with your website.  To do this, they generate a unique, nonsensical "pairing phrase" from within the app on their phone.  You will need to prompt them for a pairing phrase as part of the Toopher enrollment process.  Once you have a pairing phrase, just send it to the Toopher API along with your requester credentials and we'll return a pairing ID that you can use whenever you want to authenticate an action for that user.
+### Documentation
+Make sure you visit [https://dev.toopher.com](https://dev.toopher.com) to get acquainted with the Toopher API fundamentals.  The documentation there will tell you the details about the operations this API wrapper library provides.
 
-##### Authenticate
-You have complete control over what actions you want to authenticate using Toopher (for example: logging in, changing account information, making a purchase, etc.).  Just send us the user's pairing ID, a name for the terminal they're using, and a description of the action they're trying to perform and we'll make sure they actually want it to happen.
+## ToopherApi Workflow
 
-#### Librarified
-This library makes it super simple to do the Toopher two-step.  Check it out:
+### Step 1: Pair
+Before you can enhance your website's actions with Toopher, your customers will need to pair their mobile device's Toopher app with your website.  To do this, they generate a unique pairing phrase from within the app on their mobile device.  You will need to prompt them for a pairing phrase as part of the Toopher enrollment process.  Once you have a pairing phrase, just send it to the Toopher API along with your requester credentials and we'll return a pairing ID that you can use whenever you want to authenticate an action for that user.
 
 ```csharp
 using Toopher;
 
 // Create an API object using your credentials
 ToopherApi api = new ToopherApi("<your consumer key>", "<your consumer secret>");
 
-// Step 1 - Pair with their phone's Toopher app
-PairingStatus pairing = api.Pair("pairing phrase", "username@yourservice.com");
+// Step 1 - Pair with their mobile device's Toopher app
+Pairing pairing = api.Pair("username@yourservice.com", "pairing phrase");
+```
+
+### Step 2: Authenticate
+You have complete control over what actions you want to authenticate using Toopher (logging in, changing account information, making a purchase, etc.).  Just send us the username or pairing ID and we'll make sure they actually want it to happen. You can also choose to provide the following optional parameters: terminal name, requester specified ID and action name (*default: "Log in"*).
 
+
+```csharp
 // Step 2 - Authenticate a log in
-AuthenticationStatus auth = api.Authenticate(pairing.id, "my computer");
+AuthenticationRequest authenticationRequest = api.Authenticate("username@yourservice.com", "terminal name");
 
 // Once they've responded you can then check the status
-AuthenticationStatus status = api.GetAuthenticationStatus(auth.id);
-if (auth.pending == false && auth.granted == true) {
+authenticationRequest.RefreshFromServer();
+if (authenticationRequest.pending == false && authenticationRequest.granted == true) {
     // Success!
 }
 ```
 
-#### Handling Errors
+## ToopherIframe Workflow
+
+### Step 1: Embed a request in an IFRAME
+1. Generate an authentication URL by providing a username.
+2. Display a webpage to your user that embeds this URL within an `<iframe>` element.
+
+```csharp
+using Toopher;
+
+// Create an API object using your credentials
+ToopherIframe iframeApi = new ToopherIframe("<your consumer key>", "<your consumer secret>");
+
+string authenticationIframeUrl = iframeApi.GetAuthenticationUrl("username@yourservice.com");
+
+// Add an <iframe> element to your HTML:
+// <iframe id="toopher-iframe" src=authenticationIframeUrl />
+```
+
+### Step 2: Validate the postback data
 
+The simplest way to validate the postback data is to call `IsAuthenticationGranted` to check if the authentication request was granted.
+
+```csharp
+// Retrieve the postback data as a string from POST parameter 'iframe_postback_data'
+
+// Returns boolean indicating if authentication request was granted by user
+bool authenticationRequestGranted = iframeApi.IsAuthenticationGranted(postbackData);
+
+if (authenticationRequestGranted) {
+    // Success!
+}
+```
+
+### Handling Errors
 If any request runs into an error a `RequestError` will be thrown with more details on what went wrong.
 
-#### Try it out
-Check out the `ToopherDotNetDemo` project for an example program that walks you through the whole process!
+### Demo
+Check out the `ToopherDotNetDemo` for an example program that walks you through the whole process!  Simply run the commands below:
+```shell
+$ xbuild
+$ mono ToopherDotNetDemo/bin/Debug/ToopherDotNetDemo.exe
+```
+
+## Contributing
+### Dependencies
+This library was developed on Windows and OS X. To run .NET on OS X, we use [Mono](http://www.mono-project.com/). To install Mono with Homebrew run:
+```shell
+$ brew install mono
+```
+
+### Tests
+To run the tests enter:
+
+```shell
+$ xbuild
+$ nunit-console ./ToopherDotNetTests/bin/Debug/ToopherDotNetTests.dll -exclude Integration,NotWorkingOnMono
+```
+
+
+## License
+ToopherDotNet is licensed under the MIT License. See LICENSE.txt for the full text.

ToopherDotNet/OAuth/OAuthRequest.cs

@@ -118,7 +118,7 @@ private string WriteAuthorizationHeader(WebParameterCollection parameters)
             }
 
             var authorization = sb.ToString();
-            return authorization;
+            return authorization.TrimEnd(new char[]{ ',' });
         }
 
         #endregion

ToopherDotNet/OAuth/OAuthTools.cs

@@ -20,6 +20,20 @@ public static class OAuthTools
 
         private static readonly Random _random;
         private static readonly object _randomLock = new object();
+        private static string nonceOverride;
+
+        public static void SetNonceOverride (string nonceOverride)
+        {
+          OAuthTools.nonceOverride = nonceOverride;
+        }
+
+        private static DateTime dateOverride;
+
+        public static void SetDateOverride (DateTime dateOverride)
+        {
+          OAuthTools.dateOverride = dateOverride;
+        }
+
 
 #if !SILVERLIGHT
         private static readonly RandomNumberGenerator _rng = RandomNumberGenerator.Create();
@@ -49,6 +63,9 @@ static OAuthTools()
         /// <returns></returns>
         public static string GetNonce()
         {
+          if (nonceOverride != null){
+            return nonceOverride;
+          } else {
             const string chars = (Lower + Digit);
 
             var nonce = new char[16];
@@ -60,6 +77,7 @@ public static string GetNonce()
                 }
             }
             return new string(nonce);
+          }
         }
 
         /// <summary>
@@ -69,7 +87,11 @@ public static string GetNonce()
         /// <returns></returns>
         public static string GetTimestamp()
         {
+          if (dateOverride == default(DateTime)) {
             return GetTimestamp(DateTime.UtcNow);
+          } else {
+            return GetTimestamp(dateOverride);
+          }
         }
 
         /// <summary>
@@ -164,7 +186,7 @@ public static string NormalizeRequestParameters(WebParameterCollection parameter
             return concatenated;
         }
 
-        private static string Concatenate(ICollection<WebParameter> collection, string separator, string spacer)
+        public static string Concatenate(ICollection<WebParameter> collection, string separator, string spacer)
         {
             var sb = new StringBuilder();