diff --git a/.gitignore b/.gitignore index e30f673..ce5124b 100644 --- a/.gitignore +++ b/.gitignore @@ -25,7 +25,7 @@ build/ bld/ [Bb]in/ [Oo]bj/ - +output/ # Visual Studo 2015 cache/options directory .vs/ diff --git a/.nuget/packages.config b/.nuget/packages.config index cbb5d4e..99125be 100644 --- a/.nuget/packages.config +++ b/.nuget/packages.config @@ -4,4 +4,5 @@ + \ No newline at end of file diff --git a/README.md b/README.md index f7510b3..ac09db0 100644 --- a/README.md +++ b/README.md @@ -11,6 +11,22 @@ This is a c# wrapper around the Untappd API. This can be downloaded via [Nuget](https://www.nuget.org/packages/Untappd.Net/), or the [backup feed](https://www.myget.org/F/untappd-net/api/v2). +## Building via command line + +If you wish to build via command line install ruby, and ruby gems. Open up a console in the root directory of this project, and then run the following: + +* `gem install rake` +* `gem install bundle` +* `bundle` +* `rake preflight` + +## My PR is broken, it works in VS! + +if your pull request is broken either one of two things is happening. + +1. Your changes are not mono compatible, which prevent linux users from using your changes. This will only happen if travis ci says your build is broken, but appveyor does not. +2. You have added gendarme violations. You can run gendarme locally by running `rake preflight` from your console. + ## API Coverage Current both Authenticated and Unauthenticated requests. diff --git a/Rakefile b/Rakefile index 22b9648..44078b8 100644 --- a/Rakefile +++ b/Rakefile @@ -23,7 +23,7 @@ desc 'Run the tests' task :test => [:nunit] desc 'Retrieve, Build, Test' -task :preflight => [:retrieve, :build, :test] +task :preflight => [:retrieve, :build, :test, :cs_lint] @@ -37,6 +37,25 @@ test_runner :nunit do |tests| tests.exe = "packages/NUnit.Runners.2.6.4/tools/nunit-console.exe" # executable to run tests with end +task :cs_lint do + + unless Dir.exists?('output') + Dir.mkdir('output') + + end + + + + CMD_PREFIX = "" + if !OS.windows? + CMD_PREFIX = "mono" + end + + sh "#{CMD_PREFIX} packages/Mono.Gendarme.2.11.0.20121120/tools/gendarme.exe src/Untappd.Net/bin/#{Configuration}/Untappd.Net.dll --html output/gendarme.html --severity high+ --ignore assets/gendarme/gendarme.ignore" + +end + + # task :tests => :'tests:unit' #task :ensure_nuget_key do diff --git a/Untappd.Net.sln b/Untappd.Net.sln index d726c13..07347ee 100644 --- a/Untappd.Net.sln +++ b/Untappd.Net.sln @@ -1,38 +1,82 @@ - -Microsoft Visual Studio Solution File, Format Version 12.00 -# Visual Studio 2013 -VisualStudioVersion = 12.0.31101.0 -MinimumVisualStudioVersion = 10.0.40219.1 -Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "Untappd.Net", "src\Untappd.Net\Untappd.Net.csproj", "{D8571A44-2E86-43A3-B64A-2364614C6934}" -EndProject -Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "Untappd.Net.UnitTests", "src\Untappd.Net.UnitTests\Untappd.Net.UnitTests.csproj", "{513A3FB2-6664-40E7-A03E-591D852C42E4}" -EndProject -Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "Solution Items", "Solution Items", "{7175F502-2C45-4728-8693-A6ACDC7D5892}" - ProjectSection(SolutionItems) = preProject - appveyor.yml = appveyor.yml - EndProjectSection -EndProject -Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = ".nuget", ".nuget", "{8013BAEB-9A81-4ED1-8471-343D16B06D98}" - ProjectSection(SolutionItems) = preProject - .nuget\packages.config = .nuget\packages.config - EndProjectSection -EndProject -Global - GlobalSection(SolutionConfigurationPlatforms) = preSolution - Debug|Any CPU = Debug|Any CPU - Release|Any CPU = Release|Any CPU - EndGlobalSection - GlobalSection(ProjectConfigurationPlatforms) = postSolution - {D8571A44-2E86-43A3-B64A-2364614C6934}.Debug|Any CPU.ActiveCfg = Debug|Any CPU - {D8571A44-2E86-43A3-B64A-2364614C6934}.Debug|Any CPU.Build.0 = Debug|Any CPU - {D8571A44-2E86-43A3-B64A-2364614C6934}.Release|Any CPU.ActiveCfg = Release|Any CPU - {D8571A44-2E86-43A3-B64A-2364614C6934}.Release|Any CPU.Build.0 = Release|Any CPU - {513A3FB2-6664-40E7-A03E-591D852C42E4}.Debug|Any CPU.ActiveCfg = Debug|Any CPU - {513A3FB2-6664-40E7-A03E-591D852C42E4}.Debug|Any CPU.Build.0 = Debug|Any CPU - {513A3FB2-6664-40E7-A03E-591D852C42E4}.Release|Any CPU.ActiveCfg = Release|Any CPU - {513A3FB2-6664-40E7-A03E-591D852C42E4}.Release|Any CPU.Build.0 = Release|Any CPU - EndGlobalSection - GlobalSection(SolutionProperties) = preSolution - HideSolutionNode = FALSE - EndGlobalSection -EndGlobal + +Microsoft Visual Studio Solution File, Format Version 12.00 +# Visual Studio 2012 +VisualStudioVersion = 12.0.31101.0 +MinimumVisualStudioVersion = 10.0.40219.1 +Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "Untappd.Net", "src\Untappd.Net\Untappd.Net.csproj", "{D8571A44-2E86-43A3-B64A-2364614C6934}" +EndProject +Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "Untappd.Net.UnitTests", "src\Untappd.Net.UnitTests\Untappd.Net.UnitTests.csproj", "{513A3FB2-6664-40E7-A03E-591D852C42E4}" +EndProject +Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "Solution Items", "Solution Items", "{7175F502-2C45-4728-8693-A6ACDC7D5892}" + ProjectSection(SolutionItems) = preProject + appveyor.yml = appveyor.yml + EndProjectSection +EndProject +Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = ".nuget", ".nuget", "{8013BAEB-9A81-4ED1-8471-343D16B06D98}" + ProjectSection(SolutionItems) = preProject + .nuget\packages.config = .nuget\packages.config + EndProjectSection +EndProject +Global + GlobalSection(SolutionConfigurationPlatforms) = preSolution + Debug|Any CPU = Debug|Any CPU + Release|Any CPU = Release|Any CPU + EndGlobalSection + GlobalSection(ProjectConfigurationPlatforms) = postSolution + {513A3FB2-6664-40E7-A03E-591D852C42E4}.Debug|Any CPU.ActiveCfg = Debug|Any CPU + {513A3FB2-6664-40E7-A03E-591D852C42E4}.Debug|Any CPU.Build.0 = Debug|Any CPU + {513A3FB2-6664-40E7-A03E-591D852C42E4}.Release|Any CPU.ActiveCfg = Release|Any CPU + {513A3FB2-6664-40E7-A03E-591D852C42E4}.Release|Any CPU.Build.0 = Release|Any CPU + {D8571A44-2E86-43A3-B64A-2364614C6934}.Debug|Any CPU.ActiveCfg = Debug|Any CPU + {D8571A44-2E86-43A3-B64A-2364614C6934}.Debug|Any CPU.Build.0 = Debug|Any CPU + {D8571A44-2E86-43A3-B64A-2364614C6934}.Release|Any CPU.ActiveCfg = Release|Any CPU + {D8571A44-2E86-43A3-B64A-2364614C6934}.Release|Any CPU.Build.0 = Release|Any CPU + EndGlobalSection + GlobalSection(NestedProjects) = preSolution + EndGlobalSection + GlobalSection(MonoDevelopProperties) = preSolution + StartupItem = src\Untappd.Net\Untappd.Net.csproj + Policies = $0 + $0.DotNetNamingPolicy = $1 + $1.DirectoryNamespaceAssociation = PrefixedHierarchical + $1.ResourceNamePolicy = FileFormatDefault + $0.TextStylePolicy = $2 + $2.inheritsSet = VisualStudio + $2.inheritsScope = text/plain + $2.scope = text/x-csharp + $0.CSharpFormattingPolicy = $3 + $3.IndentSwitchBody = True + $3.IndentBlocksInsideExpressions = True + $3.AnonymousMethodBraceStyle = NextLine + $3.PropertyBraceStyle = NextLine + $3.PropertyGetBraceStyle = NextLine + $3.PropertySetBraceStyle = NextLine + $3.EventBraceStyle = NextLine + $3.EventAddBraceStyle = NextLine + $3.EventRemoveBraceStyle = NextLine + $3.StatementBraceStyle = NextLine + $3.ElseNewLinePlacement = NewLine + $3.CatchNewLinePlacement = NewLine + $3.FinallyNewLinePlacement = NewLine + $3.WhileNewLinePlacement = DoNotCare + $3.ArrayInitializerWrapping = DoNotChange + $3.ArrayInitializerBraceStyle = NextLine + $3.BeforeMethodDeclarationParentheses = False + $3.BeforeMethodCallParentheses = False + $3.BeforeConstructorDeclarationParentheses = False + $3.NewLineBeforeConstructorInitializerColon = NewLine + $3.NewLineAfterConstructorInitializerColon = SameLine + $3.BeforeDelegateDeclarationParentheses = False + $3.NewParentheses = False + $3.SpacesBeforeBrackets = False + $3.inheritsSet = Mono + $3.inheritsScope = text/x-csharp + $3.scope = text/x-csharp + $0.StandardHeader = $4 + $4.Text = + $4.IncludeInNewFiles = True + EndGlobalSection + GlobalSection(SolutionProperties) = preSolution + HideSolutionNode = FALSE + EndGlobalSection +EndGlobal diff --git a/assets/gendarme/gendarme.ignore b/assets/gendarme/gendarme.ignore new file mode 100644 index 0000000..cf602ce --- /dev/null +++ b/assets/gendarme/gendarme.ignore @@ -0,0 +1,60 @@ +# we have hard coded strings...sue us +R: Gendarme.Rules.Design.PreferUriOverStringRule +A: * + +# We don't really care if our exceptions are not serializable +R: Gendarme.Rules.Serialization.MissingSerializationConstructorRule +A: Untappd.Net + +# Either implement or do not bother +R: Gendarme.Rules.Exceptions.MissingExceptionConstructorsRule +A: Untappd.Net + +# TODO: Implement +R: Gendarme.Rules.BadPractice.DoNotForgetNotImplementedMethodsRule +N: Untappd.Net + + +R: Gendarme.Rules.Design.ConsiderAddingInterfaceRule +T: Untappd.Net.Request.BasicRequest # This class is an abstract class, its inheritors should implement the interface +T: Untappd.Net.SingleObjectArrayConverter # We should figure out how to implement the write json here... +A: Untappd.Net + +# Microsoft says we shouldn't dispose tasks ourselves +R: Gendarme.Rules.Correctness.EnsureLocalDisposalRule +M: System.Void Untappd.Net.Request.Repository/c__async0`1::MoveNext() + +# We use the obsolete constructor for testing +R: Gendarme.Rules.Performance.AvoidUncalledPrivateCodeRule +T: Untappd.Net.Request.Repository + +# we really want constants +R: Gendarme.Rules.BadPractice.AvoidVisibleConstantFieldRule +T: Untappd.Net.Constants + +# for json binding +R: Gendarme.Rules.Naming.AvoidNonAlphanumericIdentifierRule +A: Untappd.Net + +# cannot be helped +R: Gendarme.Rules.Naming.AvoidDeepNamespaceHierarchyRule +A: Untappd.Net + +R: Gendarme.Rules.Maintainability.AvoidLackOfCohesionOfMethodsRule +A: Untappd.Net + +# We need to multiple call +R: Gendarme.Rules.Performance.AvoidRepetitiveCallsToPropertiesRule +T: Untappd.Net.Request.Repository + +# we want to do this here +R: Gendarme.Rules.Exceptions.DoNotSwallowErrorsCatchingNonSpecificExceptionsRule +M: System.Void Untappd.Net.Request.Repository/c__async0`1::MoveNext() + +# We violate case sometimes for json bindings +R: Gendarme.Rules.Naming.UseCorrectCasingRule +A: Untappd.Net + +# TODO: Serialize properly +R: Gendarme.Rules.Serialization.ImplementISerializableCorrectlyRule +T: Untappd.Net.Exception.HttpErrorException diff --git a/src/Untappd.Net.UnitTests/Untappd.Net.UnitTests.csproj b/src/Untappd.Net.UnitTests/Untappd.Net.UnitTests.csproj index 50e05b0..dc85e22 100644 --- a/src/Untappd.Net.UnitTests/Untappd.Net.UnitTests.csproj +++ b/src/Untappd.Net.UnitTests/Untappd.Net.UnitTests.csproj @@ -1,5 +1,5 @@  - + Debug @@ -33,10 +33,6 @@ ..\..\packages\Moq.4.2.1502.0911\lib\net40\Moq.dll - - False - ..\..\packages\Newtonsoft.Json.6.0.8\lib\net45\Newtonsoft.Json.dll - ..\..\packages\NUnitTestAdapter.1.2\lib\nunit.core.dll False @@ -56,10 +52,6 @@ ..\..\packages\NUnitTestAdapter.1.2\lib\NUnit.VisualStudio.TestAdapter.dll False - - False - ..\..\packages\RestSharp.105.0.1\lib\net4\RestSharp.dll - @@ -67,6 +59,12 @@ + + ..\..\packages\Newtonsoft.Json.6.0.8\lib\net45\Newtonsoft.Json.dll + + + ..\..\packages\RestSharp.105.0.1\lib\net4\RestSharp.dll + @@ -98,7 +96,7 @@ - {d8571a44-2e86-43a3-b64a-2364614c6934} + {D8571A44-2E86-43A3-B64A-2364614C6934} Untappd.Net diff --git a/src/Untappd.Net/Exception/HttpErrorException.cs b/src/Untappd.Net/Exception/HttpErrorException.cs index be1e06f..7be45eb 100644 --- a/src/Untappd.Net/Exception/HttpErrorException.cs +++ b/src/Untappd.Net/Exception/HttpErrorException.cs @@ -4,6 +4,7 @@ using RestSharp; namespace Untappd.Net.Exception { + [Serializable] public sealed class HttpErrorException : BaseUntappdException { public override string Message @@ -17,6 +18,14 @@ namespace Untappd.Net.Exception private readonly string _message; public HttpErrorException(IRestRequest request, IRestResponse response) { + if(request == null) + { + throw new ArgumentNullException("request"); + } + if (response == null) + { + throw new ArgumentNullException("response"); + } var code = (int) response.StatusCode; if (code == 200) { diff --git a/src/Untappd.Net/Properties/AssemblyInfo.cs b/src/Untappd.Net/Properties/AssemblyInfo.cs index b99c357..703b1ff 100644 --- a/src/Untappd.Net/Properties/AssemblyInfo.cs +++ b/src/Untappd.Net/Properties/AssemblyInfo.cs @@ -5,6 +5,9 @@ using System.Runtime.InteropServices; // General Information about an assembly is controlled through the following // set of attributes. Change these attribute values to modify the information // associated with an assembly. +using System; + + [assembly: AssemblyTitle("Untappd.Net")] [assembly: AssemblyDescription("C# Untappd Wrapper")] [assembly: AssemblyConfiguration("")] @@ -13,6 +16,7 @@ using System.Runtime.InteropServices; [assembly: AssemblyCopyright("Copyright © Microsoft 2015")] [assembly: AssemblyTrademark("")] [assembly: AssemblyCulture("")] +[assembly: CLSCompliantAttribute(true)] // Setting ComVisible to false makes the types in this assembly not visible // to COM components. If you need to access a type in this assembly from diff --git a/src/Untappd.Net/Request/Repository.cs b/src/Untappd.Net/Request/Repository.cs index 52b4fde..524606d 100644 --- a/src/Untappd.Net/Request/Repository.cs +++ b/src/Untappd.Net/Request/Repository.cs @@ -13,7 +13,7 @@ namespace Untappd.Net.Request { internal IRestClient Client; internal IRestRequest Request; - private bool FailFast { get; set; } + bool FailFast { get; set; } /// /// Event to listen to when failFast is set to false /// This allows you to capture the excpetion, before its swallowed @@ -65,28 +65,30 @@ namespace Untappd.Net.Request return this; } - private TResult ExecuteRequest() + TResult ExecuteRequest() where TResult : class { return ProcessExecution(Client.Execute(Request)); } - private async Task ExecuteRequestAsync() + async Task ExecuteRequestAsync() where TResult : class { return ProcessExecution(await Client.ExecuteTaskAsync(Request)); } - private TResult ProcessExecution(IRestResponse response) + TResult ProcessExecution(IRestResponse response) where TResult : class { //if the return type is not 200 throw errors if (response.StatusCode != HttpStatusCode.OK) { var excpetion = new HttpErrorException(Request, response); - if (OnExceptionThrown != null) + var eventThrow = OnExceptionThrown; + + if (eventThrow != null) { - OnExceptionThrown(this, new UnhandledExceptionEventArgs(excpetion, FailFast)); + eventThrow(this, new UnhandledExceptionEventArgs(excpetion, FailFast)); } if (FailFast) { @@ -101,9 +103,11 @@ namespace Untappd.Net.Request } catch(System.Exception e) { - if (OnExceptionThrown != null) + var eventThrow = OnExceptionThrown; + + if (eventThrow != null) { - OnExceptionThrown(this, new UnhandledExceptionEventArgs(e, FailFast)); + eventThrow(this, new UnhandledExceptionEventArgs(e, FailFast)); } if (FailFast) { diff --git a/src/Untappd.Net/Request/RepositoryPost.cs b/src/Untappd.Net/Request/RepositoryPost.cs index d3edffa..b971364 100644 --- a/src/Untappd.Net/Request/RepositoryPost.cs +++ b/src/Untappd.Net/Request/RepositoryPost.cs @@ -1,5 +1,6 @@ using System.Threading.Tasks; using Untappd.Net.Authentication; +using System; namespace Untappd.Net.Request { @@ -13,6 +14,15 @@ namespace Untappd.Net.Request /// returns dynamic since often the return doesn't matter public dynamic Post(IAuthenticatedUntappdCredentials credentials, IAction action) { + if (credentials == null) + { + throw new ArgumentNullException("credentials"); + } + if (action == null) + { + throw new ArgumentNullException("action"); + } + return ConfigureRequest(credentials, action.EndPoint, action.BodyParameters, action.RequestMethod) .ExecuteRequest(); } @@ -25,6 +35,15 @@ namespace Untappd.Net.Request /// returns dynamic since often the return doesn't matter public Task PostAsync(IAuthenticatedUntappdCredentials credentials, IAction action) { + if (credentials == null) + { + throw new ArgumentNullException("credentials"); + } + if (action == null) + { + throw new ArgumentNullException("action"); + } + return ConfigureRequest(credentials, action.EndPoint, action.BodyParameters, action.RequestMethod) .ExecuteRequestAsync(); } diff --git a/src/Untappd.Net/Responses/Actions/CheckIn.cs b/src/Untappd.Net/Responses/Actions/CheckIn.cs index 9682366..5989a57 100644 --- a/src/Untappd.Net/Responses/Actions/CheckIn.cs +++ b/src/Untappd.Net/Responses/Actions/CheckIn.cs @@ -53,6 +53,10 @@ namespace Untappd.Net.Responses.Actions get { return _shout; } set { + if (value == null) + { + throw new ArgumentNullException("value"); + } if (value.Length > 140) { throw new ArgumentOutOfRangeException("value", value,"Shout can be no more than 140 characters"); diff --git a/src/Untappd.Net/Untappd.Net.csproj b/src/Untappd.Net/Untappd.Net.csproj index c980f55..830d428 100644 --- a/src/Untappd.Net/Untappd.Net.csproj +++ b/src/Untappd.Net/Untappd.Net.csproj @@ -1,5 +1,5 @@  - + Debug @@ -30,10 +30,6 @@ 4 - - False - ..\..\packages\Newtonsoft.Json.6.0.8\lib\net45\Newtonsoft.Json.dll - ..\..\packages\RestSharp.105.0.1\lib\net4\RestSharp.dll @@ -44,6 +40,9 @@ + + ..\..\packages\Newtonsoft.Json.6.0.8\lib\net45\Newtonsoft.Json.dll +