diff --git a/.devcontainer/Dockerfile b/.devcontainer/Dockerfile new file mode 100644 index 000000000..132103bbb --- /dev/null +++ b/.devcontainer/Dockerfile @@ -0,0 +1,18 @@ +FROM mcr.microsoft.com/vscode/devcontainers/dotnet:0.201.7-5.0 + +# Install Mono for running tests +RUN sudo apt install gnupg ca-certificates && \ + sudo apt-key adv --keyserver hkp://keyserver.ubuntu.com:80 --recv-keys 3FA7E0328081BFF6A14DA29AA6A19B38D3D831EF && \ + echo "deb https://download.mono-project.com/repo/ubuntu stable-focal main" | sudo tee /etc/apt/sources.list.d/mono-official-stable.list && \ + sudo apt update && \ + sudo apt install -y mono-complete && \ +# Install .NET Core 3.1 for running tests + sudo apt-get install wget && \ + wget https://packages.microsoft.com/config/ubuntu/20.04/packages-microsoft-prod.deb -O packages-microsoft-prod.deb && \ + sudo dpkg -i packages-microsoft-prod.deb && \ + sudo apt-get update && \ + sudo apt-get install -y apt-transport-https && \ + sudo apt-get update && \ + sudo apt-get install -y dotnet-sdk-3.1 + +# Built with ❤ by [Pipeline Foundation](https://pipeline.foundation) \ No newline at end of file diff --git a/.devcontainer/devcontainer.json b/.devcontainer/devcontainer.json new file mode 100644 index 000000000..e5f1586f9 --- /dev/null +++ b/.devcontainer/devcontainer.json @@ -0,0 +1,27 @@ +{ + "name": "RestSharp Codespace", + "settings": { + "workbench.colorTheme": "Default Dark+", + "terminal.integrated.defaultProfile.linux": "pwsh" + }, + "extensions": [ + "eamodio.gitlens", + "ms-dotnettools.csharp", + "VisualStudioExptTeam.vscodeintellicode", + "ms-vscode.powershell", + "cschleiden.vscode-github-actions", + "redhat.vscode-yaml", + "bierner.markdown-preview-github-styles", + "ban.spellright", + "jmrog.vscode-nuget-package-manager", + "coenraads.bracket-pair-colorizer", + "vscode-icons-team.vscode-icons", + "editorconfig.editorconfig" + ], + "postCreateCommand": "dotnet restore RestSharp.sln && dotnet build RestSharp.sln --configuration Release --no-restore && dotnet test RestSharp.sln --configuration Release --no-build", + "build": { + "dockerfile": "Dockerfile" + } +} + +// Built with ❤ by [Pipeline Foundation](https://pipeline.foundation) \ No newline at end of file diff --git a/.editorconfig b/.editorconfig new file mode 100644 index 000000000..6b125b4c5 --- /dev/null +++ b/.editorconfig @@ -0,0 +1,82 @@ + +[*] + +# ReSharper properties +resharper_align_multiline_binary_expressions_chain = false +resharper_blank_lines_around_single_line_auto_property = 0 +resharper_blank_lines_around_single_line_field = 0 +resharper_blank_lines_before_multiline_statements = 1 +resharper_csharp_blank_lines_around_single_line_invocable = 1 +resharper_csharp_empty_block_style = together +resharper_csharp_int_align_comments = true +resharper_csharp_keep_blank_lines_in_code = 1 +resharper_csharp_keep_blank_lines_in_declarations = 1 +resharper_csharp_wrap_after_declaration_lpar = true +resharper_csharp_wrap_after_invocation_lpar = true +resharper_csharp_wrap_arguments_style = chop_if_long +resharper_csharp_wrap_before_declaration_rpar = true +resharper_csharp_wrap_before_invocation_rpar = true +resharper_csharp_wrap_parameters_style = chop_if_long +resharper_int_align_assignments = true +resharper_int_align_fields = true +resharper_int_align_nested_ternary = true +resharper_int_align_parameters = true +resharper_int_align_properties = true +resharper_int_align_property_patterns = true +resharper_int_align_switch_expressions = true +resharper_int_align_switch_sections = true +resharper_int_align_variables = true +resharper_place_accessorholder_attribute_on_same_line = false +resharper_place_expr_method_on_single_line = if_owner_is_single_line +resharper_place_expr_property_on_single_line = true +resharper_place_simple_initializer_on_single_line = false +resharper_show_autodetect_configure_formatting_tip = false +resharper_use_indent_from_vs = false +resharper_wrap_array_initializer_style = chop_always +resharper_wrap_before_arrow_with_expressions = true +resharper_wrap_chained_binary_expressions = chop_if_long +resharper_wrap_object_and_collection_initializer_style = chop_always +resharper_invert_if_highlighting = none + +# Microsoft .NET properties +csharp_using_directive_placement = outside_namespace +csharp_new_line_before_members_in_object_initializers = false +csharp_new_line_before_open_brace = none +csharp_preferred_modifier_order = public, private, protected, internal, new, abstract, virtual, sealed, override, static, readonly, extern, unsafe, volatile, async:suggestion +csharp_style_var_elsewhere = true:suggestion +csharp_style_var_for_built_in_types = true:suggestion +csharp_style_var_when_type_is_apparent = true:suggestion +dotnet_naming_style.lower_camel_case_style.capitalization = camel_case +dotnet_style_parentheses_in_arithmetic_binary_operators = never_if_unnecessary:none +dotnet_style_parentheses_in_other_binary_operators = never_if_unnecessary:none +dotnet_style_parentheses_in_relational_binary_operators = never_if_unnecessary:none +dotnet_style_predefined_type_for_locals_parameters_members = true:suggestion +dotnet_style_predefined_type_for_member_access = true:suggestion +dotnet_style_qualification_for_event = false:suggestion +dotnet_style_qualification_for_field = false:suggestion +dotnet_style_qualification_for_method = false:suggestion +dotnet_style_qualification_for_property = false:suggestion +dotnet_style_require_accessibility_modifiers = never:suggestion +object_creation_when_type_evident = target_typed +object_creation_when_type_not_evident = target_typed + +# ReSharper inspection severities +resharper_arrange_redundant_parentheses_highlighting = hint +resharper_arrange_this_qualifier_highlighting = hint +resharper_arrange_type_member_modifiers_highlighting = hint +resharper_arrange_type_modifiers_highlighting = hint +resharper_built_in_type_reference_style_for_member_access_highlighting = hint +resharper_built_in_type_reference_style_highlighting = hint +resharper_redundant_base_qualifier_highlighting = warning +resharper_suggest_var_or_type_built_in_types_highlighting = hint +resharper_suggest_var_or_type_elsewhere_highlighting = hint +resharper_suggest_var_or_type_simple_types_highlighting = hint +resharper_web_config_module_not_resolved_highlighting = warning +resharper_web_config_type_not_resolved_highlighting = warning +resharper_web_config_wrong_module_highlighting = warning +resharper_redundant_using_directive_highlighting = error + +[*.{appxmanifest,asax,ascx,aspx,axaml,build,cg,cginc,compute,cs,cshtml,dtd,fs,fsi,fsscript,fsx,hlsl,hlsli,hlslinc,master,ml,mli,nuspec,paml,razor,resw,resx,shader,skin,usf,ush,vb,xaml,xamlx,xoml,xsd}] +indent_style = space +indent_size = 4 +tab_width = 4 diff --git a/.github/FUNDING.yml b/.github/FUNDING.yml new file mode 100644 index 000000000..129655002 --- /dev/null +++ b/.github/FUNDING.yml @@ -0,0 +1,3 @@ +# These are supported funding model platforms + +github: restsharp diff --git a/.github/ISSUE_TEMPLATE.md b/.github/ISSUE_TEMPLATE.md deleted file mode 100644 index ea766c3b7..000000000 --- a/.github/ISSUE_TEMPLATE.md +++ /dev/null @@ -1,27 +0,0 @@ -## Expected Behavior - - - -## Actual Behavior - - -## Steps to Reproduce the Problem - - 1. - 2. - 3. - -## Specifications - - - Version: - - Platform: - - Subsystem: - -## StackTrace -
- -``` - -``` - -
\ No newline at end of file diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md new file mode 100644 index 000000000..78f38d41b --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -0,0 +1,41 @@ +--- +name: Bug report +about: Create a report to help us improve +title: '' +labels: 'bug' +assignees: '' + +--- + +**DO NOT USE ISSUES FOR QUESTIONS** + +Note: New issues raised, where it is clear the submitter has not read the issue template, +are likely to be closed with `invalid` label. Please understand that this is not meant to be rude, +but to keep the issue list clean and useful for everyone. If one opening the issue decides to ignore the issue template, +the maintainers might also decide to ignore the issue. + +**Remove** all the text above the next line when submitting your issue. + +**Describe the bug** +A clear and concise description of what the bug is. +Hint: use a tool like https://requestbin.com to compare working and non-working requests. + +**To Reproduce** +Steps to reproduce the behavior, preferably using a code snippet. +Post the non-working request here as well if you made it work using Postman, Swagger, or any other client. + +**Expected behavior** +A clear and concise description of what you expected to happen. +Post the working request here as well if you made it work using Postman, Swagger, or any other client. +You can use https://requestbin.com/r to create a public request bin and share the link in the issue. + +**Stack trace** +Copy the full stack trace here if you get an exception. + +**Desktop (please complete the following information):** + - OS: [e.g. macOS] + - .NET version [e.g. .NET 6] + - Version [e.g. 110.2.0] + +**Additional context** +Add any other context about the problem here. diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml new file mode 100644 index 000000000..45aa98fc8 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -0,0 +1,5 @@ +blank_issues_enabled: false +contact_links: + - name: Get help + url: https://restsharp.dev/support/#get-help + about: Read about asking questions and reporting issues \ No newline at end of file diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md new file mode 100644 index 000000000..30dd38d77 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature_request.md @@ -0,0 +1,22 @@ +--- +name: Feature request +about: Suggest an idea for this project +title: '' +labels: 'feature-request' +assignees: '' + +--- + +**DO NOT USE ISSUES FOR QUESTIONS** + +**Is your feature request related to a problem? Please describe.** +A clear and concise description of what the problem is. Ex. I'm always frustrated when [...] + +**Describe the solution you'd like** +A clear and concise description of what you want to happen. + +**Describe alternatives you've considered** +A clear and concise description of any alternative solutions or features you've considered. + +**Additional context** +Add any other context or screenshots about the feature request here. diff --git a/.github/copilot-instructions.md b/.github/copilot-instructions.md new file mode 100644 index 000000000..4a54b40d6 --- /dev/null +++ b/.github/copilot-instructions.md @@ -0,0 +1,113 @@ +# Copilot Instructions for RestSharp + +This document provides instructions for GitHub Copilot when working with the RestSharp repository. + +## Project Overview + +RestSharp is a lightweight HTTP API client library for .NET. It wraps `HttpClient` and provides: +- Default parameters of any kind, not just headers +- Multiple ways to add request parameters (query, URL segment, header, cookie, body) +- Built-in serialization/deserialization for JSON, XML, and CSV +- Rich support for authentication + +## Repository Structure + +- `src/RestSharp/` - Main library +- `src/RestSharp.Serializers.*/` - Serializer extensions (NewtonsoftJson, Xml, CsvHelper) +- `gen/SourceGenerator/` - Incremental source generators +- `test/RestSharp.Tests/` - Unit tests +- `test/RestSharp.Tests.Integrated/` - Integration tests (WireMock) +- `test/RestSharp.Tests.Serializers.*/` - Serializer-specific tests +- `benchmarks/RestSharp.Benchmarks/` - Performance tests + +## Build and Test Commands + +```bash +# Build solution +dotnet build RestSharp.sln -c Debug + +# Run all tests +dotnet test RestSharp.sln -c Debug + +# Run tests for specific TFM +dotnet test test/RestSharp.Tests/RestSharp.Tests.csproj -f net8.0 + +# Run single test +dotnet test test/RestSharp.Tests/RestSharp.Tests.csproj --filter "FullyQualifiedName=Namespace.Class.Method" -f net8.0 + +# Pack for release +dotnet pack src/RestSharp/RestSharp.csproj -c Release -o nuget -p:IncludeSymbols=true -p:SymbolPackageFormat=snupkg +``` + +## Multi-Targeting + +The library targets multiple frameworks: +- `netstandard2.0`, `net471`, `net48` - Legacy support +- `net8.0`, `net9.0`, `net10.0` - Modern .NET + +Tests target: `net48` (Windows only), `net8.0`, `net9.0`, `net10.0` + +When adding features: +- Use conditional compilation for TFM-specific APIs: `#if NET` or `#if NET8_0_OR_GREATER` +- Ensure compilation succeeds for all TFMs +- Add polyfills or conditional code for missing APIs on older TFMs + +## Code Style and Conventions + +- Language version: C# preview (latest features allowed) +- Nullable reference types: Enabled in `/src`, disabled in `/test` +- All `/src` files must include the Apache 2.0 license header +- Test files do not require the license header +- Follow `.editorconfig` for formatting rules +- Use partial classes for large types (link with ``) +- Assemblies are strong-named via `RestSharp.snk` + +### License Header for Source Files + +```csharp +// Copyright (c) .NET Foundation and Contributors +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// http://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. +``` + +## Testing Guidelines + +- Frameworks: xUnit + FluentAssertions + AutoFixture +- Use WireMockServer for HTTP scenarios (avoid live endpoints) +- Use descriptive assertions: `result.Should().Be(expected)` +- Guard TFM-specific tests with `#if NET8_0_OR_GREATER` +- Avoid flaky tests: don't depend on timing, locale, or network conditions + +Test projects have global usings configured for `Xunit`, `FluentAssertions`, and `AutoFixture`. + +## Source Generators + +Custom generators in `gen/SourceGenerator/`: +- `[GenerateImmutable]` - Creates read-only wrappers +- `[GenerateClone]` - Creates static factory clone methods +- `[Exclude]` - Excludes properties from immutable generation + +Generator target: `netstandard2.0` (required for all compiler versions) + +## Dependencies + +Package versions are centrally managed in `Directory.Packages.props`. Do not pin versions in individual projects unless justified by TFM constraints. + +## PR Checklist + +Before submitting: +- Builds cleanly across all targeted TFMs +- Tests added/updated and passing +- No new analyzer warnings in `/src` +- License header in new `/src` files +- Public API changes documented and tested diff --git a/.github/dependabot.yml b/.github/dependabot.yml new file mode 100644 index 000000000..fa38860ea --- /dev/null +++ b/.github/dependabot.yml @@ -0,0 +1,15 @@ +version: 2 +updates: + - package-ecosystem: "github-actions" + # default location of `.github/workflows` + directory: "/" + schedule: + interval: "weekly" + + - package-ecosystem: "nuget" + # location of package manifests + directory: "/" + schedule: + interval: "daily" + +# Built with ❤ by [Pipeline Foundation](https://pipeline.foundation) \ No newline at end of file diff --git a/.github/ranger.yml b/.github/ranger.yml new file mode 100644 index 000000000..f2e098b37 --- /dev/null +++ b/.github/ranger.yml @@ -0,0 +1,49 @@ +default: + close: + delay: "3 days" + comment: "⚠️ This issue has been marked $LABEL and will be closed in $DELAY" + remind: + action: label + delay: 7d + message: "A reminder to provide the necessary information or feedback, waiting for $DELAY days" + labels: + - stale + +labels: + awaiting-feedback: + action: remind + awaiting-info: + action: remind + duplicate: + action: close + delay: 15s + comment: "Duplicate issue created! Closing in $DELAY..." + invalid: close + stale: + action: close + delay: 14 days + comment: false + 'merge when passing': merge + approved: + action: merge + 'new contributor': + action: comment + delay: 5s + message: "Thanks for making your first contribution! :slightly_smiling_face:" + +merges: + - action: delete_branch + +comments: + - action: label + pattern: /duplicate of/i + labels: + - duplicate + - action: delete_comment + pattern: "+1" + +commits: + - action: label + pattern: /merge when passing/i + labels: + - merge when passing \ No newline at end of file diff --git a/.github/stale.yml b/.github/stale.yml new file mode 100644 index 000000000..979e69cfc --- /dev/null +++ b/.github/stale.yml @@ -0,0 +1,20 @@ +# Number of days of inactivity before an issue becomes stale +daysUntilStale: 30 +# Number of days of inactivity before a stale issue is closed +daysUntilClose: 7 +# Issues with these labels will never be considered stale +exemptLabels: + - pinned + - security + - keep +# Label to use when marking an issue as stale +staleLabel: wontfix +# Comment to post when marking an issue as stale. Set to `false` to disable +markComment: > + This issue has been automatically marked as stale because it has not had + recent activity. It will be closed if no further activity occurs. Thank you + for your contributions. +# Comment to post when closing a stale issue. Set to `false` to disable +closeComment: > + This issue has been closed because it has not had recent activity. + Thank you for your contributions. diff --git a/.github/workflows/build-dev.yml b/.github/workflows/build-dev.yml new file mode 100644 index 000000000..65ca2899f --- /dev/null +++ b/.github/workflows/build-dev.yml @@ -0,0 +1,48 @@ +name: Build and deploy + +on: + push: + paths-ignore: + - 'docs/**' + - 'yarn.lock' + - 'package.json' + - '**/*.md' + branches: + - dev + tags: + - '*' + +permissions: + contents: read + id-token: write + +jobs: + nuget: + runs-on: ubuntu-latest + + permissions: + id-token: write + + steps: + - + name: Checkout + uses: actions/checkout@v6 + - + name: Setup .NET + uses: actions/setup-dotnet@v5 + with: + dotnet-version: '10.0.x' + - + name: Unshallow + run: git fetch --prune --unshallow + - + name: NuGet login + uses: NuGet/login@v1 + id: nuget-login + with: + user: ${{ secrets.NUGET_USER }} + - + name: Create and push NuGet package + run: | + dotnet pack -c Release -o nuget -p:IncludeSymbols=true -p:SymbolPackageFormat=snupkg + dotnet nuget push **/*.nupkg --api-key ${{ steps.nuget-login.outputs.NUGET_API_KEY }} --source https://api.nuget.org/v3/index.json --skip-duplicate \ No newline at end of file diff --git a/.github/workflows/pull-request.yml b/.github/workflows/pull-request.yml new file mode 100644 index 000000000..12eb9b98d --- /dev/null +++ b/.github/workflows/pull-request.yml @@ -0,0 +1,89 @@ +name: Build and test PRs + +on: + pull_request: + paths-ignore: + - docs/** + +permissions: + contents: read + checks: write + +jobs: + event_file: + name: "Event File" + runs-on: ubuntu-latest + steps: + - name: Upload + uses: actions/upload-artifact@v6 + with: + name: Event File + path: ${{ github.event_path }} + + test-windows: + runs-on: windows-latest + strategy: + matrix: + dotnet: ['net48', 'net8.0', 'net9.0', 'net10.0'] + + steps: + - name: Checkout + uses: actions/checkout@v6 + - name: Setup .NET + uses: actions/setup-dotnet@v5 + with: + dotnet-version: | + 8.0.x + 9.0.x + 10.0.x + - name: Run tests + run: | + dotnet test test/RestSharp.Tests -c Debug -f ${{ matrix.dotnet }} + dotnet test test/RestSharp.Tests.Integrated -c Debug -f ${{ matrix.dotnet }} + dotnet test test/RestSharp.Tests.Serializers.Json -c Debug -f ${{ matrix.dotnet }} + dotnet test test/RestSharp.Tests.Serializers.Xml -c Debug -f ${{ matrix.dotnet }} + dotnet test test/RestSharp.Tests.Serializers.Csv -c Debug -f ${{ matrix.dotnet }} + dotnet test test/RestSharp.Tests.DependencyInjection -c Debug -f ${{ matrix.dotnet }} + - name: Upload Test Results + if: always() + uses: actions/upload-artifact@v6 + with: + name: Test Results Windows ${{ matrix.dotnet }} + path: | + test-results/**/*.xml + test-results/**/*.trx + test-results/**/*.json + + test-linux: + runs-on: ubuntu-latest + strategy: + matrix: + dotnet: [ 'net8.0', 'net9.0', 'net10.0' ] + + steps: + - name: Checkout + uses: actions/checkout@v6 + - name: Setup .NET + uses: actions/setup-dotnet@v5 + with: + dotnet-version: | + 8.0.x + 9.0.x + 10.0.x + - name: Run tests + run: | + dotnet test test/RestSharp.Tests -f ${{ matrix.dotnet }} + dotnet test test/RestSharp.Tests.Integrated -f ${{ matrix.dotnet }} + dotnet test test/RestSharp.Tests.Serializers.Json -f ${{ matrix.dotnet }} + dotnet test test/RestSharp.Tests.Serializers.Xml -f ${{ matrix.dotnet }} + dotnet test test/RestSharp.Tests.Serializers.Csv -f ${{ matrix.dotnet }} + dotnet test test/RestSharp.Tests.DependencyInjection -f ${{ matrix.dotnet }} + - name: Upload Test Results + if: always() + uses: actions/upload-artifact@v6 + with: + name: Test Results Ubuntu ${{ matrix.dotnet }} + path: | + test-results/**/*.xml + test-results/**/*.trx + test-results/**/*.json diff --git a/.github/workflows/test-results.yml b/.github/workflows/test-results.yml new file mode 100644 index 000000000..3d8776868 --- /dev/null +++ b/.github/workflows/test-results.yml @@ -0,0 +1,37 @@ +name: Test Results + +on: + workflow_run: + workflows: ["Build and test PRs"] + types: + - completed +permissions: {} + +jobs: + test-results: + name: Test Results + runs-on: ubuntu-latest + if: github.event.workflow_run.conclusion != 'skipped' + + permissions: + checks: write + pull-requests: write + actions: read + + steps: + - + name: Download and Extract Artifacts + uses: dawidd6/action-download-artifact@fe9d59ce33ce92db8a6ac90b2c8be6b6d90417c8 + with: + run_id: ${{ github.event.workflow_run.id }} + path: artifacts + - + name: Publish Test Results + uses: EnricoMi/publish-unit-test-result-action@v2 + with: + commit: ${{ github.event.workflow_run.head_sha }} + event_file: artifacts/Event File/event.json + event_name: ${{ github.event.workflow_run.event }} + files: | + artifacts/**/*.xml + artifacts/**/*.trx \ No newline at end of file diff --git a/.gitignore b/.gitignore index 141130381..2b2ca2d47 100644 --- a/.gitignore +++ b/.gitignore @@ -1,4 +1,6 @@ -packages +packages/ +nuget.config + #ignore thumbnails created by windows Thumbs.db @@ -48,3 +50,10 @@ RestSharp.IntegrationTests/config.json *.ncrunchproject *.ncrunchsolution /.vs/RestSharp/v15/Server/sqlite3 +/.vs/ +/node_modules/ +/out/ +/docs/.vuepress/dist/ +.vscode/ +.temp/ +*.trx \ No newline at end of file diff --git a/.idea/.gitignore b/.idea/.gitignore new file mode 100644 index 000000000..9b0e31c26 --- /dev/null +++ b/.idea/.gitignore @@ -0,0 +1,6 @@ +# Default ignored files +/shelf/ +/workspace.xml +# Editor-based HTTP Client requests +/httpRequests/ +/material_theme_project_new.xml diff --git a/.idea/RestSharp.iml b/.idea/RestSharp.iml new file mode 100644 index 000000000..0c8867d7e --- /dev/null +++ b/.idea/RestSharp.iml @@ -0,0 +1,12 @@ + + + + + + + + + + + + \ No newline at end of file diff --git a/.idea/modules.xml b/.idea/modules.xml new file mode 100644 index 000000000..1fe75c51a --- /dev/null +++ b/.idea/modules.xml @@ -0,0 +1,8 @@ + + + + + + + + \ No newline at end of file diff --git a/.idea/vcs.xml b/.idea/vcs.xml new file mode 100644 index 000000000..94a25f7f4 --- /dev/null +++ b/.idea/vcs.xml @@ -0,0 +1,6 @@ + + + + + + \ No newline at end of file diff --git a/.nuget/NuGet.Config b/.nuget/NuGet.Config deleted file mode 100644 index 3f0e00340..000000000 --- a/.nuget/NuGet.Config +++ /dev/null @@ -1,6 +0,0 @@ - - - - - - \ No newline at end of file diff --git a/BEST_PRACTICES.md b/BEST_PRACTICES.md new file mode 100644 index 000000000..bc0a58802 --- /dev/null +++ b/BEST_PRACTICES.md @@ -0,0 +1,214 @@ +# RestSharp – Best Practices + +This document captures practical guidance for developing, testing, reviewing, and releasing changes in the RestSharp repository. It consolidates conventions used across the solution and provides checklists and examples to reduce regressions and ensure consistency across target frameworks. + + +## 1) Daily Development Workflow + +- Prefer small, focused pull requests with clear descriptions and test coverage. +- Build and test locally before pushing. Validate all relevant target frameworks (TFMs) for your changes. +- Keep commits tidy; prefer meaningful commit messages over large "fix" commits. +- Follow repository code style and file organization rules (see sections below). +- Use the latest C# language features (C# 14). + +Suggested loop: +- dotnet build +- dotnet test + +## 2) Multi-Targeting Guidance + +The core library targets netstandard2.0, net471, net48, net8.0, net9.0, and net10.0. Tests target net48 (Windows only), net8.0, net9.0, and net10.0. + +- Use conditional compilation for TFM-specific APIs or behaviors: + - #if NET + - #if NET for platform attributes (e.g., [UnsupportedOSPlatform("browser")]) +- When adding features, ensure compilation succeeds for all TFMs. If an API is missing on older TFMs, add polyfills or conditional code, or guard with feature detection. +- Be mindful of System.Text.Json: it is a package dependency on older TFMs but built-in on modern TFMs. +- Validate tests for each TFM impacted by your changes. If a test only applies to modern .NET, guard it with #if NET8_0_OR_GREATER. + + +## 3) Build and Configuration + +- Shared build logic lives in props/Common.props, src/Directory.Build.props, and test/Directory.Build.props. Do not duplicate MSBuild settings in individual projects unless necessary. +- Language version is preview; prefer modern C# features but ensure cross-TFM compatibility. +- Nullable reference types: + - Enabled in /src (Nullable=enable). Treat nullable warnings as design feedback. + - Disabled in /test (Nullable=disable) for test authoring ergonomics. +- Assemblies are strong-named via RestSharp.snk. Do not remove signing. +- Package versions are centrally managed in Directory.Packages.props; do not pin versions locally unless justified by TFM constraints. + + +## 4) Source Generators + +Custom incremental generators live in gen/SourceGenerator and are referenced as analyzers by src/RestSharp. + +- Use [GenerateImmutable] to produce immutable wrappers of mutable classes. + - Exclude properties with [Exclude] when not needed in the immutable type. + - Generated files are emitted to obj///generated/SourceGenerator/. +- Use [GenerateClone(BaseType=..., Name=...)] to create static factory methods that upcast/copy base properties into derived types. +- When editing generators: + - Keep the generator targets netstandard2.0. + - Ensure EmitCompilerGeneratedFiles is enabled when debugging locally. + - Validate output by building and inspecting generated files under obj/... +- Keep generator helpers cohesive (Extensions.cs) and prefer small, composable utilities. + + +## 5) Testing Strategy + +- Frameworks and libraries: xUnit + FluentAssertions + AutoFixture. +- Organization: + - Unit tests in test/RestSharp.Tests. + - Integration tests (HTTP/WireMock) in test/RestSharp.Tests.Integrated. + - Serializer-specific tests in dedicated projects. + - Shared helpers in test/RestSharp.Tests.Shared. +- Best practices: + - Co-locate tests with feature areas; use partial classes to split large suites. + - Prefer WireMockServer over live endpoints for HTTP scenarios. + - Avoid flaky tests: don’t depend on timing, locale, or network conditions. + - Use descriptive assertions, e.g., result.Should().Be(expected). + - Scope tests by TFM when API availability differs. +- Useful commands: + - dotnet test RestSharp.sln -c Debug + - dotnet test test/RestSharp.Tests/RestSharp.Tests.csproj -f net8.0 + - dotnet test test/RestSharp.Tests/RestSharp.Tests.csproj --filter "FullyQualifiedName=Namespace.Class.Method" -f net8.0 +- Test results are written to test-results//.trx. + + +## 6) Code Coverage + +- Use coverlet.collector for data-collector-based coverage. +- Example command (Cobertura output): + - dotnet test test/RestSharp.Tests/RestSharp.Tests.csproj -f net10.0 --collect:"XPlat Code Coverage" -- DataCollectionRunSettings.DataCollectors.DataCollector.Configuration.Format=cobertura +- Coverage artifacts are placed alongside test results in test-results. + + +## 7) Dependency Injection and Extensions + +- DI extensions live in src/RestSharp.Extensions.DependencyInjection. +- When updating DI helpers: + - Keep APIs minimal and idiomatic for Microsoft.Extensions.DependencyInjection. + - Maintain backward compatibility where feasible; add overloads rather than breaking changes. + - Add focused tests under test/RestSharp.Tests.DependencyInjection. + + +## 8) Serialization Extensions + +- JSON (Newtonsoft.Json), XML, and CSV serializers are separate packages within src/RestSharp.Serializers.*. +- Keep serializer-specific behavior isolated. Avoid coupling core library to serializers. +- Each serializer project has its own tests; ensure behavior parity across TFMs. + + +## 9) Performance and Benchmarks + +- Use benchmarks/RestSharp.Benchmarks for perf investigations. +- Before merging performance-related changes: + - Validate allocations and throughput with BenchmarkDotNet where practical. + - Check for regression across TFMs if the code path is shared. + + +## 10) Versioning and Packaging + +- Versioning is handled by MinVer via Git tags and history. Ensure CI uses full history (unshallow fetch). +- Do not hardcode versions; rely on MinVer for assembly and file versions (CustomVersion target aligns versions post-MinVer). +- Packaging notes: + - dotnet pack src/RestSharp/RestSharp.csproj -c Release -o nuget -p:IncludeSymbols=true -p:SymbolPackageFormat=snupkg + - Symbol packages must be .snupkg; SourceLink is enabled for debugging. + - NuGet metadata is defined in src/Directory.Build.props; keep it accurate. + + +## 11) Continuous Integration + +- PR workflow executes matrix tests on Windows (net48, net8.0, net9.0, net10.0) and Linux (net8.0, net9.0, net10.0). +- Build/Deploy workflow packages and pushes to NuGet on dev branch and tags using OIDC-based auth. +- To simulate CI locally: + - dotnet test -c Debug -f net8.0 + - Optionally also run -f net9.0 and -f net10.0. On Windows, include net48. +- Uploading artifacts and publishing test results are CI-responsibilities; keep local output organized in test-results for quick inspection. + + +## 12) Code Organization and Style + +- File organization: + - Use partial classes to split large types by responsibility (e.g., RestClient.*, PropertyCache.*). Link related files via in csproj when appropriate. +- License header: + - All source files under /src must include the standard repository license header. + - Test files do not require the header. +- EditorConfig and rules: + - Follow .editorconfig for formatting and analyzer rules. + - In /src, suppress XML doc warnings via NoWarn=1591; in tests suppress xUnit1033 and CS8002 as configured. +- Nullable: + - Treat nullable annotations and warnings as design signals; prefer explicit nullability and defensive checks at public boundaries. +- Public API surface: + - Avoid breaking changes. If unavoidable, document in docs and changelog, and add clear migration notes. + + +## 13) PR Readiness Checklist + +Use this quick checklist before requesting review: +- Builds cleanly across all targeted TFMs for affected projects. +- Unit/integration tests added or updated; all pass locally for relevant TFMs. +- No analyzer warnings introduced in src (beyond allowed suppressions). +- License header present in new /src files. +- Source generator changes validated (if applicable) by inspecting obj/.../generated output. +- Public API changes reviewed, documented, and tested. +- Central package versions unchanged unless intentionally updated with justification. +- Commit messages and PR description explain the why and the how. + + +## 14) Troubleshooting Guide + +- Tests fail only on a specific TFM + - Run with -f to isolate. Look for conditional compilation and API availability differences. +- Generator output missing + - Ensure EmitCompilerGeneratedFiles is true in the project under test; clean and rebuild; inspect obj/.../generated. +- net48 failures on non-Windows + - Expected. Use net8.0 or higher on Linux/macOS. Run net48 only on Windows. +- MinVer version incorrect + - Ensure CI or local clone has full git history (git fetch --prune --unshallow). +- Platform-specific failures + - Use [UnsupportedOSPlatform] and conditional compilation to guard APIs not available on Browser, etc. + + +## 15) Useful Commands (Quick Reference) + +- Build solution (Release): + - dotnet build RestSharp.sln -c Release +- Run tests for a single TFM: + - dotnet test test/RestSharp.Tests/RestSharp.Tests.csproj -f net8.0 +- Run a single test by fully-qualified name: + - dotnet test test/RestSharp.Tests/RestSharp.Tests.csproj --filter "FullyQualifiedName=RestSharp.Tests.ObjectParserTests.ShouldUseRequestProperty" -f net8.0 +- Pack locally with symbols: + - dotnet pack src/RestSharp/RestSharp.csproj -c Release -o nuget -p:IncludeSymbols=true -p:SymbolPackageFormat=snupkg +- View generated source files after build: + - find src/RestSharp/obj/Debug -name "*.g.cs" -o -name "ReadOnly*.cs" +- Clean all build artifacts: + - dotnet clean RestSharp.sln + - rm -rf src/*/bin src/*/obj test/*/bin test/*/obj gen/*/bin gen/*/obj + + +## 16) Documentation and References + +- Main docs: https://restsharp.dev +- Repository: https://github.com/restsharp/RestSharp +- NuGet Packages: + - RestSharp + - RestSharp.Serializers.NewtonsoftJson + - RestSharp.Serializers.Xml + - RestSharp.Serializers.CsvHelper +- License: Apache-2.0 + +## 17) Working with Issues + +- Use issues for bugs and feature requests only. For questions and support, use: + - StackOverflow with tag `restsharp` +- When creating an issue: + - Provide clear, concise description and reproduction steps. + - Include relevant code snippets or links to repro projects. + - Use appropriate labels and templates. +- When addressing an issue: + - Avoid changing the default behavior unless absolutely necessary. + - Avoid breaking the existing API. + - Leave the existing tests to catch possible regressions. + - Add new tests for the fixed cases. + +Keep this document up-to-date when build properties, TFMs, CI workflows, or repository conventions change. \ No newline at end of file diff --git a/CLAUDE.md b/CLAUDE.md new file mode 100644 index 000000000..1fd8c31b5 --- /dev/null +++ b/CLAUDE.md @@ -0,0 +1,104 @@ +# CLAUDE.md + +This file provides guidance to Claude Code (claude.ai/code) when working with code in this repository. + +## Build & Test Commands + +```bash +# Build +dotnet build RestSharp.slnx -c Debug + +# Run all tests +dotnet test RestSharp.slnx -c Debug + +# Run tests for a specific TFM +dotnet test RestSharp.slnx -f net9.0 + +# Run a single test by fully-qualified name +dotnet test test/RestSharp.Tests/RestSharp.Tests.csproj --filter "FullyQualifiedName=RestSharp.Tests.ObjectParserTests.ShouldUseRequestProperty" -f net8.0 + +# Pack +dotnet pack src/RestSharp/RestSharp.csproj -c Release -o nuget -p:IncludeSymbols=true -p:SymbolPackageFormat=snupkg +``` + +**Note:** `dotnet test` with `.slnx` does not work with `net8.0`. To run tests targeting `net8.0`, use individual project files: `dotnet test test/RestSharp.Tests/RestSharp.Tests.csproj -f net8.0` + +## Project Overview + +RestSharp is a lightweight HTTP API client library for .NET that wraps `HttpClient`. It provides default parameters, multiple parameter types (query, URL segment, header, cookie, body), built-in JSON/XML/CSV serialization, and authentication support. + +### Repository Layout + +- `src/RestSharp/` — Core library +- `src/RestSharp.Serializers.NewtonsoftJson/` — Newtonsoft.Json serializer adapter +- `src/RestSharp.Serializers.Xml/` — Custom XML serializer +- `src/RestSharp.Serializers.CsvHelper/` — CsvHelper serializer adapter +- `src/RestSharp.Extensions.DependencyInjection/` — DI integration +- `gen/SourceGenerator/` — Custom incremental source generators +- `test/RestSharp.Tests/` — Unit tests +- `test/RestSharp.Tests.Integrated/` — Integration tests (WireMock-based) +- `test/RestSharp.Tests.Serializers.*/` — Serializer-specific tests + +## Architecture + +### Core Classes + +- **RestClient** (`RestClient.cs`, split into partials `RestClient.*.cs`) — Main entry point. Wraps `HttpClient`, holds `ReadOnlyRestClientOptions`, `RestSerializers`, and `DefaultParameters`. Thread-safe when configured via `RestClientOptions`. +- **RestRequest** (`Request/RestRequest.cs`) — Request container with fluent API via extension methods in `RestRequest*.cs` files. Parameters split by type: query, body, header, URL segment, cookie, file. +- **RestResponse / RestResponse\** (`Response/RestResponse*.cs`) — Response containers with public setters. `[GenerateClone]` generates a static factory to copy base properties from `RestResponse` into `RestResponse`. +- **RestClientOptions** (`Options/RestClientOptions.cs`) — Mutable configuration class. An immutable `ReadOnlyRestClientOptions` wrapper is generated by `[GenerateImmutable]`. + +### Request Pipeline + +`ExecuteAsync` → build request → interceptor chain (`BeforeRequest` → `BeforeHttpRequest` → send → `AfterHttpRequest` → `AfterRequest`) → deserialization → error handling. Interceptors are configured via `RestClientOptions.Interceptors`. + +### Parameter System (`Parameters/`) + +Abstract `Parameter` record base with concrete types: `HeaderParameter`, `QueryParameter`, `BodyParameter`, `UrlSegmentParameter`, `FileParameter`, `GetOrPostParameter`, `CookieParameter`. `ObjectParser` converts objects to parameters via reflection. + +### Serialization (`Serializers/`) + +`ISerializer`/`IDeserializer` interfaces. `RestSerializers` manages serializers by `DataFormat` enum (Json, Xml, Csv). Default: `SystemTextJsonSerializer`. Configured via `ConfigureSerialization` delegate in client constructors. + +### Authentication (`Authenticators/`) + +`IAuthenticator` with single `Authenticate(IRestClient, RestRequest)` method. Built-in: `HttpBasicAuthenticator`, `JwtAuthenticator`, OAuth1/OAuth2 authenticators. Set via `RestClientOptions.Authenticator`. + +### Source Generators (`gen/SourceGenerator/`) + +- `[GenerateImmutable]` — Creates read-only wrapper (used on `RestClientOptions`) +- `[GenerateClone]` — Creates static factory clone methods (used on `RestResponse`) +- `[Exclude]` — Excludes properties from immutable generation +- Generator target must be `netstandard2.0`. Inspect output in `obj///generated/SourceGenerator/`. + +## Multi-Targeting + +**Library:** `netstandard2.0`, `net471`, `net48`, `net8.0`, `net9.0`, `net10.0` +**Tests:** `net48` (Windows only), `net8.0`, `net9.0`, `net10.0` + +Use conditional compilation for TFM-specific APIs: `#if NET`, `#if NET8_0_OR_GREATER`. `System.Text.Json` is a NuGet dependency on older TFMs but built-in on net8.0+. + +## Code Style & Conventions + +- **C# version:** preview (latest features) +- **Nullable:** Enabled in `/src`, disabled in `/test` +- **License header required** in all `/src` files (Apache-2.0, see `.github/copilot-instructions.md` for exact text) +- **Strong-named** assemblies via `RestSharp.snk` +- **Partial classes** for large types, linked via `` in csproj +- **Package versions** centrally managed in `Directory.Packages.props` — don't pin in individual projects +- **Versioning** via MinVer from git tags (no hardcoded versions) +- Follow `.editorconfig` for formatting + +## Testing + +- **Stack:** xUnit + FluentAssertions + AutoFixture +- **HTTP mocking:** WireMock.Net (avoid live endpoints) +- Global usings in test projects: `Xunit`, `FluentAssertions`, `AutoFixture` +- Guard TFM-specific tests with `#if NET8_0_OR_GREATER` +- Test results: `test-results//.trx` + +## Working with Issues + +- Avoid changing default behavior unless absolutely necessary +- Avoid breaking the existing API +- Leave existing tests intact to catch regressions; add new tests for fixed cases diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 81723d640..8a308e70e 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -2,16 +2,18 @@ Follow these guidelines, in no particular order, to improve your chances of havi ### Before you do anything else - * Before reporting an issue or creating a pull request, discuss it in the Google Group http://groups.google.com/group/restsharp + * DO: Read about [getting help](https://restsharp.dev/support/#get-help) in the docs. + * DO: Follow the guidelines below when contributing. + * DO: Discuss bigger change in the issue before implementing it. + * DO NOT: Use issues to ask questions about using the library. ### Once a contribution is ready to be submitted * Make each pull request atomic and exclusive; don't send pull requests for a laundry list of changes. * Even better, commit in small manageable chunks. * Spaces, not tabs. Bracket style doesn't matter. Do not reformat code you didn't touch. - * Changes to XmlDeserializer or JsonDeserializer must be accompanied by a unit test covering the change. - * In general, changes should be accompanied by unit tests to show what was broken and how your patch fixes it. + * Changes should be accompanied by unit tests to show what was broken and how your patch fixes it. * No regions except for license header - * Code must build for .NET 3.5 Client Profile, Silverlight 4 and Windows Phone 7 + * Code must build for .NET 4.5.2 and .NET Standard 2.0 * If you didn't write the code you must provide a reference to where you obtained it and preferably the license. - * Use autocrlf=true `git config --global core.autocrlf true` http://help.github.com/dealing-with-lineendings/ \ No newline at end of file + * Use autocrlf=true `git config --global core.autocrlf true` http://help.github.com/dealing-with-lineendings/ diff --git a/Directory.Packages.props b/Directory.Packages.props new file mode 100644 index 000000000..fa169fa0d --- /dev/null +++ b/Directory.Packages.props @@ -0,0 +1,53 @@ + + + true + + + 10.0.0 + 10.0.0 + + + 9.0.10 + + + 8.0.21 + + + 10.0.0 + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/LICENSE.txt b/LICENSE.txt index 9aa0a58ae..6ff179708 100644 --- a/LICENSE.txt +++ b/LICENSE.txt @@ -1,3 +1,6 @@ +Copyright (c) .NET Foundation and Contributors +All Rights Reserved + Apache License Version 2.0, January 2004 http://www.apache.org/licenses/ diff --git a/README.md b/README.md index 28150dd9b..e128a9ad9 100644 --- a/README.md +++ b/README.md @@ -1,75 +1,87 @@ # RestSharp - Simple .NET REST Client -[![Build status](https://ci.appveyor.com/api/projects/status/5vdwwducje0miayf?svg=true)](https://ci.appveyor.com/project/hallem/restsharp) +![](https://img.shields.io/nuget/dt/RestSharp) [![](https://img.shields.io/nuget/v/RestSharp)](https://www.nuget.org/packages/RestSharp) [![](https://img.shields.io/nuget/vpre/RestSharp)](https://www.nuget.org/packages/RestSharp#versions-body-tab) -[![Join the chat at https://gitter.im/RestSharp/RestSharp](https://badges.gitter.im/RestSharp/RestSharp.svg)](https://gitter.im/RestSharp/RestSharp?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge) +RestSharp is a lightweight HTTP API client library. It's a wrapper around `HttpClient`, not a full-fledged client on +its own. -### [Official Site][1] - [@RestSharp][2] +What RestSharp adds to `HttpClient`: +- Default parameters of any kind, not just headers +- Add a parameter of any kind to requests, like query, URL segment, header, cookie, or body +- Multiple ways to add a request body, including JSON, XML, URL-encoded form data, multipart form data with and + without files +- Built-in serialization and deserilization of JSON, XML, and CSV, as well as the ability to add custom serializers +- Rich support for authentication -### License: Apache License 2.0 +## Compatibility note -### Note on RestSharp.Signed +RestSharp 107 was a major release that brings a lot of changes. We've removed a lot of legacy code and added new +features. Finally, RestSharp has moved to `HttpClient`. We also deprecated the following: +- SimpleJson in favour of `System.Text.Json.JsonSerialzer` +- `IRestRequest`, and `IRestResponse` in favour of implementing classes +- Everything `Http` and `IHttp` as those are just wrappers +- Client configuration moved to `RestClientOptions` to make the client thread-safe +- `IRestClient` interface surface substantially reduced -The `RestSharp` package is now signed so there is no need to install `RestSharp.Signed`, which is obsolete from v160.0.0. +Most of the client and some of the request options are now in `RestClientOptions`. -### Features +Check [v107+ docs](https://restsharp.dev/v107) for more information. -* Assemblies for .NET 4.5.2 and .NET Standard 2.0 -* Easy installation using [NuGet](http://nuget.org/packages/RestSharp) for most .NET flavors (signed) -* Automatic XML and JSON deserialization -* Supports custom serialization and deserialization via ISerializer and IDeserializer -* Fuzzy element name matching ('product_id' in XML/JSON will match C# property named 'ProductId') -* Automatic detection of type of content returned -* GET, POST, PUT, PATCH, HEAD, OPTIONS, DELETE supported -* Other non-standard HTTP methods also supported -* OAuth 1, OAuth 2, Basic, NTLM and Parameter-based Authenticators included -* Supports custom authentication schemes via IAuthenticator -* Multi-part form/file uploads +## Packages -```csharp -var client = new RestClient("http://example.com"); -// client.Authenticator = new HttpBasicAuthenticator(username, password); +| Package | What it's for | +|----------------------------------------|--------------------------------------------------------------------------------------| +| `RestSharp` | The core library, including `System.Text.Json` serializer and basical XML serializer | +| `RestSharp.Serializers.NewtonsoftJson` | Use `Newtonsoft.Json` as a JSON serializer | +| `RestSharp.Serializers.Xml` | Use custom RestSharp XML serializer for XML | +| `RestSharp.Serializers.CsvHelper` | Use `CsvHelper` as a CSV serializer | -var request = new RestRequest("resource/{id}", Method.POST); -request.AddParameter("name", "value"); // adds to POST or URL querystring based on Method -request.AddUrlSegment("id", "123"); // replaces matching token in request.Resource +## Code of Conduct -// add parameters for all properties on an object -request.AddObject(object); +This project has adopted the code of conduct defined by the Contributor Covenant to clarify expected behavior in our community. +For more information see the [.NET Foundation Code of Conduct](https://dotnetfoundation.org/code-of-conduct). -// or just whitelisted properties -request.AddObject(object, "PersonId", "Name", ...); +**Users violated the aforementioned code of conduct will be blocked.** -// easily add HTTP Headers -request.AddHeader("header", "value"); +## Support -// add files to upload (works with compatible verbs) -request.AddFile("file", path); +RestSharp is an open-source project with a single maintainer. Do not expect your issue to be resolved unless it concerns a large group of RestSharp users. +The best way to resolve your issue is to fix it yourself. Fork the repository and submit a pull request. +You can also motivate the maintainer by sponsoring this project. -// execute the request -IRestResponse response = client.Execute(request); -var content = response.Content; // raw content as string +### Contribute -// or automatically deserialize result -// return content type is sniffed but can be explicitly set via RestClient.AddHandler(); -IRestResponse response2 = client.Execute(request); -var name = response2.Data.Name; +Please read [CONTRIBUTING.md](CONTRIBUTING.md) for details on the process for reporting issues and submitting pull requests. -// or download and save file to disk -client.DownloadData(request).SaveAs(path); +### Get help -// easy async support -await client.ExecuteAsync(request); +Read the docs: [Official Site][1] -// async with deserialization -var asyncHandle = client.ExecuteAsync(request, response => { - Console.WriteLine(response.Data.Name); -}); - -// abort the request on demand -asyncHandle.Abort(); -``` +Ask a question on StackOverflow with the tag `restsharp`. - [1]: http://restsharp.org - [2]: http://twitter.com/RestSharp - [3]: http://groups.google.com/group/RestSharp +Join RestSharp Discord server: [![Discord](https://img.shields.io/discord/1224723555053207612?label=Discord)](https://discord.gg/NdpzHZ2qep) + +Find RestSharp on Twitter: [@RestSharp][2] + +## Community + +### .NET Foundation + +This project is a part of the [.NET Foundation](https://dotnetfoundation.org). + +### Code Contributors + +This project exists thanks to all the people who contribute. +[](https://github.com/restsharp/RestSharp/graphs/contributors) + +### Financial Contributors + +Become a financial contributor and help us sustain our community. [Contribute](https://github.com/sponsors/restsharp) + +## License + +[Apache License 2.0](https://github.com/restsharp/RestSharp/blob/dev/LICENSE.txt) + + [1]: https://restsharp.dev + [2]: https://twitter.com/RestSharp + [3]: https://github.com/restsharp/RestSharp/issues diff --git a/RestSharp.IntegrationTests/App.config b/RestSharp.IntegrationTests/App.config deleted file mode 100644 index 0adbb2a65..000000000 --- a/RestSharp.IntegrationTests/App.config +++ /dev/null @@ -1,22 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - diff --git a/RestSharp.IntegrationTests/AsyncRequestBodyTests.cs b/RestSharp.IntegrationTests/AsyncRequestBodyTests.cs deleted file mode 100644 index e0bcca182..000000000 --- a/RestSharp.IntegrationTests/AsyncRequestBodyTests.cs +++ /dev/null @@ -1,220 +0,0 @@ -using System.IO; -using System.Net; -using System.Threading; -using NUnit.Framework; -using RestSharp.IntegrationTests.Helpers; - -namespace RestSharp.IntegrationTests -{ - [TestFixture] - public class AsyncRequestBodyTests - { - private SimpleServer _server; - private RestClient _client; - private const string BaseUrl = "http://localhost:8888/"; - - [TearDown] - public void ShutdownServer() => _server.Dispose(); - - [SetUp] - public void CreateClient() - { - _server = SimpleServer.Create(BaseUrl, Handlers.Generic()); - _client = new RestClient(BaseUrl); - } - - [Test] - public void Can_Not_Be_Added_To_GET_Request() - { - const Method httpMethod = Method.GET; - - RestRequest request = new RestRequest(RequestBodyCapturer.Resource, httpMethod); - - const string contentType = "text/plain"; - const string bodyData = "abc123 foo bar baz BING!"; - - request.AddParameter(contentType, bodyData, ParameterType.RequestBody); - - ManualResetEvent resetEvent = new ManualResetEvent(false); - - _client.ExecuteAsync(request, response => resetEvent.Set()); - resetEvent.WaitOne(); - - AssertHasNoRequestBody(); - } - - [Test] - public void Can_Have_No_Body_Added_To_POST_Request() - { - const Method httpMethod = Method.POST; - - RestRequest request = new RestRequest(RequestBodyCapturer.Resource, httpMethod); - ManualResetEvent resetEvent = new ManualResetEvent(false); - - _client.ExecuteAsync(request, response => resetEvent.Set()); - resetEvent.WaitOne(); - - AssertHasNoRequestBody(); - } - - [Test] - public void Can_Be_Added_To_POST_Request() - { - const Method httpMethod = Method.POST; - - RestRequest request = new RestRequest(RequestBodyCapturer.Resource, httpMethod); - - const string contentType = "text/plain"; - const string bodyData = "abc123 foo bar baz BING!"; - - request.AddParameter(contentType, bodyData, ParameterType.RequestBody); - - ManualResetEvent resetEvent = new ManualResetEvent(false); - - _client.ExecuteAsync(request, response => resetEvent.Set()); - resetEvent.WaitOne(); - - AssertHasRequestBody(contentType, bodyData); - } - - [Test] - public void Can_Be_Added_To_PUT_Request() - { - const Method httpMethod = Method.PUT; - - RestRequest request = new RestRequest(RequestBodyCapturer.Resource, httpMethod); - - const string contentType = "text/plain"; - const string bodyData = "abc123 foo bar baz BING!"; - - request.AddParameter(contentType, bodyData, ParameterType.RequestBody); - - ManualResetEvent resetEvent = new ManualResetEvent(false); - - _client.ExecuteAsync(request, response => resetEvent.Set()); - resetEvent.WaitOne(); - - AssertHasRequestBody(contentType, bodyData); - } - - [Test] - public void Can_Be_Added_To_DELETE_Request() - { - const Method httpMethod = Method.DELETE; - - RestRequest request = new RestRequest(RequestBodyCapturer.Resource, httpMethod); - - const string contentType = "text/plain"; - const string bodyData = "abc123 foo bar baz BING!"; - - request.AddParameter(contentType, bodyData, ParameterType.RequestBody); - - ManualResetEvent resetEvent = new ManualResetEvent(false); - - _client.ExecuteAsync(request, response => resetEvent.Set()); - resetEvent.WaitOne(); - - AssertHasRequestBody(contentType, bodyData); - } - - [Test] - public void Can_Not_Be_Added_To_HEAD_Request() - { - const Method httpMethod = Method.HEAD; - - RestRequest request = new RestRequest(RequestBodyCapturer.Resource, httpMethod); - - const string contentType = "text/plain"; - const string bodyData = "abc123 foo bar baz BING!"; - - request.AddParameter(contentType, bodyData, ParameterType.RequestBody); - - ManualResetEvent resetEvent = new ManualResetEvent(false); - - _client.ExecuteAsync(request, response => resetEvent.Set()); - resetEvent.WaitOne(); - - AssertHasNoRequestBody(); - } - - [Test] - public void Can_Be_Added_To_OPTIONS_Request() - { - const Method httpMethod = Method.OPTIONS; - - RestRequest request = new RestRequest(RequestBodyCapturer.Resource, httpMethod); - - const string contentType = "text/plain"; - const string bodyData = "abc123 foo bar baz BING!"; - - request.AddParameter(contentType, bodyData, ParameterType.RequestBody); - - ManualResetEvent resetEvent = new ManualResetEvent(false); - - _client.ExecuteAsync(request, response => resetEvent.Set()); - resetEvent.WaitOne(); - - AssertHasRequestBody(contentType, bodyData); - } - - [Test] - public void Can_Be_Added_To_PATCH_Request() - { - const Method httpMethod = Method.PATCH; - - RestRequest request = new RestRequest(RequestBodyCapturer.Resource, httpMethod); - - const string contentType = "text/plain"; - const string bodyData = "abc123 foo bar baz BING!"; - - request.AddParameter(contentType, bodyData, ParameterType.RequestBody); - - ManualResetEvent resetEvent = new ManualResetEvent(false); - - _client.ExecuteAsync(request, response => resetEvent.Set()); - resetEvent.WaitOne(); - - AssertHasRequestBody(contentType, bodyData); - } - - private static void AssertHasNoRequestBody() - { - Assert.Null(RequestBodyCapturer.CapturedContentType); - Assert.AreEqual(false, RequestBodyCapturer.CapturedHasEntityBody); - Assert.AreEqual(string.Empty, RequestBodyCapturer.CapturedEntityBody); - } - - private static void AssertHasRequestBody(string contentType, string bodyData) - { - Assert.AreEqual(contentType, RequestBodyCapturer.CapturedContentType); - Assert.AreEqual(true, RequestBodyCapturer.CapturedHasEntityBody); - Assert.AreEqual(bodyData, RequestBodyCapturer.CapturedEntityBody); - } - - private class RequestBodyCapturer - { - public const string Resource = "Capture"; - - public static string CapturedContentType { get; set; } - - public static bool CapturedHasEntityBody { get; set; } - - public static string CapturedEntityBody { get; set; } - - public static void Capture(HttpListenerContext context) - { - HttpListenerRequest request = context.Request; - - CapturedContentType = request.ContentType; - CapturedHasEntityBody = request.HasEntityBody; - CapturedEntityBody = StreamToString(request.InputStream); - } - - private static string StreamToString(Stream stream) - { - StreamReader streamReader = new StreamReader(stream); - return streamReader.ReadToEnd(); - } - } - } -} \ No newline at end of file diff --git a/RestSharp.IntegrationTests/AsyncTests.cs b/RestSharp.IntegrationTests/AsyncTests.cs deleted file mode 100644 index cf9aac918..000000000 --- a/RestSharp.IntegrationTests/AsyncTests.cs +++ /dev/null @@ -1,279 +0,0 @@ -using NUnit.Framework; -using RestSharp.IntegrationTests.Helpers; -using System; -using System.Linq; -using System.Net; -using System.Threading; -using System.Threading.Tasks; - -namespace RestSharp.IntegrationTests -{ - [TestFixture] - public class AsyncTests - { - [Test] - public void Can_Perform_GET_Async() - { - Uri baseUrl = new Uri("http://localhost:8888/"); - const string val = "Basic async test"; - - ManualResetEvent resetEvent = new ManualResetEvent(false); - - using (SimpleServer.Create(baseUrl.AbsoluteUri, Handlers.EchoValue(val))) - { - RestClient client = new RestClient(baseUrl); - RestRequest request = new RestRequest(""); - - client.ExecuteAsync(request, (response, asyncHandle) => - { - Assert.NotNull(response.Content); - Assert.AreEqual(val, response.Content); - resetEvent.Set(); - }); - - resetEvent.WaitOne(); - } - } - - [Test] - public void Can_Perform_GET_Async_Without_Async_Handle() - { - Uri baseUrl = new Uri("http://localhost:8888/"); - const string val = "Basic async test"; - - ManualResetEvent resetEvent = new ManualResetEvent(false); - - using (SimpleServer.Create(baseUrl.AbsoluteUri, Handlers.EchoValue(val))) - { - RestClient client = new RestClient(baseUrl); - RestRequest request = new RestRequest(""); - - client.ExecuteAsync(request, response => - { - Assert.NotNull(response.Content); - Assert.AreEqual(val, response.Content); - resetEvent.Set(); - }); - - resetEvent.WaitOne(); - } - } - - [Test] - public async Task Can_Perform_GET_TaskAsync() - { - const string baseUrl = "http://localhost:8888/"; - const string val = "Basic async task test"; - - using (SimpleServer.Create(baseUrl, Handlers.EchoValue(val))) - { - RestClient client = new RestClient(baseUrl); - RestRequest request = new RestRequest(""); - var result = await client.ExecuteTaskAsync(request); - - Assert.NotNull(result.Content); - Assert.AreEqual(val, result.Content); - } - } - - [Test] - public async Task Can_Handle_Exception_Thrown_By_OnBeforeDeserialization_Handler() - { - const string baseUrl = "http://localhost:8888/"; - const string exceptionMessage = "Thrown from OnBeforeDeserialization"; - - using (SimpleServer.Create(baseUrl, Handlers.Generic())) - { - RestClient client = new RestClient(baseUrl); - RestRequest request = new RestRequest("success"); - - request.OnBeforeDeserialization += r => { throw new Exception(exceptionMessage); }; - - var response = await client.ExecuteTaskAsync(request); - - Assert.AreEqual(exceptionMessage, response.ErrorMessage); - Assert.AreEqual(ResponseStatus.Error, response.ResponseStatus); - } - } - - [Test] - public async Task Can_Perform_ExecuteGetTaskAsync_With_Response_Type() - { - const string baseUrl = "http://localhost:8888/"; - - using (SimpleServer.Create(baseUrl, Handlers.Generic())) - { - RestClient client = new RestClient(baseUrl); - RestRequest request = new RestRequest("success"); - var response = await client.ExecuteTaskAsync(request); - - Assert.AreEqual("Works!", response.Data.Message); - } - } - - [Test] - public async Task Can_Perform_GetTaskAsync_With_Response_Type() - { - const string baseUrl = "http://localhost:8888/"; - - using (SimpleServer.Create(baseUrl, Handlers.Generic())) - { - RestClient client = new RestClient(baseUrl); - RestRequest request = new RestRequest("success"); - var response = await client.GetTaskAsync(request); - - Assert.AreEqual("Works!", response.Message); - } - } - -#if !APPVEYOR - [Test] - public void Can_Cancel_GET_TaskAsync() - { - const string baseUrl = "http://localhost:8888/"; - const string val = "Basic async task test"; - - using (SimpleServer.Create(baseUrl, Handlers.EchoValue(val))) - { - RestClient client = new RestClient(baseUrl); - RestRequest request = new RestRequest("timeout"); - CancellationTokenSource cancellationTokenSource = new CancellationTokenSource(); - Task task = client.ExecuteTaskAsync(request, cancellationTokenSource.Token); - - cancellationTokenSource.Cancel(); - - Assert.True(task.IsCanceled); - } - } -#endif - - [Test] - public void Can_Cancel_GET_TaskAsync_With_Response_Type() - { - const string baseUrl = "http://localhost:8888/"; - const string val = "Basic async task test"; - - using (SimpleServer.Create(baseUrl, Handlers.EchoValue(val))) - { - RestClient client = new RestClient(baseUrl); - RestRequest request = new RestRequest("timeout"); - CancellationTokenSource cancellationTokenSource = new CancellationTokenSource(); - Task> task = client.ExecuteTaskAsync(request, cancellationTokenSource.Token); - - cancellationTokenSource.Cancel(); - - Assert.True(task.IsCanceled); - } - } - - [Test] - public async Task Handles_GET_Request_Errors_TaskAsync() - { - const string baseUrl = "http://localhost:8888/"; - - using (SimpleServer.Create(baseUrl, UrlToStatusCodeHandler)) - { - RestClient client = new RestClient(baseUrl); - RestRequest request = new RestRequest("404"); - var response = await client.ExecuteTaskAsync(request); - - Assert.AreEqual(HttpStatusCode.NotFound, response.StatusCode); - } - } - - [Test] - public async Task Handles_GET_Request_Errors_TaskAsync_With_Response_Type() - { - const string baseUrl = "http://localhost:8888/"; - - using (SimpleServer.Create(baseUrl, UrlToStatusCodeHandler)) - { - RestClient client = new RestClient(baseUrl); - RestRequest request = new RestRequest("404"); - var response = await client.ExecuteTaskAsync(request); - - Assert.Null(response.Data); - } - } - - [Test] - public async Task Can_Timeout_GET_TaskAsync() - { - const string baseUrl = "http://localhost:8888/"; - - using (SimpleServer.Create(baseUrl, Handlers.Generic())) - { - RestClient client = new RestClient(baseUrl); - IRestRequest request = new RestRequest("timeout", Method.GET).AddBody("Body_Content"); - - // Half the value of ResponseHandler.Timeout - request.Timeout = 500; - - var response = await client.ExecuteTaskAsync(request); - - Assert.AreEqual(ResponseStatus.TimedOut, response.ResponseStatus); - } - } - - [Test] - public async Task Can_Timeout_PUT_TaskAsync() - { - const string baseUrl = "http://localhost:8888/"; - - using (SimpleServer.Create(baseUrl, Handlers.Generic())) - { - RestClient client = new RestClient(baseUrl); - IRestRequest request = new RestRequest("timeout", Method.PUT).AddBody("Body_Content"); - - // Half the value of ResponseHandler.Timeout - request.Timeout = 500; - - var response = await client.ExecuteTaskAsync(request); - - Assert.AreEqual(ResponseStatus.TimedOut, response.ResponseStatus); - } - } - - private static void UrlToStatusCodeHandler(HttpListenerContext obj) - { - obj.Response.StatusCode = int.Parse(obj.Request.Url.Segments.Last()); - } - - private class ResponseHandler - { - private void error(HttpListenerContext context) - { - context.Response.StatusCode = 400; - context.Response.Headers.Add("Content-Type", "application/xml"); - context.Response.OutputStream.WriteStringUtf8( - @" - - - Not found! - -"); - } - - private void success(HttpListenerContext context) - { - context.Response.OutputStream.WriteStringUtf8( - @" - - - Works! - -"); - } - - private void timeout(HttpListenerContext context) - { - Thread.Sleep(1000); - } - } - - private class Response - { - public string Message { get; set; } - } - } -} diff --git a/RestSharp.IntegrationTests/AuthenticationTests.cs b/RestSharp.IntegrationTests/AuthenticationTests.cs deleted file mode 100644 index 8857a485b..000000000 --- a/RestSharp.IntegrationTests/AuthenticationTests.cs +++ /dev/null @@ -1,98 +0,0 @@ -using System; -using System.Diagnostics; -using System.Net; -using System.Text; -using System.Web; -using NUnit.Framework; -using RestSharp.Authenticators; -using RestSharp.IntegrationTests.Helpers; - -namespace RestSharp.IntegrationTests -{ - [TestFixture] - public class AuthenticationTests - { - private static void UsernamePasswordEchoHandler(HttpListenerContext context) - { - var header = context.Request.Headers["Authorization"]; - var parts = Encoding.ASCII.GetString(Convert.FromBase64String(header.Substring("Basic ".Length))) - .Split(':'); - - context.Response.OutputStream.WriteStringUtf8(string.Join("|", parts)); - } - - //[Test] - public void Can_Authenticate_With_OAuth() - { - var baseUrl = new Uri("https://api.twitter.com"); - var client = new RestClient(baseUrl) - { - Authenticator = OAuth1Authenticator.ForRequestToken("CONSUMER_KEY", "CONSUMER_SECRET") - }; - var request = new RestRequest("oauth/request_token"); - var response = client.Execute(request); - - Assert.NotNull(response); - Assert.AreEqual(HttpStatusCode.OK, response.StatusCode); - - var qs = HttpUtility.ParseQueryString(response.Content); - var oauthToken = qs["oauth_token"]; - var oauthTokenSecret = qs["oauth_token_secret"]; - - Assert.NotNull(oauthToken); - Assert.NotNull(oauthTokenSecret); - - request = new RestRequest("oauth/authorize?oauth_token=" + oauthToken); - - var url = client.BuildUri(request) - .ToString(); - - Process.Start(url); - - const string verifier = "123456"; // <-- Breakpoint here (set verifier in debugger) - - request = new RestRequest("oauth/access_token"); - client.Authenticator = OAuth1Authenticator.ForAccessToken( - "P5QziWtocYmgWAhvlegxw", "jBs07SIxJ0kodeU9QtLEs1W1LRgQb9u5Lc987BA94", oauthToken, - oauthTokenSecret, verifier); - response = client.Execute(request); - - Assert.NotNull(response); - Assert.AreEqual(HttpStatusCode.OK, response.StatusCode); - - qs = HttpUtility.ParseQueryString(response.Content); - oauthToken = qs["oauth_token"]; - oauthTokenSecret = qs["oauth_token_secret"]; - - Assert.NotNull(oauthToken); - Assert.NotNull(oauthTokenSecret); - - request = new RestRequest("account/verify_credentials.xml"); - client.Authenticator = OAuth1Authenticator.ForProtectedResource( - "P5QziWtocYmgWAhvlegxw", "jBs07SIxJ0kodeU9QtLEs1W1LRgQb9u5Lc987BA94", oauthToken, - oauthTokenSecret); - response = client.Execute(request); - - Assert.NotNull(response); - Assert.AreEqual(HttpStatusCode.OK, response.StatusCode); - } - - [Test] - public void Can_Authenticate_With_Basic_Http_Auth() - { - var baseUrl = new Uri("http://localhost:8888/"); - - using (SimpleServer.Create(baseUrl.AbsoluteUri, UsernamePasswordEchoHandler)) - { - var client = new RestClient(baseUrl) - { - Authenticator = new HttpBasicAuthenticator("testuser", "testpassword") - }; - var request = new RestRequest("test"); - var response = client.Execute(request); - - Assert.AreEqual("testuser|testpassword", response.Content); - } - } - } -} \ No newline at end of file diff --git a/RestSharp.IntegrationTests/CompressionTests.cs b/RestSharp.IntegrationTests/CompressionTests.cs deleted file mode 100644 index 539afe855..000000000 --- a/RestSharp.IntegrationTests/CompressionTests.cs +++ /dev/null @@ -1,80 +0,0 @@ -using System; -using System.IO.Compression; -using System.Net; -using NUnit.Framework; -using RestSharp.IntegrationTests.Helpers; - -namespace RestSharp.IntegrationTests -{ - [TestFixture] - public class CompressionTests - { - [Test] - public void Can_Handle_Gzip_Compressed_Content() - { - Uri baseUrl = new Uri("http://localhost:8888/"); - - using (SimpleServer.Create(baseUrl.AbsoluteUri, GzipEchoValue("This is some gzipped content"))) - { - RestClient client = new RestClient(baseUrl); - RestRequest request = new RestRequest(""); - IRestResponse response = client.Execute(request); - - Assert.AreEqual("This is some gzipped content", response.Content); - } - } - - [Test] - public void Can_Handle_Deflate_Compressed_Content() - { - Uri baseUrl = new Uri("http://localhost:8888/"); - - using (SimpleServer.Create(baseUrl.AbsoluteUri, DeflateEchoValue("This is some deflated content"))) - { - RestClient client = new RestClient(baseUrl); - RestRequest request = new RestRequest(""); - IRestResponse response = client.Execute(request); - - Assert.AreEqual("This is some deflated content", response.Content); - } - } - - [Test] - public void Can_Handle_Uncompressed_Content() - { - Uri baseUrl = new Uri("http://localhost:8888/"); - - using (SimpleServer.Create(baseUrl.AbsoluteUri, Handlers.EchoValue("This is some sample content"))) - { - RestClient client = new RestClient(baseUrl); - RestRequest request = new RestRequest(""); - IRestResponse response = client.Execute(request); - - Assert.AreEqual("This is some sample content", response.Content); - } - } - - private static Action GzipEchoValue(string value) => - context => - { - context.Response.Headers.Add("Content-encoding", "gzip"); - - using (GZipStream gzip = new GZipStream(context.Response.OutputStream, CompressionMode.Compress, true)) - { - gzip.WriteStringUtf8(value); - } - }; - - private static Action DeflateEchoValue(string value) => - context => - { - context.Response.Headers.Add("Content-encoding", "deflate"); - - using (DeflateStream gzip = - new DeflateStream(context.Response.OutputStream, CompressionMode.Compress, true)) - { - gzip.WriteStringUtf8(value); - } - }; - } -} \ No newline at end of file diff --git a/RestSharp.IntegrationTests/FileTests.cs b/RestSharp.IntegrationTests/FileTests.cs deleted file mode 100644 index f37b782f6..000000000 --- a/RestSharp.IntegrationTests/FileTests.cs +++ /dev/null @@ -1,66 +0,0 @@ -using System; -using System.IO; -using System.Reflection; -using NUnit.Framework; -using RestSharp.IntegrationTests.Helpers; - -namespace RestSharp.IntegrationTests -{ - [TestFixture] - public class FileTests - { - private Uri _baseUrl; - private SimpleServer _server; - private RestClient _client; - private string _path; - - [OneTimeSetUp] - public void SetupServer() - { - _baseUrl = new Uri("http://localhost:8888/"); - _path = AppDomain.CurrentDomain.BaseDirectory; - } - - [TearDown] - public void ShutdownServer() => _server.Dispose(); - - [SetUp] - public void CreateClient() - { - _client = new RestClient(_baseUrl); - _server = SimpleServer.Create(_baseUrl.AbsoluteUri, c => Handlers.FileHandler(c, _path)); - } - - [Test] - public void Handles_Binary_File_Download() - { - RestRequest request = new RestRequest("Assets/Koala.jpg"); - byte[] response = _client.DownloadData(request); - byte[] expected = File.ReadAllBytes(_path + "\\Assets\\Koala.jpg"); - - Assert.AreEqual(expected, response); - } - - [Test] - public void Writes_Response_To_Stream() - { - string tempFile = Path.GetTempFileName(); - - using (FileStream writer = File.OpenWrite(tempFile)) - { - RestRequest request = new RestRequest("Assets/Koala.jpg") - { - ResponseWriter = (responseStream) => responseStream.CopyTo(writer) - }; - byte[] response = _client.DownloadData(request); - - Assert.Null(response); - } - - byte[] fromTemp = File.ReadAllBytes(tempFile); - byte[] expected = File.ReadAllBytes(_path + "\\Assets\\Koala.jpg"); - - Assert.AreEqual(expected, fromTemp); - } - } -} \ No newline at end of file diff --git a/RestSharp.IntegrationTests/Helpers/Extensions.cs b/RestSharp.IntegrationTests/Helpers/Extensions.cs deleted file mode 100644 index 9cc908bce..000000000 --- a/RestSharp.IntegrationTests/Helpers/Extensions.cs +++ /dev/null @@ -1,15 +0,0 @@ -using System.IO; -using System.Text; - -namespace RestSharp.IntegrationTests.Helpers -{ - public static class Extensions - { - public static void WriteStringUtf8(this Stream target, string value) - { - byte[] encoded = Encoding.UTF8.GetBytes(value); - - target.Write(encoded, 0, encoded.Length); - } - } -} diff --git a/RestSharp.IntegrationTests/Helpers/Handlers.cs b/RestSharp.IntegrationTests/Helpers/Handlers.cs deleted file mode 100644 index 6a01742b1..000000000 --- a/RestSharp.IntegrationTests/Helpers/Handlers.cs +++ /dev/null @@ -1,79 +0,0 @@ -using System; -using System.IO; -using System.Linq; -using System.Net; -using System.Reflection; - -namespace RestSharp.IntegrationTests.Helpers -{ - public static class Handlers - { - /// - /// Echoes the request input back to the output. - /// - public static void Echo(HttpListenerContext context) - { - context.Request.InputStream.CopyTo(context.Response.OutputStream); - } - - /// - /// Echoes the given value back to the output. - /// - public static Action EchoValue(string value) - { - return ctx => ctx.Response.OutputStream.WriteStringUtf8(value); - } - - /// - /// Response to a request like this: http://localhost:8888/assets/koala.jpg - /// by streaming the file located at "assets\koala.jpg" back to the client. - /// - public static void FileHandler(HttpListenerContext context, string path) - { - var pathToFile = Path.Combine(path, Path.Combine(context.Request.Url.Segments.Select(s => s.Replace("/", "")) - .ToArray())); - - using (var reader = new StreamReader(pathToFile)) - { - reader.BaseStream.CopyTo(context.Response.OutputStream); - } - } - - /// - /// T should be a class that implements methods whose names match the urls being called, and take one parameter, an HttpListenerContext. - /// e.g. - /// urls exercised: "http://localhost:8888/error" and "http://localhost:8888/get_list" - /// - /// class MyHandler - /// { - /// void error(HttpListenerContext ctx) - /// { - /// // do something interesting here - /// } - /// - /// void get_list(HttpListenerContext ctx) - /// { - /// // do something interesting here - /// } - /// } - /// - public static Action Generic() where T : new() - { - return ctx => - { - string methodName = ctx.Request.Url.Segments.Last(); - MethodInfo method = typeof(T).GetMethod(methodName, - BindingFlags.NonPublic | BindingFlags.Public | BindingFlags.Instance | BindingFlags.Static); - - if (method.IsStatic) - { - method.Invoke(null, new object[] { ctx }); - } - else - { - method.Invoke(new T(), new object[] { ctx }); - } - }; - } - } -} diff --git a/RestSharp.IntegrationTests/Helpers/SimpleServer.cs b/RestSharp.IntegrationTests/Helpers/SimpleServer.cs deleted file mode 100644 index 69ecda000..000000000 --- a/RestSharp.IntegrationTests/Helpers/SimpleServer.cs +++ /dev/null @@ -1,33 +0,0 @@ -using System; -using System.Net; - -namespace RestSharp.IntegrationTests.Helpers -{ - public class SimpleServer : IDisposable - { - private readonly WebServer _server; - - public static SimpleServer Create(string url, Action handler = null, - AuthenticationSchemes authenticationSchemes = AuthenticationSchemes.Anonymous) - { - return new SimpleServer(url, handler, authenticationSchemes); - } - - private SimpleServer(string url, Action handler = null, - AuthenticationSchemes authenticationSchemes = AuthenticationSchemes.Anonymous) - { - _server = new WebServer(url, handler, authenticationSchemes); - _server.Run(); - } - - public void Dispose() - { - _server.Stop(); - } - - public void SetHandler(Action handler) - { - _server.ChangeHandler(handler); - } - } -} \ No newline at end of file diff --git a/RestSharp.IntegrationTests/Helpers/WebServer.cs b/RestSharp.IntegrationTests/Helpers/WebServer.cs deleted file mode 100644 index f6fdb26ae..000000000 --- a/RestSharp.IntegrationTests/Helpers/WebServer.cs +++ /dev/null @@ -1,57 +0,0 @@ -using System; -using System.Net; -using System.Text; -using System.Threading; - -namespace RestSharp.IntegrationTests -{ - public class WebServer - { - private readonly HttpListener _listener = new HttpListener(); - private Action _responderMethod; - private CancellationTokenSource _cts; - - public WebServer(string prefix, Action method, AuthenticationSchemes authenticationSchemes) - { - if (string.IsNullOrEmpty(prefix)) - throw new ArgumentException("URI prefix is required"); - - _listener.Prefixes.Add(prefix); - _listener.AuthenticationSchemes = authenticationSchemes; - - _responderMethod = method; - _listener.Start(); - } - - public void Run() - { - _cts = new CancellationTokenSource(); - ThreadPool.QueueUserWorkItem(o => - { - var token = (CancellationToken) o; - while (!token.IsCancellationRequested && _listener.IsListening) - { - ThreadPool.QueueUserWorkItem(c => - { - if (!(c is HttpListenerContext ctx)) return; - _responderMethod?.Invoke(ctx); - ctx.Response.OutputStream.Close(); - }, _listener.IsListening ? _listener.GetContext() : null); - } - }, _cts.Token); - } - - public void Stop() - { - _cts.Cancel(); - _listener.Stop(); - _listener.Close(); - _cts.Dispose(); - } - - public void ChangeHandler(Action handler) - { - _responderMethod = handler; - } - } -} \ No newline at end of file diff --git a/RestSharp.IntegrationTests/Models/LinkedINMemberProfile.cs b/RestSharp.IntegrationTests/Models/LinkedINMemberProfile.cs deleted file mode 100644 index 8f359656d..000000000 --- a/RestSharp.IntegrationTests/Models/LinkedINMemberProfile.cs +++ /dev/null @@ -1,16 +0,0 @@ - -namespace RestSharp.IntegrationTests.Models -{ - /// - /// Model for used by the LinkedIN integration tests. - /// . - /// - public class LinkedInMemberProfile - { - public string Id { get; set; } - - public string FirstName { get; set; } - - public string LastName { get; set; } - } -} diff --git a/RestSharp.IntegrationTests/MultipartFormDataTests.cs b/RestSharp.IntegrationTests/MultipartFormDataTests.cs deleted file mode 100644 index 8a6bcc8a0..000000000 --- a/RestSharp.IntegrationTests/MultipartFormDataTests.cs +++ /dev/null @@ -1,189 +0,0 @@ -using System; -using System.IO; -using System.Net; -using System.Threading; -using System.Threading.Tasks; -using NUnit.Framework; -using RestSharp.IntegrationTests.Helpers; - -namespace RestSharp.IntegrationTests -{ - [TestFixture] - public class MultipartFormDataTests - { - private readonly string _expected = - "-------------------------------28947758029299" + Environment.NewLine + - "Content-Disposition: form-data; name=\"foo\"" + Environment.NewLine + Environment.NewLine + - "bar" + Environment.NewLine + - "-------------------------------28947758029299" + Environment.NewLine + - "Content-Disposition: form-data; name=\"a name with spaces\"" + Environment.NewLine + Environment.NewLine + - "somedata" + Environment.NewLine + - "-------------------------------28947758029299--" + Environment.NewLine; - - private readonly string _expectedFileAndBodyRequestContent = - "-------------------------------28947758029299" + Environment.NewLine + - "Content-Type: application/json" + Environment.NewLine + - "Content-Disposition: form-data; name=\"controlName\"" + Environment.NewLine + Environment.NewLine + - "test" + Environment.NewLine + - "-------------------------------28947758029299" + Environment.NewLine + - "Content-Disposition: form-data; name=\"fileName\"; filename=\"TestFile.txt\"" + Environment.NewLine + - "Content-Type: application/octet-stream" + Environment.NewLine + Environment.NewLine + - "This is a test file for RestSharp." + Environment.NewLine + - "-------------------------------28947758029299--" + Environment.NewLine; - - private SimpleServer _server; - private RestClient _client; - - private const string BaseUrl = "http://localhost:8888/"; - - [SetUp] - public void SetupServer() - { - _server = SimpleServer.Create(BaseUrl, EchoHandler); - _client = new RestClient(BaseUrl); - } - - [TearDown] - public void ShutdownServer() => _server.Dispose(); - - [Test] - public async Task MultipartFormData_WithParameterAndFile_Async() - { - var request = new RestRequest("/", Method.POST) - { - AlwaysMultipartFormData = true - }; - - string path = Path.Combine(AppDomain.CurrentDomain.BaseDirectory, "Assets\\TestFile.txt"); - request.AddFile("fileName", path); - - request.AddParameter("controlName", "test", "application/json", ParameterType.RequestBody); - - var response = await _client.ExecuteTaskAsync(request); - Assert.AreEqual(_expectedFileAndBodyRequestContent, response.Content); - } - - [Test] - public void MultipartFormData_WithParameterAndFile() - { - var request = new RestRequest("/", Method.POST) - { - AlwaysMultipartFormData = true - }; - - string path = Path.Combine(AppDomain.CurrentDomain.BaseDirectory, "Assets\\TestFile.txt"); - request.AddFile("fileName", path); - - request.AddParameter("controlName", "test", "application/json", ParameterType.RequestBody); - - IRestResponse response = _client.Execute(request); - - Assert.AreEqual(_expectedFileAndBodyRequestContent, response.Content); - } - - [Test] - public void MultipartFormDataAsync() - { - RestRequest request = new RestRequest("/", Method.POST) - { - AlwaysMultipartFormData = true - }; - - AddParameters(request); - - _client.ExecuteAsync(request, (restResponse, handle) => - { - Console.WriteLine(restResponse.Content); - Assert.AreEqual(this._expected, restResponse.Content); - }); - } - - [Test] - public void MultipartFormData() - { - RestRequest request = new RestRequest("/", Method.POST) - { - AlwaysMultipartFormData = true - }; - - AddParameters(request); - - IRestResponse response = _client.Execute(request); - - Assert.AreEqual(_expected, response.Content); - } - - [Test] - public void AlwaysMultipartFormData_WithParameter_Execute() - { - RestRequest request = new RestRequest("?json_route=/posts") - { - AlwaysMultipartFormData = true, - Method = Method.POST, - }; - - request.AddParameter("title", "test", ParameterType.RequestBody); - - IRestResponse response = _client.Execute(request); - - Assert.Null(response.ErrorException); - } - - [Test] - public async Task AlwaysMultipartFormData_WithParameter_ExecuteTaskAsync() - { - var request = new RestRequest("?json_route=/posts") - { - AlwaysMultipartFormData = true, - Method = Method.POST, - }; - - request.AddParameter("title", "test", ParameterType.RequestBody); - - var response = await _client.ExecuteTaskAsync(request); - Assert.Null(response.ErrorException); - } - - [Test] - public void AlwaysMultipartFormData_WithParameter_ExecuteAsync() - { - RestRequest request = new RestRequest("?json_route=/posts") - { - AlwaysMultipartFormData = true, - Method = Method.POST, - }; - - request.AddParameter("title", "test", ParameterType.RequestBody); - - IRestResponse syncResponse = null; - - using (AutoResetEvent eventWaitHandle = new AutoResetEvent(false)) - { - _client.ExecuteAsync(request, response => - { - syncResponse = response; - eventWaitHandle.Set(); - }); - - eventWaitHandle.WaitOne(); - } - - Assert.Null(syncResponse.ErrorException); - } - - private static void EchoHandler(HttpListenerContext obj) - { - obj.Response.StatusCode = 200; - - StreamReader streamReader = new StreamReader(obj.Request.InputStream); - - obj.Response.OutputStream.WriteStringUtf8(streamReader.ReadToEnd()); - } - - private static void AddParameters(IRestRequest request) - { - request.AddParameter("foo", "bar"); - request.AddParameter("a name with spaces", "somedata"); - } - } -} \ No newline at end of file diff --git a/RestSharp.IntegrationTests/NonProtocolExceptionHandlingTests.cs b/RestSharp.IntegrationTests/NonProtocolExceptionHandlingTests.cs deleted file mode 100644 index b5f03a640..000000000 --- a/RestSharp.IntegrationTests/NonProtocolExceptionHandlingTests.cs +++ /dev/null @@ -1,164 +0,0 @@ -using System.Net; -using System.Threading; -using System.Threading.Tasks; -using NUnit.Framework; -using RestSharp.IntegrationTests.Helpers; - -namespace RestSharp.IntegrationTests -{ - [TestFixture] - public class NonProtocolExceptionHandlingTests - { - /// - /// Success of this test is based largely on the behavior of your current DNS. - /// For example, if you're using OpenDNS this will test will fail; ResponseStatus will be Completed. - /// - [Test] - public void Handles_Non_Existent_Domain() - { - RestClient client = new RestClient("http://nonexistantdomainimguessing.org"); - RestRequest request = new RestRequest("foo"); - IRestResponse response = client.Execute(request); - - Assert.AreEqual(ResponseStatus.Error, response.ResponseStatus); - } - - // ReSharper disable once ClassNeverInstantiated.Local - private class StupidClass - { - public string Property { get; set; } - } - - [Test] -#if NETCORE - [Ignore("Not supported for .NET Core")] -#endif - public async Task Task_Handles_Non_Existent_Domain() - { - RestClient client = new RestClient("http://192.168.1.200:8001"); - RestRequest request = new RestRequest("/") - { - RequestFormat = DataFormat.Json, - Method = Method.GET - }; - var response = await client.ExecuteTaskAsync(request); - - Assert.IsInstanceOf(response.ErrorException); - Assert.AreEqual(WebExceptionStatus.ConnectFailure, ((WebException)response.ErrorException).Status); - Assert.AreEqual(ResponseStatus.Error, response.ResponseStatus); - } - - /// - /// Tests that RestSharp properly handles a non-protocol error. - /// Simulates a server timeout, then verifies that the ErrorException - /// property is correctly populated. - /// - [Test] - public void Handles_Server_Timeout_Error() - { - const string baseUrl = "http://localhost:8888/"; - - using (SimpleServer.Create(baseUrl, TimeoutHandler)) - { - RestClient client = new RestClient(baseUrl); - RestRequest request = new RestRequest("404") - { - Timeout = 500 - }; - IRestResponse response = client.Execute(request); - - Assert.NotNull(response.ErrorException); - Assert.IsInstanceOf(response.ErrorException); - Assert.AreEqual(ResponseStatus.TimedOut, response.ResponseStatus); - } - } - - [Test] - public void Handles_Server_Timeout_Error_Async() - { - const string baseUrl = "http://localhost:8888/"; - - ManualResetEvent resetEvent = new ManualResetEvent(false); - - using (SimpleServer.Create(baseUrl, TimeoutHandler)) - { - RestClient client = new RestClient(baseUrl); - RestRequest request = new RestRequest("404") - { - Timeout = 500 - }; - IRestResponse response = null; - - client.ExecuteAsync(request, responseCb => - { - response = responseCb; - resetEvent.Set(); - }); - - resetEvent.WaitOne(); - - Assert.NotNull(response); - Assert.AreEqual(response.ResponseStatus, ResponseStatus.TimedOut); - Assert.NotNull(response.ErrorException); - Assert.IsInstanceOf(response.ErrorException); - Assert.AreEqual(response.ErrorException.Message, "The request timed-out."); - } - } - - [Test] - public void Handles_Server_Timeout_Error_AsyncTask() - { - const string baseUrl = "http://localhost:8888/"; - - using (SimpleServer.Create(baseUrl, TimeoutHandler)) - { - RestClient client = new RestClient(baseUrl); - RestRequest request = new RestRequest("404") { Timeout = 500 }; - Task task = client.ExecuteTaskAsync(request); - - task.Wait(); - - IRestResponse response = task.Result; - - Assert.NotNull(response); - Assert.AreEqual(response.ResponseStatus, ResponseStatus.TimedOut); - - Assert.NotNull(response.ErrorException); - Assert.IsInstanceOf(response.ErrorException); - Assert.AreEqual(response.ErrorException.Message, "The request timed-out."); - } - } - - /// - /// Tests that RestSharp properly handles a non-protocol error. - /// Simulates a server timeout, then verifies that the ErrorException - /// property is correctly populated. - /// - [Test] - public void Handles_Server_Timeout_Error_With_Deserializer() - { - const string baseUrl = "http://localhost:8888/"; - - using (SimpleServer.Create(baseUrl, TimeoutHandler)) - { - RestClient client = new RestClient(baseUrl); - RestRequest request = new RestRequest("404") { Timeout = 500 }; - IRestResponse response = client.Execute(request); - - Assert.Null(response.Data); - Assert.NotNull(response.ErrorException); - Assert.IsInstanceOf(response.ErrorException); - Assert.AreEqual(response.ResponseStatus, ResponseStatus.TimedOut); - } - } - - /// - /// Simulates a long server process that should result in a client timeout - /// - /// - public static void TimeoutHandler(HttpListenerContext context) - { - Thread.Sleep(101000); - } - } -} diff --git a/RestSharp.IntegrationTests/RequestBodyTests.cs b/RestSharp.IntegrationTests/RequestBodyTests.cs deleted file mode 100644 index 71f9317eb..000000000 --- a/RestSharp.IntegrationTests/RequestBodyTests.cs +++ /dev/null @@ -1,216 +0,0 @@ -using System.IO; -using System.Net; -using NUnit.Framework; -using RestSharp.IntegrationTests.Helpers; - -namespace RestSharp.IntegrationTests -{ - [TestFixture] - public class RequestBodyTests - { - private const string BASE_URL = "http://localhost:8888/"; - - [Test] - public void Can_Not_Be_Added_To_GET_Request() - { - const Method httpMethod = Method.GET; - - using (SimpleServer.Create(BASE_URL, Handlers.Generic())) - { - RestClient client = new RestClient(BASE_URL); - RestRequest request = new RestRequest(RequestBodyCapturer.RESOURCE, httpMethod); - - const string contentType = "text/plain"; - const string bodyData = "abc123 foo bar baz BING!"; - - request.AddParameter(contentType, bodyData, ParameterType.RequestBody); - - client.Execute(request); - - AssertHasNoRequestBody(); - } - } - - [Test] - public void Can_Have_No_Body_Added_To_POST_Request() - { - const Method httpMethod = Method.POST; - - using (SimpleServer.Create(BASE_URL, Handlers.Generic())) - { - RestClient client = new RestClient(BASE_URL); - RestRequest request = new RestRequest(RequestBodyCapturer.RESOURCE, httpMethod); - - client.Execute(request); - - AssertHasNoRequestBody(); - } - } - - [Test] - public void Can_Be_Added_To_POST_Request() - { - const Method httpMethod = Method.POST; - - using (SimpleServer.Create(BASE_URL, Handlers.Generic())) - { - RestClient client = new RestClient(BASE_URL); - RestRequest request = new RestRequest(RequestBodyCapturer.RESOURCE, httpMethod); - - const string contentType = "text/plain"; - const string bodyData = "abc123 foo bar baz BING!"; - - request.AddParameter(contentType, bodyData, ParameterType.RequestBody); - - client.Execute(request); - - AssertHasRequestBody(contentType, bodyData); - } - } - - [Test] - public void Can_Be_Added_To_PUT_Request() - { - const Method httpMethod = Method.PUT; - - using (SimpleServer.Create(BASE_URL, Handlers.Generic())) - { - RestClient client = new RestClient(BASE_URL); - RestRequest request = new RestRequest(RequestBodyCapturer.RESOURCE, httpMethod); - - const string contentType = "text/plain"; - const string bodyData = "abc123 foo bar baz BING!"; - - request.AddParameter(contentType, bodyData, ParameterType.RequestBody); - - client.Execute(request); - - AssertHasRequestBody(contentType, bodyData); - } - } - - [Test] - public void Can_Be_Added_To_DELETE_Request() - { - const Method httpMethod = Method.DELETE; - - using (SimpleServer.Create(BASE_URL, Handlers.Generic())) - { - RestClient client = new RestClient(BASE_URL); - RestRequest request = new RestRequest(RequestBodyCapturer.RESOURCE, httpMethod); - - const string contentType = "text/plain"; - const string bodyData = "abc123 foo bar baz BING!"; - - request.AddParameter(contentType, bodyData, ParameterType.RequestBody); - - client.Execute(request); - - AssertHasRequestBody(contentType, bodyData); - } - } - - [Test] - public void Can_Not_Be_Added_To_HEAD_Request() - { - const Method httpMethod = Method.HEAD; - - using (SimpleServer.Create(BASE_URL, Handlers.Generic())) - { - RestClient client = new RestClient(BASE_URL); - RestRequest request = new RestRequest(RequestBodyCapturer.RESOURCE, httpMethod); - - const string contentType = "text/plain"; - const string bodyData = "abc123 foo bar baz BING!"; - - request.AddParameter(contentType, bodyData, ParameterType.RequestBody); - - client.Execute(request); - - AssertHasNoRequestBody(); - } - } - - [Test] - public void Can_Be_Added_To_OPTIONS_Request() - { - const Method httpMethod = Method.OPTIONS; - - using (SimpleServer.Create(BASE_URL, Handlers.Generic())) - { - RestClient client = new RestClient(BASE_URL); - RestRequest request = new RestRequest(RequestBodyCapturer.RESOURCE, httpMethod); - - const string contentType = "text/plain"; - const string bodyData = "abc123 foo bar baz BING!"; - - request.AddParameter(contentType, bodyData, ParameterType.RequestBody); - - client.Execute(request); - - AssertHasRequestBody(contentType, bodyData); - } - } - - [Test] - public void Can_Be_Added_To_PATCH_Request() - { - const Method httpMethod = Method.PATCH; - - using (SimpleServer.Create(BASE_URL, Handlers.Generic())) - { - RestClient client = new RestClient(BASE_URL); - RestRequest request = new RestRequest(RequestBodyCapturer.RESOURCE, httpMethod); - - const string contentType = "text/plain"; - const string bodyData = "abc123 foo bar baz BING!"; - - request.AddParameter(contentType, bodyData, ParameterType.RequestBody); - - client.Execute(request); - - AssertHasRequestBody(contentType, bodyData); - } - } - - private static void AssertHasNoRequestBody() - { - Assert.Null(RequestBodyCapturer.CapturedContentType); - Assert.AreEqual(false, RequestBodyCapturer.CapturedHasEntityBody); - Assert.AreEqual(string.Empty, RequestBodyCapturer.CapturedEntityBody); - } - - private static void AssertHasRequestBody(string contentType, string bodyData) - { - Assert.AreEqual(contentType, RequestBodyCapturer.CapturedContentType); - Assert.AreEqual(true, RequestBodyCapturer.CapturedHasEntityBody); - Assert.AreEqual(bodyData, RequestBodyCapturer.CapturedEntityBody); - } - - private class RequestBodyCapturer - { - public const string RESOURCE = "Capture"; - - public static string CapturedContentType { get; set; } - - public static bool CapturedHasEntityBody { get; set; } - - public static string CapturedEntityBody { get; set; } - - public static void Capture(HttpListenerContext context) - { - HttpListenerRequest request = context.Request; - - CapturedContentType = request.ContentType; - CapturedHasEntityBody = request.HasEntityBody; - CapturedEntityBody = StreamToString(request.InputStream); - } - - private static string StreamToString(Stream stream) - { - StreamReader streamReader = new StreamReader(stream); - return streamReader.ReadToEnd(); - } - } - } -} diff --git a/RestSharp.IntegrationTests/RequestHeadTests.cs b/RestSharp.IntegrationTests/RequestHeadTests.cs deleted file mode 100644 index 8deae9f98..000000000 --- a/RestSharp.IntegrationTests/RequestHeadTests.cs +++ /dev/null @@ -1,114 +0,0 @@ -using System.Collections.Specialized; -using System.Linq; -using System.Net; -using NUnit.Framework; -using RestSharp.IntegrationTests.Helpers; - -namespace RestSharp.IntegrationTests -{ - [TestFixture] - public class RequestHeadTests - { - private const string BASE_URL = "http://localhost:8888/"; - - [SetUp] - public void SetupRequestHeadTests() - { - RequestHeadCapturer.Initialize(); - } - - [Test] - public void Does_Not_Pass_Default_Credentials_When_Server_Does_Not_Negotiate() - { - const Method httpMethod = Method.GET; - - using (SimpleServer.Create(BASE_URL, Handlers.Generic())) - { - RestClient client = new RestClient(BASE_URL); - RestRequest request = new RestRequest(RequestHeadCapturer.RESOURCE, httpMethod) - { - UseDefaultCredentials = true - }; - - client.Execute(request); - - Assert.NotNull(RequestHeadCapturer.CapturedHeaders); - - string[] keys = RequestHeadCapturer.CapturedHeaders.Keys.Cast() - .ToArray(); - - Assert.False(keys.Contains("Authorization"), - "Authorization header was present in HTTP request from client, even though server does not use the Negotiate scheme"); - } - } - - [Test] - public void Passes_Default_Credentials_When_UseDefaultCredentials_Is_True() - { - const Method httpMethod = Method.GET; - - using (SimpleServer.Create(BASE_URL, Handlers.Generic(), AuthenticationSchemes.Negotiate)) - { - RestClient client = new RestClient(BASE_URL); - RestRequest request = new RestRequest(RequestHeadCapturer.RESOURCE, httpMethod) - { - UseDefaultCredentials = true - }; - IRestResponse response = client.Execute(request); - - Assert.AreEqual(HttpStatusCode.OK, response.StatusCode); - Assert.NotNull(RequestHeadCapturer.CapturedHeaders); - - string[] keys = RequestHeadCapturer.CapturedHeaders.Keys.Cast() - .ToArray(); - - Assert.True(keys.Contains("Authorization"), - "Authorization header not present in HTTP request from client, even though UseDefaultCredentials = true"); - } - } - - [Test] -#if NETCORE - [Ignore("Not supported for .NET Core")] -#endif - public void Does_Not_Pass_Default_Credentials_When_UseDefaultCredentials_Is_False() - { - const Method httpMethod = Method.GET; - - using (SimpleServer.Create(BASE_URL, Handlers.Generic(), AuthenticationSchemes.Negotiate)) - { - RestClient client = new RestClient(BASE_URL); - RestRequest request = new RestRequest(RequestHeadCapturer.RESOURCE, httpMethod) - { - // UseDefaultCredentials is currently false by default, - // but to make the test more robust in case that ever - // changes, it's better to explicitly set it here. - UseDefaultCredentials = false - }; - IRestResponse response = client.Execute(request); - - Assert.AreEqual(HttpStatusCode.Unauthorized, response.StatusCode); - Assert.Null(RequestHeadCapturer.CapturedHeaders); - } - } - - private class RequestHeadCapturer - { - public const string RESOURCE = "Capture"; - - public static NameValueCollection CapturedHeaders { get; set; } - - public static void Initialize() - { - CapturedHeaders = null; - } - - public static void Capture(HttpListenerContext context) - { - HttpListenerRequest request = context.Request; - - CapturedHeaders = request.Headers; - } - } - } -} diff --git a/RestSharp.IntegrationTests/RestSharp.IntegrationTests.csproj b/RestSharp.IntegrationTests/RestSharp.IntegrationTests.csproj deleted file mode 100644 index 32f74dbb0..000000000 --- a/RestSharp.IntegrationTests/RestSharp.IntegrationTests.csproj +++ /dev/null @@ -1,33 +0,0 @@ - - - net452;netcoreapp2.0 - false - ..\RestSharp.snk - true - - - 0 - - - NETCORE - - - - - - - - - - - - PreserveNewest - - - PreserveNewest - - - - - - \ No newline at end of file diff --git a/RestSharp.IntegrationTests/StatusCodeTests.cs b/RestSharp.IntegrationTests/StatusCodeTests.cs deleted file mode 100644 index a1eaa9795..000000000 --- a/RestSharp.IntegrationTests/StatusCodeTests.cs +++ /dev/null @@ -1,190 +0,0 @@ -using System; -using System.Linq; -using System.Net; -using NUnit.Framework; -using RestSharp.IntegrationTests.Helpers; - -namespace RestSharp.IntegrationTests -{ - [TestFixture] - public class StatusCodeTests - { - private readonly Uri _baseUrl = new Uri("http://localhost:8888/"); - private SimpleServer _server; - private RestClient _client; - - [SetUp] - public void SetupServer() - { - _server = SimpleServer.Create(_baseUrl.AbsoluteUri, UrlToStatusCodeHandler); - _client = new RestClient(_baseUrl); - } - - [TearDown] - public void ShutdownServer() => _server.Dispose(); - - [Test] - public void Handles_GET_Request_404_Error() - { - RestRequest request = new RestRequest("404"); - IRestResponse response = _client.Execute(request); - - Assert.AreEqual(HttpStatusCode.NotFound, response.StatusCode); - } - - [Test] - public void Handles_GET_Request_404_Error_With_Body() - { - RestRequest request = new RestRequest("404"); - - request.AddBody("This is the body"); - - IRestResponse response = _client.Execute(request); - - Assert.AreEqual(HttpStatusCode.NotFound, response.StatusCode); - } - - private static void UrlToStatusCodeHandler(HttpListenerContext obj) - { - obj.Response.StatusCode = int.Parse(obj.Request.Url.Segments.Last()); - } - - [Test] - public void Handles_Different_Root_Element_On_Http_Error() - { - _server.SetHandler(Handlers.Generic()); - RestRequest request = new RestRequest("error") - { - RootElement = "Success" - }; - - request.OnBeforeDeserialization = - resp => - { - if (resp.StatusCode == HttpStatusCode.BadRequest) - { - request.RootElement = "Error"; - } - }; - - IRestResponse response = _client.Execute(request); - - Assert.AreEqual(HttpStatusCode.BadRequest, response.StatusCode); - Assert.AreEqual("Not found!", response.Data.Message); - } - - [Test] - public void Handles_Default_Root_Element_On_No_Error() - { - _server.SetHandler(Handlers.Generic()); - RestRequest request = new RestRequest("success") - { - RootElement = "Success" - }; - - request.OnBeforeDeserialization = resp => - { - if (resp.StatusCode == HttpStatusCode.NotFound) - { - request.RootElement = "Error"; - } - }; - - IRestResponse response = _client.Execute(request); - - Assert.AreEqual(HttpStatusCode.OK, response.StatusCode); - Assert.AreEqual("Works!", response.Data.Message); - } - - [Test] - [Ignore("Not sure why this hangs")] - public void Reports_1xx_Status_Code_Success_Accurately() - { - RestRequest request = new RestRequest("100"); - IRestResponse response = _client.Execute(request); - - Assert.IsFalse(response.IsSuccessful); - } - - [Test] - public void Reports_2xx_Status_Code_Success_Accurately() - { - RestRequest request = new RestRequest("204"); - IRestResponse response = _client.Execute(request); - - Assert.IsTrue(response.IsSuccessful); - } - - [Test] - public void Reports_3xx_Status_Code_Success_Accurately() - { - RestRequest request = new RestRequest("301"); - IRestResponse response = _client.Execute(request); - - Assert.IsFalse(response.IsSuccessful); - } - - [Test] - public void Reports_4xx_Status_Code_Success_Accurately() - { - RestRequest request = new RestRequest("404"); - IRestResponse response = _client.Execute(request); - - Assert.IsFalse(response.IsSuccessful); - } - - [Test] - public void Reports_5xx_Status_Code_Success_Accurately() - { - RestRequest request = new RestRequest("503"); - IRestResponse response = _client.Execute(request); - - Assert.IsFalse(response.IsSuccessful); - } - } - - public class ResponseHandler - { - private void error(HttpListenerContext context) - { - context.Response.StatusCode = 400; - context.Response.Headers.Add("Content-Type", "application/xml"); - context.Response.OutputStream.WriteStringUtf8( - @" - - - Not found! - -"); - } - - private void errorwithbody(HttpListenerContext context) - { - context.Response.StatusCode = 400; - context.Response.Headers.Add("Content-Type", "application/xml"); - context.Response.OutputStream.WriteStringUtf8( - @" - - - Not found! - -"); - } - - private void success(HttpListenerContext context) - { - context.Response.OutputStream.WriteStringUtf8( - @" - - - Works! - -"); - } - } - - public class Response - { - public string Message { get; set; } - } -} \ No newline at end of file diff --git a/RestSharp.IntegrationTests/StructuredSyntaxSuffixTests.cs b/RestSharp.IntegrationTests/StructuredSyntaxSuffixTests.cs deleted file mode 100644 index 612bd943c..000000000 --- a/RestSharp.IntegrationTests/StructuredSyntaxSuffixTests.cs +++ /dev/null @@ -1,158 +0,0 @@ -using System; -using System.Net; -using NUnit.Framework; -using RestSharp.Deserializers; -using RestSharp.IntegrationTests.Helpers; - -namespace RestSharp.IntegrationTests -{ - [TestFixture] - public class StructuredSyntaxSuffixTests - { - private class Person - { - public string Name { get; set; } - - public int Age { get; set; } - } - - private const string XML_CONTENT = "Bob50"; - - private const string JSON_CONTENT = @"{ ""name"":""Bob"", ""age"":50 }"; - - private static void QueryStringBasedContentAndContentTypeHandler(HttpListenerContext obj) - { - obj.Response.ContentType = obj.Request.QueryString["ct"]; - obj.Response.OutputStream.WriteStringUtf8(obj.Request.QueryString["c"]); - obj.Response.StatusCode = 200; - } - - [Test] - public void By_default_content_types_with_JSON_structured_syntax_suffix_should_deserialize_as_JSON() - { - Uri baseUrl = new Uri("http://localhost:8080/"); - - using (SimpleServer.Create(baseUrl.AbsoluteUri, QueryStringBasedContentAndContentTypeHandler)) - { - RestClient client = new RestClient(baseUrl); - RestRequest request = new RestRequest(); - - request.AddParameter("ct", "application/vnd.somebody.something+json"); - request.AddParameter("c", JSON_CONTENT); - - IRestResponse response = client.Execute(request); - - Assert.AreEqual("Bob", response.Data.Name); - Assert.AreEqual(50, response.Data.Age); - } - } - - [Test] - public void By_default_content_types_with_XML_structured_syntax_suffix_should_deserialize_as_XML() - { - Uri baseUrl = new Uri("http://localhost:8080/"); - - using (SimpleServer.Create(baseUrl.AbsoluteUri, QueryStringBasedContentAndContentTypeHandler)) - { - RestClient client = new RestClient(baseUrl); - RestRequest request = new RestRequest(); - - request.AddParameter("ct", "application/vnd.somebody.something+xml"); - request.AddParameter("c", XML_CONTENT); - - IRestResponse response = client.Execute(request); - - Assert.AreEqual("Bob", response.Data.Name); - Assert.AreEqual(50, response.Data.Age); - } - } - - [Test] - public void Content_type_that_matches_the_structured_syntax_suffix_format_but_was_given_an_explicit_handler_should_use_supplied_deserializer() - { - Uri baseUrl = new Uri("http://localhost:8080/"); - - using (SimpleServer.Create(baseUrl.AbsoluteUri, QueryStringBasedContentAndContentTypeHandler)) - { - RestClient client = new RestClient(baseUrl); - - // In spite of the content type (+xml), treat this specific content type as JSON - client.AddHandler("application/vnd.somebody.something+xml", new JsonDeserializer()); - - RestRequest request = new RestRequest(); - - request.AddParameter("ct", "application/vnd.somebody.something+xml"); - request.AddParameter("c", JSON_CONTENT); - - IRestResponse response = client.Execute(request); - - Assert.AreEqual("Bob", response.Data.Name); - Assert.AreEqual(50, response.Data.Age); - } - } - - [Test] - public void Should_allow_wildcard_content_types_to_be_defined() - { - Uri baseUrl = new Uri("http://localhost:8080/"); - - using (SimpleServer.Create(baseUrl.AbsoluteUri, QueryStringBasedContentAndContentTypeHandler)) - { - RestClient client = new RestClient(baseUrl); - - // In spite of the content type, handle ALL structured syntax suffixes of "+xml" as JSON - client.AddHandler("*+xml", new JsonDeserializer()); - - RestRequest request = new RestRequest(); - - request.AddParameter("ct", "application/vnd.somebody.something+xml"); - request.AddParameter("c", JSON_CONTENT); - - IRestResponse response = client.Execute(request); - - Assert.AreEqual("Bob", response.Data.Name); - Assert.AreEqual(50, response.Data.Age); - } - } - - [Test] - public void By_default_application_json_content_type_should_deserialize_as_JSON() - { - Uri baseUrl = new Uri("http://localhost:8080/"); - - using (SimpleServer.Create(baseUrl.AbsoluteUri, QueryStringBasedContentAndContentTypeHandler)) - { - RestClient client = new RestClient(baseUrl); - RestRequest request = new RestRequest(); - - request.AddParameter("ct", "application/json"); - request.AddParameter("c", JSON_CONTENT); - - IRestResponse response = client.Execute(request); - - Assert.AreEqual("Bob", response.Data.Name); - Assert.AreEqual(50, response.Data.Age); - } - } - - [Test] - public void By_default_text_xml_content_type_should_deserialize_as_XML() - { - Uri baseUrl = new Uri("http://localhost:8080/"); - - using (SimpleServer.Create(baseUrl.AbsoluteUri, QueryStringBasedContentAndContentTypeHandler)) - { - RestClient client = new RestClient(baseUrl); - RestRequest request = new RestRequest(); - - request.AddParameter("ct", "text/xml"); - request.AddParameter("c", XML_CONTENT); - - IRestResponse response = client.Execute(request); - - Assert.AreEqual("Bob", response.Data.Name); - Assert.AreEqual(50, response.Data.Age); - } - } - } -} diff --git a/RestSharp.IntegrationTests/config.example.json b/RestSharp.IntegrationTests/config.example.json deleted file mode 100644 index 3e55aa186..000000000 --- a/RestSharp.IntegrationTests/config.example.json +++ /dev/null @@ -1,6 +0,0 @@ -{ - "ConsumerKey": "", - "ConsumerSecret": "", - "AccessToken": "", - "AccessSecret": "" -} diff --git a/RestSharp.IntegrationTests/oAuth1Tests.cs b/RestSharp.IntegrationTests/oAuth1Tests.cs deleted file mode 100644 index 76e79852e..000000000 --- a/RestSharp.IntegrationTests/oAuth1Tests.cs +++ /dev/null @@ -1,394 +0,0 @@ -using System; -using System.Collections.Generic; -using System.Diagnostics; -using System.IO; -using System.Linq; -using System.Net; -using System.Web; -using System.Xml.Serialization; -using NUnit.Framework; -using RestSharp.Authenticators; -using RestSharp.Authenticators.OAuth; -using RestSharp.IntegrationTests.Models; -using SimpleJson; - -namespace RestSharp.IntegrationTests -{ - [TestFixture] - public class OAuth1Tests - { - [XmlRoot("queue")] - private class Queue - { - [XmlElement("etag")] - public string Etag { get; set; } - - public List Items { get; set; } - } - - [XmlRoot("queue_item")] - private class QueueItem - { - [XmlElement("id")] - public string Id { get; set; } - - [XmlElement("position")] - public int Position { get; set; } - } - - //[Test] - public void Can_Authenticate_Netflix_With_OAuth() - { - const string consumerKey = ""; - const string consumerSecret = ""; - - var baseUrl = new Uri("http://api.netflix.com"); - var client = new RestClient(baseUrl) - { - Authenticator = OAuth1Authenticator.ForRequestToken(consumerKey, consumerSecret) - }; - var request = new RestRequest("oauth/request_token"); - var response = client.Execute(request); - - Assert.NotNull(response); - Assert.AreEqual(HttpStatusCode.OK, response.StatusCode); - - var qs = HttpUtility.ParseQueryString(response.Content); - var oauthToken = qs["oauth_token"]; - var oauthTokenSecret = qs["oauth_token_secret"]; - var applicationName = qs["application_name"]; - - Assert.NotNull(oauthToken); - Assert.NotNull(oauthTokenSecret); - Assert.NotNull(applicationName); - - var baseSslUrl = new Uri("https://api-user.netflix.com"); - var sslClient = new RestClient(baseSslUrl); - - request = new RestRequest("oauth/login"); - request.AddParameter("oauth_token", oauthToken); - request.AddParameter("oauth_consumer_key", consumerKey); - request.AddParameter("application_name", applicationName); - - var url = sslClient.BuildUri(request) - .ToString(); - - Process.Start(url); - - request = new RestRequest("oauth/access_token"); // <-- Breakpoint here, login to netflix - client.Authenticator = OAuth1Authenticator.ForAccessToken(consumerKey, consumerSecret, oauthToken, - oauthTokenSecret); - response = client.Execute(request); - - Assert.NotNull(response); - Assert.AreEqual(HttpStatusCode.OK, response.StatusCode); - - qs = HttpUtility.ParseQueryString(response.Content); - oauthToken = qs["oauth_token"]; - oauthTokenSecret = qs["oauth_token_secret"]; - - var userId = qs["user_id"]; - - Assert.NotNull(oauthToken); - Assert.NotNull(oauthTokenSecret); - Assert.NotNull(userId); - - client.Authenticator = OAuth1Authenticator.ForProtectedResource(consumerKey, consumerSecret, oauthToken, - oauthTokenSecret); - request = new RestRequest("users/{user_id}/queues/disc"); - request.AddUrlSegment("user_id", userId); - request.AddParameter("max_results", "2"); - - var queueResponse = client.Execute(request); - - Assert.NotNull(queueResponse); - Assert.AreEqual(HttpStatusCode.OK, queueResponse.StatusCode); - Assert.NotNull(queueResponse.Data); - Assert.AreEqual(2, queueResponse.Data.Items.Count); - } - - [Test] - [Ignore("Provide your own consumer key/secret before running")] - public void Can_Authenticate_LinkedIN_With_OAuth() - { - const string consumerKey = "TODO_CONSUMER_KEY_HERE"; - const string consumerSecret = "TODO_CONSUMER_SECRET_HERE"; - - // request token - var client = new RestClient - { - BaseUrl = new Uri("https://api.linkedin.com/uas/oauth"), - Authenticator = OAuth1Authenticator.ForRequestToken(consumerKey, consumerSecret, - "http://localhost") - }; - var requestTokenRequest = new RestRequest("requestToken"); - var requestTokenResponse = client.Execute(requestTokenRequest); - - Assert.NotNull(requestTokenResponse); - Assert.AreEqual(HttpStatusCode.OK, requestTokenResponse.StatusCode); - - var requestTokenResponseParameters = HttpUtility.ParseQueryString(requestTokenResponse.Content); - var requestToken = requestTokenResponseParameters["oauth_token"]; - var requestSecret = requestTokenResponseParameters["oauth_token_secret"]; - - Assert.NotNull(requestToken); - Assert.NotNull(requestSecret); - - // redirect user - requestTokenRequest = new RestRequest("authenticate?oauth_token=" + requestToken); - - var redirectUri = client.BuildUri(requestTokenRequest); - - Process.Start(redirectUri.ToString()); - - const string requestUrl = "TODO: put browser URL here"; - // replace this via the debugger with the return url from LinkedIN. Simply copy it from the opened browser - - if (!Debugger.IsAttached) - Debugger.Launch(); - - Debugger.Break(); - - // get the access token - var requestTokenQueryParameters = HttpUtility.ParseQueryString(new Uri(requestUrl).Query); - var requestVerifier = requestTokenQueryParameters["oauth_verifier"]; - - client.Authenticator = OAuth1Authenticator.ForAccessToken( - consumerKey, consumerSecret, requestToken, requestSecret, requestVerifier); - - var requestAccessTokenRequest = new RestRequest("accessToken"); - var requestActionTokenResponse = client.Execute(requestAccessTokenRequest); - - Assert.NotNull(requestActionTokenResponse); - Assert.AreEqual(HttpStatusCode.OK, requestActionTokenResponse.StatusCode); - - var requestActionTokenResponseParameters = HttpUtility.ParseQueryString(requestActionTokenResponse.Content); - var accessToken = requestActionTokenResponseParameters["oauth_token"]; - var accessSecret = requestActionTokenResponseParameters["oauth_token_secret"]; - - Assert.NotNull(accessToken); - Assert.NotNull(accessSecret); - } - - [Test] - public void Can_Authenticate_OAuth1_With_Querystring_Parameters() - { - const string consumerKey = "enterConsumerKeyHere"; - const string consumerSecret = "enterConsumerSecretHere"; - const string baseUrl = "http://restsharp.org"; - var expected = new List - { - "oauth_consumer_key", - "oauth_nonce", - "oauth_signature_method", - "oauth_timestamp", - "oauth_version", - "oauth_signature" - }; - - var client = new RestClient(baseUrl); - var request = new RestRequest(Method.GET); - var authenticator = OAuth1Authenticator.ForRequestToken(consumerKey, consumerSecret); - authenticator.ParameterHandling = OAuthParameterHandling.UrlOrPostParameters; - authenticator.Authenticate(client, request); - - var requestUri = client.BuildUri(request); - var actual = HttpUtility.ParseQueryString(requestUri.Query).AllKeys.ToList(); - - Assert.IsTrue(actual.SequenceEqual(expected)); - } - - [Test] - [Ignore("Provide your own consumer key/secret before running")] - public void Can_Authenticate_Twitter() - { - // To pass this test, place a file config.json in the RestSharp.IntegrationTests folder - // with the following content: - // - // { - // "ConsumerKey": "", - // "ConsumerSecret": "", - // "AccessToken": "", - // "AccessSecret": "" - // } - // - // The tokens can be found on the "Keys and Access Tokens" tab on the application - // management page for your app: https://apps.twitter.com/ - - Assert.True(File.Exists(@"..\..\config.json")); - - if (!(SimpleJson.SimpleJson.DeserializeObject(File.ReadAllText(@"..\..\config.json")) is JsonObject config) - ) return; - var client = new RestClient("https://api.twitter.com/1.1") - { - Authenticator = OAuth1Authenticator.ForProtectedResource( - (string) config["ConsumerKey"], - (string) config["ConsumerSecret"], - (string) config["AccessToken"], - (string) config["AccessSecret"]) - }; - - var request = new RestRequest("account/verify_credentials.json"); - - request.AddParameter("include_entities", "true", ParameterType.QueryString); - - var response = client.Execute(request); - - Assert.NotNull(response); - Assert.AreEqual(HttpStatusCode.OK, response.StatusCode); - } - - [Test] - [Ignore("Provide your own consumer key/secret before running")] - public void Can_Authenticate_With_OAuth() - { - const string consumerKey = ""; - const string consumerSecret = ""; - - var baseUrl = new Uri("https://api.twitter.com"); - var client = new RestClient(baseUrl) - { - Authenticator = OAuth1Authenticator.ForRequestToken(consumerKey, consumerSecret) - }; - var request = new RestRequest("oauth/request_token", Method.POST); - var response = client.Execute(request); - - Assert.NotNull(response); - Assert.AreEqual(HttpStatusCode.OK, response.StatusCode); - - var qs = HttpUtility.ParseQueryString(response.Content); - var oauthToken = qs["oauth_token"]; - var oauthTokenSecret = qs["oauth_token_secret"]; - - Assert.NotNull(oauthToken); - Assert.NotNull(oauthTokenSecret); - - request = new RestRequest("oauth/authorize"); - request.AddParameter("oauth_token", oauthToken); - - var url = client.BuildUri(request) - .ToString(); - - Process.Start(url); - - const string verifier = "123456"; // <-- Breakpoint here (set verifier in debugger) - - request = new RestRequest("oauth/access_token", Method.POST); - client.Authenticator = OAuth1Authenticator.ForAccessToken(consumerKey, consumerSecret, oauthToken, - oauthTokenSecret, verifier); - response = client.Execute(request); - - Assert.NotNull(response); - Assert.AreEqual(HttpStatusCode.OK, response.StatusCode); - - qs = HttpUtility.ParseQueryString(response.Content); - oauthToken = qs["oauth_token"]; - oauthTokenSecret = qs["oauth_token_secret"]; - - Assert.NotNull(oauthToken); - Assert.NotNull(oauthTokenSecret); - - request = new RestRequest("account/verify_credentials.xml"); - client.Authenticator = OAuth1Authenticator.ForProtectedResource(consumerKey, consumerSecret, oauthToken, - oauthTokenSecret); - - response = client.Execute(request); - - Assert.NotNull(response); - Assert.AreEqual(HttpStatusCode.OK, response.StatusCode); - } - - [Test] - [Ignore("Provide your own consumer key/secret before running")] - public void Can_Query_Vimeo() - { - const string consumerKey = "TODO_CONSUMER_KEY_HERE"; - const string consumerSecret = "TODO_CONSUMER_SECRET_HERE"; - - // arrange - var client = new RestClient - { - BaseUrl = new Uri("http://vimeo.com/api/rest/v2"), - Authenticator = OAuth1Authenticator.ForRequestToken(consumerKey, consumerSecret) - }; - var request = new RestRequest(); - - request.AddParameter("format", "json"); - request.AddParameter("method", "vimeo.videos.search"); - request.AddParameter("query", "weather"); - request.AddParameter("full_response", 1); - - // act - var response = client.Execute(request); - - // assert - Assert.NotNull(response); - Assert.AreEqual(HttpStatusCode.OK, response.StatusCode); - Assert.NotNull(response.Content); - Assert.False(response.Content.Contains("\"stat\":\"fail\"")); - Assert.True(response.Content.Contains("\"stat\":\"ok\"")); - } - - [Test] - [Ignore( - "Provide your own consumer key/secret/accessToken/accessSecret before running. You can retrieve the access token/secret by running the LinkedIN oAuth test")] - public void Can_Retrieve_Member_Profile_Field_Field_Selector_From_LinkedIN() - { - const string consumerKey = "TODO_CONSUMER_KEY_HERE"; - const string consumerSecret = "TODO_CONSUMER_SECRET_HERE"; - const string accessToken = "TODO_ACCES_TOKEN_HERE"; - const string accessSecret = "TODO_ACCES_SECRET_HERE"; - - // arrange - var client = new RestClient - { - BaseUrl = new Uri("http://api.linkedin.com/v1"), - Authenticator = OAuth1Authenticator.ForProtectedResource(consumerKey, - consumerSecret, accessToken, accessSecret) - }; - var request = new RestRequest("people/~:(id,first-name,last-name)"); - - // act - var response = client.Execute(request); - - // assert - Assert.NotNull(response); - Assert.AreEqual(HttpStatusCode.OK, response.StatusCode); - Assert.NotNull(response.Data); - Assert.NotNull(response.Data.Id); - Assert.NotNull(response.Data.FirstName); - Assert.NotNull(response.Data.LastName); - } - - [Test] - public void Properly_Encodes_Parameter_Names() - { - var postData = new WebParameterCollection - { - {"name[first]", "Chuck"}, - {"name[last]", "Testa"} - }; - var sortedParams = OAuthTools.SortParametersExcludingSignature(postData); - - Assert.AreEqual("name%5Bfirst%5D", sortedParams[0].Name); - } - - [Test] - public void Use_RFC_3986_Encoding_For_Auth_Signature_Base() - { - // reserved characters for 2396 and 3986 - // http://www.ietf.org/rfc/rfc2396.txt - string[] reserved2396Characters = {";", "/", "?", ":", "@", "&", "=", "+", "$", ","}; - // http://www.ietf.org/rfc/rfc3986.txt - string[] additionalReserved3986Characters = {"!", "*", "'", "(", ")"}; - var reservedCharacterString = string.Join(string.Empty, - reserved2396Characters.Union(additionalReserved3986Characters)); - - // act - var escapedString = OAuthTools.UrlEncodeRelaxed(reservedCharacterString); - - // assert - Assert.AreEqual("%3B%2F%3F%3A%40%26%3D%2B%24%2C%21%2A%27%28%29", escapedString); - } - } -} \ No newline at end of file diff --git a/RestSharp.Tests/AddRangeTests.cs b/RestSharp.Tests/AddRangeTests.cs deleted file mode 100644 index bdacef83a..000000000 --- a/RestSharp.Tests/AddRangeTests.cs +++ /dev/null @@ -1,30 +0,0 @@ -using NUnit.Framework; - -namespace RestSharp.Tests -{ - [TestFixture] - public class AddRangeTests - { - [Test] - public void ShouldParseOutRangeSpecifier() - { - var restClient = new RestClient("http://localhost"); - var req = new RestRequest("bob", Method.GET); - - req.AddHeader("Range", "pages=1-2"); - restClient.Execute(req); - } - - [Test] - public void ShouldParseOutLongRangeSpecifier() - { - var restClient = new RestClient("http://localhost"); - var req = new RestRequest("bob", Method.GET); - const long start = (long)int.MaxValue + 1; - const long end = start + 1; - - req.AddHeader("Range", $"pages={start}-{end}"); - restClient.Execute(req); - } - } -} diff --git a/RestSharp.Tests/CultureChange.cs b/RestSharp.Tests/CultureChange.cs deleted file mode 100644 index ac76123de..000000000 --- a/RestSharp.Tests/CultureChange.cs +++ /dev/null @@ -1,33 +0,0 @@ -using System; -using System.Globalization; -using System.Threading; - -namespace RestSharp.Tests -{ - public class CultureChange : IDisposable - { - public CultureInfo PreviousCulture { get; private set; } - - public CultureChange(string culture) - { - if (culture == null) - { - throw new ArgumentNullException("culture"); - } - - this.PreviousCulture = Thread.CurrentThread.CurrentCulture; - - Thread.CurrentThread.CurrentCulture = new CultureInfo(culture); - } - - public void Dispose() - { - if (this.PreviousCulture != null) - { - Thread.CurrentThread.CurrentCulture = this.PreviousCulture; - - this.PreviousCulture = null; - } - } - } -} diff --git a/RestSharp.Tests/Fakes/NullHttp.cs b/RestSharp.Tests/Fakes/NullHttp.cs deleted file mode 100644 index 5c0ccbfb6..000000000 --- a/RestSharp.Tests/Fakes/NullHttp.cs +++ /dev/null @@ -1,10 +0,0 @@ -namespace RestSharp.Tests.Fakes -{ - public class NullHttp : Http - { - public new HttpResponse Get() - { - return new HttpResponse(); - } - } -} diff --git a/RestSharp.Tests/InterfaceImplementationTests.cs b/RestSharp.Tests/InterfaceImplementationTests.cs deleted file mode 100644 index 8a9491cd9..000000000 --- a/RestSharp.Tests/InterfaceImplementationTests.cs +++ /dev/null @@ -1,40 +0,0 @@ -using System; -using System.Collections.Generic; -using System.Linq; -using System.Reflection; -using NUnit.Framework; - -namespace RestSharp.Tests -{ - [TestFixture] - public class InterfaceImplementationTests - { - [Test] - public void IRestSharp_Has_All_RestSharp_Signatures() - { - // Arrange - Type restClientImplementationType = typeof(RestClient); - Type restClientInterfaceType = typeof(IRestClient); - const BindingFlags bindingFlags = BindingFlags.Public | BindingFlags.Instance | BindingFlags.DeclaredOnly; - - // Act - List compareResult = CompareTypes(restClientImplementationType, restClientInterfaceType, - bindingFlags).ToList(); - - compareResult.ForEach(x => Console.WriteLine("Method {0} exists in {1} but not in {2}", x, - restClientImplementationType.FullName, restClientInterfaceType.FullName)); - - // Assert - Assert.AreEqual(0, compareResult.Count()); - } - - private static IEnumerable CompareTypes(IReflect type1, IReflect type2, BindingFlags bindingFlags) - { - MethodInfo[] typeTMethodInfo = type1.GetMethods(bindingFlags); - MethodInfo[] typeXMethodInfo = type2.GetMethods(bindingFlags); - - return typeTMethodInfo.Select(x => x.Name) - .Except(typeXMethodInfo.Select(x => x.Name)); - } - } -} diff --git a/RestSharp.Tests/JsonTests.cs b/RestSharp.Tests/JsonTests.cs deleted file mode 100644 index 64ab2efc3..000000000 --- a/RestSharp.Tests/JsonTests.cs +++ /dev/null @@ -1,1090 +0,0 @@ -#region License - -// Copyright 2010 John Sheehan -// -// Licensed under the Apache License, Version 2.0 (the "License"); -// you may not use this file except in compliance with the License. -// You may obtain a copy of the License at -// -// http://www.apache.org/licenses/LICENSE-2.0 -// -// Unless required by applicable law or agreed to in writing, software -// distributed under the License is distributed on an "AS IS" BASIS, -// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -// See the License for the specific language governing permissions and -// limitations under the License. - -#endregion - -using System; -using System.Collections; -using System.Collections.Generic; -using System.Globalization; -using System.IO; -using System.Linq; -using NUnit.Framework; -using RestSharp.Deserializers; -using RestSharp.Tests.SampleClasses; - -namespace RestSharp.Tests -{ - [TestFixture] - public class JsonTests - { - private const string ALTERNATIVE_CULTURE = "pt-PT"; - - private const string GUID_STRING = "AC1FC4BC-087A-4242-B8EE-C53EBE9887A5"; - - private static string currentPath = AppDomain.CurrentDomain.BaseDirectory; - - [Test] - public void Can_Deserialize_Exponential_Notation() - { - const string content = "{ \"Value\": 4.8e-04 }"; - JsonDeserializer json = new JsonDeserializer(); - DecimalNumber output = json.Deserialize(new RestResponse { Content = content }); - decimal expected = decimal.Parse("4.8e-04", NumberStyles.Float, CultureInfo.InvariantCulture); - - Assert.NotNull(output); - Assert.AreEqual(expected, output.Value); - } - - [Test] - public void Can_Deserialize_Into_Struct() - { - const string content = "{\"one\":\"oneOneOne\", \"two\":\"twoTwoTwo\", \"three\":3}"; - JsonDeserializer json = new JsonDeserializer(); - SimpleStruct output = json.Deserialize(new RestResponse { Content = content }); - - Assert.NotNull(output); - Assert.AreEqual("oneOneOne", output.One); - Assert.AreEqual("twoTwoTwo", output.Two); - Assert.AreEqual(3, output.Three); - } - - [Test] - public void Can_Deserialize_Select_Tokens() - { - string data = File.ReadAllText(Path.Combine(currentPath, "SampleData", "jsonarray.txt")); - RestResponse response = new RestResponse { Content = data }; - JsonDeserializer json = new JsonDeserializer(); - StatusComplexList output = json.Deserialize(response); - - Assert.AreEqual(4, output.Count); - } - - [Test] - public void Can_Deserialize_Dot_Field() - { - string data = File.ReadAllText(Path.Combine(currentPath, "SampleData", "bearertoken.txt")); - RestResponse response = new RestResponse { Content = data }; - JsonDeserializer json = new JsonDeserializer(); - BearerToken output = json.Deserialize(response); - DateTimeOffset expectedIssued = DateTimeOffset.ParseExact("Mon, 14 Oct 2013 06:53:32 GMT", "r", CultureInfo.InvariantCulture); - DateTimeOffset expectedExpires = DateTimeOffset.ParseExact("Mon, 28 Oct 2013 06:53:32 GMT", "r", CultureInfo.InvariantCulture); - - Assert.AreEqual("boQtj0SCGz2GFGz[...]", output.AccessToken); - Assert.AreEqual("bearer", output.TokenType); - Assert.AreEqual(1209599L, output.ExpiresIn); - Assert.AreEqual("Alice", output.UserName); - Assert.AreEqual(expectedIssued, output.Issued); - Assert.AreEqual(expectedExpires, output.Expires); - } - - [Test] - public void Can_Deserialize_4sq_Json_With_Root_Element_Specified() - { - string doc = File.ReadAllText(Path.Combine(currentPath, "SampleData", "4sq.txt")); - JsonDeserializer json = new JsonDeserializer { RootElement = "response" }; - VenuesResponse output = json.Deserialize(new RestResponse { Content = doc }); - - Assert.IsNotEmpty(output.Groups); - } - - [Test] - public void Can_Deserialize_IEnumerable_of_Simple_Types() - { - const string content = "{\"numbers\":[1,2,3,4,5]}"; - JsonDeserializer json = new JsonDeserializer { RootElement = "numbers" }; - var output = json.Deserialize>(new RestResponse { Content = content }); - - Assert.IsNotEmpty(output); - Assert.IsTrue(output.Count() == 5); - } - - [Test] - public void Can_Deserialize_Lists_of_Simple_Types() - { - string doc = File.ReadAllText(Path.Combine(currentPath, "SampleData", "jsonlists.txt")); - JsonDeserializer json = new JsonDeserializer(); - JsonLists output = json.Deserialize(new RestResponse { Content = doc }); - - Assert.IsNotEmpty(output.Names); - Assert.IsNotEmpty(output.Numbers); - } - - [Test] - public void Can_Deserialize_Simple_Generic_List_of_Simple_Types() - { - const string content = "{\"users\":[\"johnsheehan\",\"jagregory\",\"drusellers\",\"structuremap\"]}"; - JsonDeserializer json = new JsonDeserializer { RootElement = "users" }; - List output = json.Deserialize>(new RestResponse { Content = content }); - - Assert.IsNotEmpty(output); - } - - [Test] - public void Can_Deserialize_Simple_Generic_List_of_Simple_Types_With_Nulls() - { - const string content = "{\"users\":[\"johnsheehan\",\"jagregory\",null,\"drusellers\",\"structuremap\"]}"; - JsonDeserializer json = new JsonDeserializer { RootElement = "users" }; - List output = json.Deserialize>(new RestResponse { Content = content }); - - Assert.IsNotEmpty(output); - Assert.AreEqual(null, output[2]); - Assert.AreEqual(5, output.Count); - } - - [Test] - public void Can_Deserialize_Simple_Generic_List_Given_Item_Without_Array() - { - const string content = "{\"users\":\"johnsheehan\"}"; - JsonDeserializer json = new JsonDeserializer { RootElement = "users" }; - List output = json.Deserialize>(new RestResponse { Content = content }); - - Assert.True(output.SequenceEqual(new[] { "johnsheehan" })); - } - - [Test] - public void Can_Deserialize_Simple_Generic_List_Given_Toplevel_Item_Without_Array() - { - const string content = "\"johnsheehan\""; - JsonDeserializer json = new JsonDeserializer(); - List output = json.Deserialize>(new RestResponse { Content = content }); - - Assert.True(output.SequenceEqual(new[] { "johnsheehan" })); - } - - [Test] - public void Can_Deserialize_From_Root_Element() - { - string doc = File.ReadAllText(Path.Combine(currentPath, "SampleData", "sojson.txt")); - JsonDeserializer json = new JsonDeserializer { RootElement = "User" }; - SoUser output = json.Deserialize(new RestResponse { Content = doc }); - - Assert.AreEqual("John Sheehan", output.DisplayName); - } - - [Test] - public void Can_Deserialize_To_Dictionary_String_Object() - { - string doc = File.ReadAllText(Path.Combine(currentPath, "SampleData", "jsondictionary.txt")); - JsonDeserializer json = new JsonDeserializer(); - Dictionary output = - json.Deserialize>(new RestResponse { Content = doc }); - - Assert.AreEqual(output.Keys.Count, 3); - - object firstKeysVal = output.FirstOrDefault().Value; - - Assert.IsInstanceOf(firstKeysVal); - } - - [Test] - public void Can_Deserialize_To_Dictionary_Int_Object() - { - string doc = File.ReadAllText(Path.Combine(currentPath, "SampleData", "jsondictionary_KeysType.txt")); - JsonDeserializer json = new JsonDeserializer(); - Dictionary output = - json.Deserialize>(new RestResponse { Content = doc }); - - Assert.AreEqual(output.Keys.Count, 2); - - object firstKeysVal = output.FirstOrDefault().Value; - - Assert.IsInstanceOf(firstKeysVal); - } - - [Test] - public void Can_Deserialize_Generic_Members() - { - string doc = File.ReadAllText(Path.Combine(currentPath, "SampleData", "GenericWithList.txt")); - JsonDeserializer json = new JsonDeserializer(); - Generic> output = - json.Deserialize>>(new RestResponse { Content = doc }); - - Assert.AreEqual("Foe sho", output.Data.Items[0].Nickname); - } - - [Test] - public void Can_Deserialize_List_of_Guid() - { - Guid id1 = new Guid("b0e5c11f-e944-478c-aadd-753b956d0c8c"); - Guid id2 = new Guid("809399fa-21c4-4dca-8dcd-34cb697fbca0"); - JsonObject data = new JsonObject(); - - data["Ids"] = new JsonArray { id1, id2 }; - - JsonDeserializer d = new JsonDeserializer(); - RestResponse response = new RestResponse { Content = data.ToString() }; - GuidList p = d.Deserialize(response); - - Assert.AreEqual(2, p.Ids.Count); - Assert.AreEqual(id1, p.Ids[0]); - Assert.AreEqual(id2, p.Ids[1]); - } - - [Test] - public void Can_Deserialize_Generic_List_of_DateTime() - { - DateTime item1 = new DateTime(2010, 2, 8, 11, 11, 11); - DateTime item2 = item1.AddSeconds(12345); - JsonObject data = new JsonObject(); - - data["Items"] = new JsonArray - { - item1.ToString("u"), - item2.ToString("u") - }; - - JsonDeserializer d = new JsonDeserializer(); - RestResponse response = new RestResponse { Content = data.ToString() }; - GenericWithList p = d.Deserialize>(response); - - Assert.AreEqual(2, p.Items.Count); - Assert.AreEqual(item1, p.Items[0]); - Assert.AreEqual(item2, p.Items[1]); - } - - [Test] - public void Can_Deserialize_DateTime_With_DateTimeStyles() - { - DateTime item0 = new DateTime(2010, 2, 8, 11, 11, 11, DateTimeKind.Local); - DateTime item1 = new DateTime(2011, 2, 8, 11, 11, 11, DateTimeKind.Utc); - DateTime item2 = new DateTime(2012, 2, 8, 11, 11, 11, DateTimeKind.Unspecified); - JsonObject data = new JsonObject(); - - data["Items"] = new JsonArray - { - item0, - item1, - item2, - "/Date(1309421746929+0000)/" - }; - - JsonDeserializer d = new JsonDeserializer(); - RestResponse response = new RestResponse { Content = data.ToString() }; - GenericWithList p = d.Deserialize>(response); - - Assert.AreNotEqual(item0.Kind, p.Items[0].Kind); - Assert.AreEqual(item1.Kind, p.Items[1].Kind); - Assert.AreEqual(DateTimeKind.Utc, p.Items[2].Kind); - Assert.AreEqual(DateTimeKind.Utc, p.Items[3].Kind); - } - - [Test] - public void Can_Deserialize_Null_Elements_to_Nullable_Values() - { - string doc = CreateJsonWithNullValues(); - JsonDeserializer json = new JsonDeserializer(); - NullableValues output = json.Deserialize(new RestResponse { Content = doc }); - - Assert.Null(output.Id); - Assert.Null(output.StartDate); - Assert.Null(output.UniqueId); - } - - [Test] - public void Can_Deserialize_Empty_Elements_to_Nullable_Values() - { - string doc = CreateJsonWithEmptyValues(); - JsonDeserializer json = new JsonDeserializer(); - NullableValues output = json.Deserialize(new RestResponse { Content = doc }); - - Assert.Null(output.Id); - Assert.Null(output.StartDate); - Assert.Null(output.UniqueId); - } - - [Test] - public void Can_Deserialize_Elements_to_Nullable_Values() - { - string doc = CreateJsonWithoutEmptyValues(); - JsonDeserializer json = new JsonDeserializer(); - NullableValues output = json.Deserialize(new RestResponse { Content = doc }); - - Assert.NotNull(output.Id); - Assert.NotNull(output.StartDate); - Assert.NotNull(output.UniqueId); - - Assert.AreEqual(123, output.Id); - Assert.NotNull(output.StartDate); - Assert.AreEqual( - new DateTime(2010, 2, 21, 9, 35, 00, DateTimeKind.Utc), - output.StartDate.Value); - Assert.AreEqual(new Guid(GUID_STRING), output.UniqueId); - } - - [Test] - public void Can_Deserialize_Json_Using_DeserializeAs_Attribute() - { - const string content = "{\"sid\":\"asdasdasdasdasdasdasda\",\"friendlyName\":\"VeryNiceName\",\"oddballPropertyName\":\"blahblah\"}"; - JsonDeserializer json = new JsonDeserializer { RootElement = "users" }; - Oddball output = json.Deserialize(new RestResponse { Content = content }); - - Assert.NotNull(output); - Assert.AreEqual("blahblah", output.GoodPropertyName); - } - - [Test] - public void Can_Deserialize_Custom_Formatted_Date() - { - CultureInfo culture = CultureInfo.InvariantCulture; - const string format = "dd yyyy MMM, hh:mm ss tt"; - DateTime date = new DateTime(2010, 2, 8, 11, 11, 11); - var formatted = new { StartDate = date.ToString(format, culture) }; - string data = SimpleJson.SerializeObject(formatted); - RestResponse response = new RestResponse { Content = data }; - JsonDeserializer json = new JsonDeserializer - { - DateFormat = format, - Culture = culture - }; - PersonForJson output = json.Deserialize(response); - - Assert.AreEqual(date, output.StartDate); - } - - [Test] - public void Can_Deserialize_Root_Json_Array_To_List() - { - string data = File.ReadAllText(Path.Combine(currentPath, "SampleData", "jsonarray.txt")); - RestResponse response = new RestResponse { Content = data }; - JsonDeserializer json = new JsonDeserializer(); - List output = json.Deserialize>(response); - - Assert.AreEqual(4, output.Count); - } - - [Test] - public void Can_Deserialize_Root_Json_Array_To_Inherited_List() - { - string data = File.ReadAllText(Path.Combine(currentPath, "SampleData", "jsonarray.txt")); - RestResponse response = new RestResponse { Content = data }; - JsonDeserializer json = new JsonDeserializer(); - StatusList output = json.Deserialize(response); - - Assert.AreEqual(4, output.Count); - } - - [Test] - public void Can_Deserialize_Various_Enum_Values() - { - string data = File.ReadAllText(Path.Combine(currentPath, "SampleData", "jsonenums.txt")); - RestResponse response = new RestResponse { Content = data }; - JsonDeserializer json = new JsonDeserializer(); - JsonEnumsTestStructure output = json.Deserialize(response); - - Assert.AreEqual(Disposition.Friendly, output.Upper); - Assert.AreEqual(Disposition.Friendly, output.Lower); - Assert.AreEqual(Disposition.SoSo, output.CamelCased); - Assert.AreEqual(Disposition.SoSo, output.Underscores); - Assert.AreEqual(Disposition.SoSo, output.LowerUnderscores); - Assert.AreEqual(Disposition.SoSo, output.Dashes); - Assert.AreEqual(Disposition.SoSo, output.LowerDashes); - Assert.AreEqual(Disposition.SoSo, output.Integer); - } - - [Test] - public void Can_Deserialize_Various_Enum_Types() - { - string data = File.ReadAllText(Path.Combine(currentPath, "SampleData", "jsonenumtypes.txt")); - RestResponse response = new RestResponse { Content = data }; - JsonDeserializer json = new JsonDeserializer(); - JsonEnumTypesTestStructure output = json.Deserialize(response); - - Assert.AreEqual(ByteEnum.EnumMin, output.ByteEnumType); - Assert.AreEqual(SByteEnum.EnumMin, output.SByteEnumType); - Assert.AreEqual(ShortEnum.EnumMin, output.ShortEnumType); - Assert.AreEqual(UShortEnum.EnumMin, output.UShortEnumType); - Assert.AreEqual(IntEnum.EnumMin, output.IntEnumType); - Assert.AreEqual(UIntEnum.EnumMin, output.UIntEnumType); - Assert.AreEqual(LongEnum.EnumMin, output.LongEnumType); - Assert.AreEqual(ULongEnum.EnumMin, output.ULongEnumType); - } - - [Test] - public void Deserialization_Of_Undefined_Int_Value_Returns_Enum_Default() - { - const string data = @"{ ""Integer"" : 1024 }"; - RestResponse response = new RestResponse { Content = data }; - JsonDeserializer json = new JsonDeserializer(); - JsonEnumsTestStructure result = json.Deserialize(response); - - Assert.AreEqual(Disposition.Friendly, result.Integer); - } - - [Test] - public void Can_Deserialize_Guid_String_Fields() - { - JsonObject doc = new JsonObject(); - - doc["Guid"] = GUID_STRING; - - JsonDeserializer d = new JsonDeserializer(); - RestResponse response = new RestResponse { Content = doc.ToString() }; - PersonForJson p = d.Deserialize(response); - - Assert.AreEqual(new Guid(GUID_STRING), p.Guid); - } - - [Test] - public void Can_Deserialize_Quoted_Primitive() - { - JsonObject doc = new JsonObject(); - - doc["Age"] = "28"; - - JsonDeserializer d = new JsonDeserializer(); - RestResponse response = new RestResponse { Content = doc.ToString() }; - PersonForJson p = d.Deserialize(response); - - Assert.AreEqual(28, p.Age); - } - - [Test] - public void Can_Deserialize_Int_to_Bool() - { - JsonObject doc = new JsonObject(); - - doc["IsCool"] = 1; - - JsonDeserializer d = new JsonDeserializer(); - RestResponse response = new RestResponse { Content = doc.ToString() }; - PersonForJson p = d.Deserialize(response); - - Assert.True(p.IsCool); - } - - [Test] - public void Can_Deserialize_With_Default_Root() - { - string doc = CreateJson(); - JsonDeserializer d = new JsonDeserializer(); - RestResponse response = new RestResponse { Content = doc }; - PersonForJson p = d.Deserialize(response); - - Assert.AreEqual("John Sheehan", p.Name); - Assert.AreEqual(new DateTime(2009, 9, 25, 0, 6, 1, DateTimeKind.Utc), p.StartDate); - Assert.AreEqual(28, p.Age); - Assert.AreEqual(long.MaxValue, p.BigNumber); - Assert.AreEqual(99.9999m, p.Percent); - Assert.AreEqual(false, p.IsCool); - Assert.AreEqual(new Uri("http://example.com", UriKind.RelativeOrAbsolute), p.Url); - Assert.AreEqual(new Uri("/foo/bar", UriKind.RelativeOrAbsolute), p.UrlPath); - Assert.AreEqual(Guid.Empty, p.EmptyGuid); - Assert.AreEqual(new Guid(GUID_STRING), p.Guid); - Assert.AreEqual(Order.Third, p.Order); - Assert.AreEqual(Disposition.SoSo, p.Disposition); - Assert.NotNull(p.Friends); - Assert.AreEqual(10, p.Friends.Count); - Assert.NotNull(p.BestFriend); - Assert.AreEqual("The Fonz", p.BestFriend.Name); - Assert.AreEqual(1952, p.BestFriend.Since); - Assert.IsNotEmpty(p.Foes); - Assert.AreEqual("Foe 1", p.Foes["dict1"].Nickname); - Assert.AreEqual("Foe 2", p.Foes["dict2"].Nickname); - } - - [Test] - public void Can_Deserialize_With_Default_Root_Alternative_Culture() - { - using (new CultureChange(ALTERNATIVE_CULTURE)) - { - this.Can_Deserialize_With_Default_Root(); - } - } - - [Test] - public void Can_Deserialize_Names_With_Underscore_Prefix() - { - string data = File.ReadAllText(Path.Combine(currentPath, "SampleData", "underscore_prefix.txt")); - RestResponse response = new RestResponse { Content = data }; - JsonDeserializer json = new JsonDeserializer { RootElement = "User" }; - SoUser output = json.Deserialize(response); - - Assert.AreEqual("John Sheehan", output.DisplayName); - Assert.AreEqual(1786, output.Id); - } - - [Test] - public void Can_Deserialize_Names_With_Underscores_With_Default_Root() - { - string doc = CreateJsonWithUnderscores(); - JsonDeserializer d = new JsonDeserializer(); - RestResponse response = new RestResponse { Content = doc }; - PersonForJson p = d.Deserialize(response); - - Assert.AreEqual("John Sheehan", p.Name); - Assert.AreEqual(new DateTime(2009, 9, 25, 0, 6, 1), p.StartDate); - Assert.AreEqual(28, p.Age); - Assert.AreEqual(long.MaxValue, p.BigNumber); - Assert.AreEqual(99.9999m, p.Percent); - Assert.AreEqual(false, p.IsCool); - Assert.AreEqual(new Uri("http://example.com", UriKind.RelativeOrAbsolute), p.Url); - Assert.AreEqual(new Uri("/foo/bar", UriKind.RelativeOrAbsolute), p.UrlPath); - Assert.NotNull(p.Friends); - Assert.AreEqual(10, p.Friends.Count); - Assert.NotNull(p.BestFriend); - Assert.AreEqual("The Fonz", p.BestFriend.Name); - Assert.AreEqual(1952, p.BestFriend.Since); - Assert.IsNotEmpty(p.Foes); - Assert.AreEqual("Foe 1", p.Foes["dict1"].Nickname); - Assert.AreEqual("Foe 2", p.Foes["dict2"].Nickname); - } - - [Test] - public void Can_Deserialize_Names_With_Underscores_With_Default_Root_Alternative_Culture() - { - using (new CultureChange(ALTERNATIVE_CULTURE)) - { - this.Can_Deserialize_Names_With_Underscores_With_Default_Root(); - } - } - - [Test] - public void Can_Deserialize_Names_With_Dashes_With_Default_Root() - { - string doc = CreateJsonWithDashes(); - JsonDeserializer d = new JsonDeserializer(); - RestResponse response = new RestResponse { Content = doc }; - PersonForJson p = d.Deserialize(response); - - Assert.AreEqual("John Sheehan", p.Name); - //Assert.AreEqual(new DateTime(2009, 9, 25, 0, 6, 1, DateTimeKind.Utc), p.StartDate); - Assert.AreEqual(28, p.Age); - Assert.AreEqual(long.MaxValue, p.BigNumber); - Assert.AreEqual(99.9999m, p.Percent); - Assert.AreEqual(false, p.IsCool); - Assert.AreEqual(new Uri("http://example.com", UriKind.RelativeOrAbsolute), p.Url); - Assert.AreEqual(new Uri("/foo/bar", UriKind.RelativeOrAbsolute), p.UrlPath); - Assert.NotNull(p.Friends); - Assert.AreEqual(10, p.Friends.Count); - Assert.NotNull(p.BestFriend); - Assert.AreEqual("The Fonz", p.BestFriend.Name); - Assert.AreEqual(1952, p.BestFriend.Since); - Assert.IsNotEmpty(p.Foes); - Assert.AreEqual("Foe 1", p.Foes["dict1"].Nickname); - Assert.AreEqual("Foe 2", p.Foes["dict2"].Nickname); - } - - [Test] - public void Can_Deserialize_Names_With_Dashes_With_Default_Root_Alternative_Culture() - { - using (new CultureChange(ALTERNATIVE_CULTURE)) - { - this.Can_Deserialize_Names_With_Dashes_With_Default_Root(); - } - } - - [Test] - public void Ignore_Protected_Property_That_Exists_In_Data() - { - string doc = CreateJson(); - JsonDeserializer d = new JsonDeserializer(); - RestResponse response = new RestResponse { Content = doc }; - PersonForJson p = d.Deserialize(response); - - Assert.Null(p.IgnoreProxy); - } - - [Test] - public void Ignore_ReadOnly_Property_That_Exists_In_Data() - { - string doc = CreateJson(); - RestResponse response = new RestResponse { Content = doc }; - JsonDeserializer d = new JsonDeserializer(); - PersonForJson p = d.Deserialize(response); - - Assert.Null(p.ReadOnlyProxy); - } - - [Test] - public void Can_Deserialize_TimeSpan() - { - TimeSpanTestStructure payload = GetPayLoad("timespans.txt"); - - Assert.AreEqual(new TimeSpan(468006), payload.Tick); - Assert.AreEqual(new TimeSpan(0, 0, 0, 0, 125), payload.Millisecond); - Assert.AreEqual(new TimeSpan(0, 0, 8), payload.Second); - Assert.AreEqual(new TimeSpan(0, 55, 2), payload.Minute); - Assert.AreEqual(new TimeSpan(21, 30, 7), payload.Hour); - Assert.Null(payload.NullableWithoutValue); - Assert.NotNull(payload.NullableWithValue); - Assert.AreEqual(new TimeSpan(21, 30, 7), payload.NullableWithValue.Value); - Assert.AreEqual(new TimeSpan(0, 0, 10), payload.IsoSecond); - Assert.AreEqual(new TimeSpan(0, 3, 23), payload.IsoMinute); - Assert.AreEqual(new TimeSpan(5, 4, 9), payload.IsoHour); - Assert.AreEqual(new TimeSpan(1, 19, 27, 13), payload.IsoDay); - // 2 months + 4 days = 64 days - Assert.AreEqual(new TimeSpan(64, 3, 14, 19), payload.IsoMonth); - // 1 year = 365 days - Assert.AreEqual(new TimeSpan(365, 9, 27, 48), payload.IsoYear); - } - - [Test] - public void Can_Deserialize_Iso_Json_Dates() - { - string doc = CreateIsoDateJson(); - JsonDeserializer d = new JsonDeserializer(); - RestResponse response = new RestResponse { Content = doc }; - Birthdate bd = d.Deserialize(response); - - Assert.AreEqual(new DateTime(1910, 9, 25, 9, 30, 25, DateTimeKind.Utc), bd.Value); - } - - [Test] - public void Can_Deserialize_Unix_Json_Dates() - { - string doc = CreateUnixDateJson(); - JsonDeserializer d = new JsonDeserializer(); - RestResponse response = new RestResponse { Content = doc }; - Birthdate bd = d.Deserialize(response); - - Assert.AreEqual(new DateTime(2011, 6, 30, 8, 15, 46, DateTimeKind.Utc), bd.Value); - } - - [Test] - public void Can_Deserialize_Unix_Json_Millisecond_Dates() - { - string doc = CreateUnixDateMillisecondsJson(); - JsonDeserializer d = new JsonDeserializer(); - RestResponse response = new RestResponse { Content = doc }; - Birthdate bd = d.Deserialize(response); - - Assert.AreEqual(new DateTime(2011, 6, 30, 8, 15, 46, DateTimeKind.Utc), bd.Value); - } - - [Test] - public void Can_Deserialize_JsonNet_Dates() - { - PersonForJson person = GetPayLoad("person.json.txt"); - - Assert.AreEqual( - new DateTime(2011, 6, 30, 8, 15, 46, 929, DateTimeKind.Utc), - person.StartDate); - } - - [Test] - public void Can_Deserialize_DateTime() - { - DateTimeTestStructure payload = GetPayLoad("datetimes.txt"); - - Assert.AreEqual( - new DateTime(2011, 6, 30, 8, 15, 46, 929, DateTimeKind.Utc), - payload.DateTime); - } - - [Test] - public void Can_Deserialize_Nullable_DateTime_With_Value() - { - DateTimeTestStructure payload = GetPayLoad("datetimes.txt"); - - Assert.NotNull(payload.NullableDateTimeWithValue); - Assert.AreEqual( - new DateTime(2011, 6, 30, 8, 15, 46, 929, DateTimeKind.Utc), - payload.NullableDateTimeWithValue.Value); - } - - [Test] - public void Can_Deserialize_Nullable_DateTime_With_Null() - { - DateTimeTestStructure payload = GetPayLoad("datetimes.txt"); - - Assert.Null(payload.NullableDateTimeWithNull); - } - - [Test] - public void Can_Deserialize_DateTimeOffset() - { - DateTimeTestStructure payload = GetPayLoad("datetimes.txt"); - - Assert.AreEqual( - new DateTime(2011, 6, 30, 8, 15, 46, 929, DateTimeKind.Utc).ToString("yyyy-MM-dd HH:mm:ss.fff"), - payload.DateTimeOffset.ToString("yyyy-MM-dd HH:mm:ss.fff")); - } - - [Test] - public void Can_Deserialize_Iso8601DateTimeLocal() - { - Iso8601DateTimeTestStructure payload = GetPayLoad("iso8601datetimes.txt"); - - Assert.AreEqual( - new DateTime(2012, 7, 19, 10, 23, 25, DateTimeKind.Utc), - payload.DateTimeLocal); - } - - [Test] - public void Can_Deserialize_Iso8601DateTimeZulu() - { - Iso8601DateTimeTestStructure payload = GetPayLoad("iso8601datetimes.txt"); - - Assert.AreEqual( - new DateTime(2012, 7, 19, 10, 23, 25, 544, DateTimeKind.Utc), - payload.DateTimeUtc.ToUniversalTime()); - } - - [Test] - public void Can_Deserialize_Iso8601DateTimeWithOffset() - { - Iso8601DateTimeTestStructure payload = GetPayLoad("iso8601datetimes.txt"); - - Assert.AreEqual( - new DateTime(2012, 7, 19, 10, 23, 25, 544, DateTimeKind.Utc), - payload.DateTimeWithOffset.ToUniversalTime()); - } - - [Test] - public void Can_Deserialize_Nullable_DateTimeOffset_With_Value() - { - DateTimeTestStructure payload = GetPayLoad("datetimes.txt"); - - Assert.NotNull(payload.NullableDateTimeOffsetWithValue); - Assert.AreEqual( - new DateTime(2011, 6, 30, 8, 15, 46, 929, DateTimeKind.Utc).ToString("yyyy-MM-dd HH:mm:ss.fff"), - payload.NullableDateTimeOffsetWithValue.Value.ToString("yyyy-MM-dd HH:mm:ss.fff")); - } - - [Test] - public void Can_Deserialize_Nullable_DateTimeOffset_With_Null() - { - DateTimeTestStructure payload = GetPayLoad("datetimes.txt"); - - Assert.Null(payload.NullableDateTimeOffsetWithNull); - } - - [Test] - public void Can_Deserialize_To_Dictionary_String_String() - { - string doc = this.CreateJsonStringDictionary(); - JsonDeserializer d = new JsonDeserializer(); - RestResponse response = new RestResponse { Content = doc }; - Dictionary bd = d.Deserialize>(response); - - Assert.AreEqual(bd["Thing1"], "Thing1"); - Assert.AreEqual(bd["Thing2"], "Thing2"); - Assert.AreEqual(bd["ThingRed"], "ThingRed"); - Assert.AreEqual(bd["ThingBlue"], "ThingBlue"); - } - - [Test] - public void Can_Deserialize_To_Dictionary_String_String_With_Dynamic_Values() - { - string doc = this.CreateDynamicJsonStringDictionary(); - JsonDeserializer d = new JsonDeserializer(); - RestResponse response = new RestResponse { Content = doc }; - Dictionary bd = d.Deserialize>(response); - - Assert.AreEqual("[\"Value1\",\"Value2\"]", bd["Thing1"]); - Assert.AreEqual("Thing2", bd["Thing2"]); - Assert.AreEqual("{\"Name\":\"ThingRed\",\"Color\":\"Red\"}", bd["ThingRed"]); - Assert.AreEqual("{\"Name\":\"ThingBlue\",\"Color\":\"Blue\"}", bd["ThingBlue"]); - } - - [Test] - public void Can_Deserialize_Decimal_With_Four_Zeros_After_Floating_Point() - { - const string json = "{\"Value\":0.00005557}"; - RestResponse response = new RestResponse { Content = json }; - JsonDeserializer d = new JsonDeserializer(); - DecimalNumber result = d.Deserialize(response); - - Assert.AreEqual(result.Value, .00005557m); - } - - [Test] - public void Can_Deserialize_Object_Type_Property_With_Primitive_Vale() - { - ObjectProperties payload = GetPayLoad("objectproperty.txt"); - - Assert.AreEqual(42L, payload.ObjectProperty); - } - - [Test] - public void Can_Deserialize_Dictionary_of_Lists() - { - string doc = File.ReadAllText(Path.Combine(currentPath, "SampleData", "jsondictionary.txt")); - JsonDeserializer json = new JsonDeserializer { RootElement = "response" }; - EmployeeTracker output = json.Deserialize(new RestResponse { Content = doc }); - - Assert.IsNotEmpty(output.EmployeesMail); - Assert.IsNotEmpty(output.EmployeesTime); - Assert.IsNotEmpty(output.EmployeesPay); - } - - [Test] - public void Can_Deserialize_Plain_Values() - { - const string json = "\"c02bdd1e-cce3-4b9c-8473-165e6e93b92a\""; - RestResponse response = new RestResponse { Content = json }; - JsonDeserializer d = new JsonDeserializer(); - Guid result = d.Deserialize(response); - - Assert.AreEqual(result, new Guid("c02bdd1e-cce3-4b9c-8473-165e6e93b92a")); - } - - [Test] - public void Can_Deserialize_Dictionary_with_Null() - { - string doc = File.ReadAllText(Path.Combine(currentPath, "SampleData", "jsondictionary_null.txt")); - JsonDeserializer json = new JsonDeserializer { RootElement = "response" }; - IDictionary output = json.Deserialize>(new RestResponse { Content = doc }); - - IDictionary dictionary = (IDictionary)output["SomeDictionary"]; - Assert.AreEqual("abra", dictionary["NonNull"]); - Assert.IsNull(dictionary["Null"]); - } - - private static string CreateJsonWithUnderscores() - { - JsonObject doc = new JsonObject(); - - doc["name"] = "John Sheehan"; - doc["start_date"] = new DateTime(2009, 9, 25, 0, 6, 1, DateTimeKind.Utc); - doc["age"] = 28; - doc["percent"] = 99.9999m; - doc["big_number"] = long.MaxValue; - doc["is_cool"] = false; - doc["ignore"] = "dummy"; - doc["read_only"] = "dummy"; - doc["url"] = "http://example.com"; - doc["url_path"] = "/foo/bar"; - doc["best_friend"] = new JsonObject - { - { "name", "The Fonz" }, - { "since", 1952 } - }; - - JsonArray friendsArray = new JsonArray(); - - for (int i = 0; i < 10; i++) - { - friendsArray.Add(new JsonObject - { - { "name", "Friend" + i }, - { "since", DateTime.Now.Year - i } - }); - } - - doc["friends"] = friendsArray; - - JsonObject foesArray = new JsonObject - { - { "dict1", new JsonObject { { "nickname", "Foe 1" } } }, - { "dict2", new JsonObject { { "nickname", "Foe 2" } } } - }; - - doc["foes"] = foesArray; - - return doc.ToString(); - } - - private static string CreateJsonWithDashes() - { - JsonObject doc = new JsonObject(); - - doc["name"] = "John Sheehan"; - doc["start-date"] = new DateTime(2009, 9, 25, 0, 6, 1, DateTimeKind.Utc); - doc["age"] = 28; - doc["percent"] = 99.9999m; - doc["big-number"] = long.MaxValue; - doc["is-cool"] = false; - doc["ignore"] = "dummy"; - doc["read-only"] = "dummy"; - doc["url"] = "http://example.com"; - doc["url-path"] = "/foo/bar"; - doc["best-friend"] = new JsonObject - { - { "name", "The Fonz" }, - { "since", 1952 } - }; - - JsonArray friendsArray = new JsonArray(); - - for (int i = 0; i < 10; i++) - { - friendsArray.Add(new JsonObject - { - { "name", "Friend" + i }, - { "since", DateTime.Now.Year - i } - }); - } - - doc["friends"] = friendsArray; - - JsonObject foesArray = new JsonObject - { - { "dict1", new JsonObject { { "nickname", "Foe 1" } } }, - { "dict2", new JsonObject { { "nickname", "Foe 2" } } } - }; - - doc["foes"] = foesArray; - - return doc.ToString(); - } - - private static string CreateIsoDateJson() - { - Birthdate bd = new Birthdate - { - Value = new DateTime(1910, 9, 25, 9, 30, 25, DateTimeKind.Utc) - }; - - return SimpleJson.SerializeObject(bd); - } - - private static string CreateUnixDateJson() - { - JsonObject doc = new JsonObject(); - - doc["Value"] = 1309421746; - - return doc.ToString(); - } - - private static string CreateUnixDateMillisecondsJson() - { - JsonObject doc = new JsonObject(); - - doc["Value"] = 1309421746000; - - return doc.ToString(); - } - - private static string CreateJson() - { - JsonObject doc = new JsonObject(); - - doc["Name"] = "John Sheehan"; - doc["StartDate"] = new DateTime(2009, 9, 25, 0, 6, 1, DateTimeKind.Utc); - doc["Age"] = 28; - doc["Percent"] = 99.9999m; - doc["BigNumber"] = long.MaxValue; - doc["IsCool"] = false; - doc["Ignore"] = "dummy"; - doc["ReadOnly"] = "dummy"; - doc["Url"] = "http://example.com"; - doc["UrlPath"] = "/foo/bar"; - doc["Order"] = "third"; - doc["Disposition"] = "so_so"; - doc["Guid"] = new Guid(GUID_STRING).ToString(); - doc["EmptyGuid"] = ""; - doc["BestFriend"] = new JsonObject - { - { "Name", "The Fonz" }, - { "Since", 1952 } - }; - - JsonArray friendsArray = new JsonArray(); - - for (int i = 0; i < 10; i++) - { - friendsArray.Add(new JsonObject - { - { "Name", "Friend" + i }, - { "Since", DateTime.Now.Year - i } - }); - } - - doc["Friends"] = friendsArray; - - JsonObject foesArray = new JsonObject - { - { "dict1", new JsonObject { { "nickname", "Foe 1" } } }, - { "dict2", new JsonObject { { "nickname", "Foe 2" } } } - }; - - doc["Foes"] = foesArray; - - return doc.ToString(); - } - - private static string CreateJsonWithNullValues() - { - JsonObject doc = new JsonObject(); - - doc["Id"] = null; - doc["StartDate"] = null; - doc["UniqueId"] = null; - - return doc.ToString(); - } - - private static string CreateJsonWithEmptyValues() - { - JsonObject doc = new JsonObject(); - - doc["Id"] = ""; - doc["StartDate"] = ""; - doc["UniqueId"] = ""; - - return doc.ToString(); - } - - private static string CreateJsonWithoutEmptyValues() - { - JsonObject doc = new JsonObject(); - - doc["Id"] = 123; - doc["StartDate"] = new DateTime(2010, 2, 21, 9, 35, 00, DateTimeKind.Utc); - doc["UniqueId"] = new Guid(GUID_STRING).ToString(); - - return doc.ToString(); - } - - public string CreateJsonStringDictionary() - { - JsonObject doc = new JsonObject(); - - doc["Thing1"] = "Thing1"; - doc["Thing2"] = "Thing2"; - doc["ThingRed"] = "ThingRed"; - doc["ThingBlue"] = "ThingBlue"; - - return doc.ToString(); - } - - public string CreateDynamicJsonStringDictionary() - { - JsonObject doc = new JsonObject(); - - doc["Thing1"] = new JsonArray - { - "Value1", - "Value2" - }; - doc["Thing2"] = "Thing2"; - doc["ThingRed"] = new JsonObject - { - { "Name", "ThingRed" }, - { "Color", "Red" } - }; - doc["ThingBlue"] = new JsonObject - { - { "Name", "ThingBlue" }, - { "Color", "Blue" } - }; - - return doc.ToString(); - } - - private static T GetPayLoad(string fileName) - { - string doc = File.ReadAllText(Path.Combine(currentPath, "SampleData", fileName)); - RestResponse response = new RestResponse { Content = doc }; - JsonDeserializer d = new JsonDeserializer(); - - return d.Deserialize(response); - } - } -} diff --git a/RestSharp.Tests/JwtAuthTests.cs b/RestSharp.Tests/JwtAuthTests.cs deleted file mode 100644 index 6172a88ab..000000000 --- a/RestSharp.Tests/JwtAuthTests.cs +++ /dev/null @@ -1,101 +0,0 @@ -using System; -using System.Collections.Generic; -using System.Globalization; -using System.Linq; -using System.Threading; -using NUnit.Framework; -using RestSharp.Authenticators; - -namespace RestSharp.Tests -{ - [TestFixture] - public class JwtAuthTests - { - private readonly string testJwt; - - private readonly string expectedAuthHeaderContent; - - public JwtAuthTests() - { - Thread.CurrentThread.CurrentCulture = CultureInfo.InvariantCulture; - Thread.CurrentThread.CurrentUICulture = CultureInfo.InstalledUICulture; - - this.testJwt = "eyJ0eXAiOiJKV1QiLA0KICJhbGciOiJIUzI1NiJ9" + "." + - "eyJpc3MiOiJqb2UiLA0KICJleHAiOjEzMDA4MTkzODAsDQo" + - "gImh0dHA6Ly9leGFtcGxlLmNvbS9pc19yb290Ijp0cnVlfQ" + "." + - "dBjftJeZ4CVP-mB92K27uhbUJU1p1r_wW1gFWFOEjXk"; - - this.expectedAuthHeaderContent = string.Format("Bearer {0}", this.testJwt); - } - - [Test] - public void Throw_Argument_Null_Exception() - { - ArgumentNullException exception = Assert.Throws(() => new JwtAuthenticator(null)); - - Assert.AreEqual("accessToken", exception.ParamName); - } - - [Test] - public void Can_Set_ValidFormat_Auth_Header() - { - RestClient client = new RestClient { Authenticator = new JwtAuthenticator(this.testJwt) }; - RestRequest request = new RestRequest(); - - //In real case client.Execute(request) will invoke Authenticate method - client.Authenticator.Authenticate(client, request); - - Parameter authParam = request.Parameters.Single(p => p.Name.Equals("Authorization", StringComparison.OrdinalIgnoreCase)); - - Assert.True(authParam.Type == ParameterType.HttpHeader); - Assert.AreEqual(this.expectedAuthHeaderContent, authParam.Value); - } - - [Test] - public void Check_Only_Header_Authorization() - { - RestClient client = new RestClient { Authenticator = new JwtAuthenticator(this.testJwt) }; - RestRequest request = new RestRequest(); - - //Paranoic server needs "two-factor authentication": jwt header and query param key for example - request.AddParameter("Authorization", "manualAuth", ParameterType.QueryString); - - //In real case client.Execute(request) will invoke Authenticate method - client.Authenticator.Authenticate(client, request); - - List paramList = request.Parameters.FindAll(p => p.Name.Equals("Authorization")); - - Assert.AreEqual(2, paramList.Count); - - Parameter queryAuthParam = paramList.Single(p => p.Type.Equals(ParameterType.QueryString)); - Parameter headerAuthParam = paramList.Single(p => p.Type.Equals(ParameterType.HttpHeader)); - - Assert.AreEqual("manualAuth", queryAuthParam.Value); - Assert.AreEqual(this.expectedAuthHeaderContent, headerAuthParam.Value); - } - - [Test] - public void Set_Auth_Header_Only_Once() - { - RestClient client = new RestClient(); - RestRequest request = new RestRequest(); - - request.AddHeader("Authorization", this.expectedAuthHeaderContent); - - client.Authenticator = new JwtAuthenticator("second_header_auth_token"); - - //In real case client.Execute(...) will invoke Authenticate method - client.Authenticator.Authenticate(client, request); - - List paramList = request.Parameters.FindAll(p => p.Name.Equals("Authorization")); - - Assert.AreEqual(1, paramList.Count); - - Parameter authParam = paramList[0]; - - Assert.True(authParam.Type == ParameterType.HttpHeader); - Assert.AreEqual(this.expectedAuthHeaderContent, authParam.Value); - Assert.AreNotEqual("second_header_auth_token", authParam.Value); - } - } -} diff --git a/RestSharp.Tests/NamespacedXmlTests.cs b/RestSharp.Tests/NamespacedXmlTests.cs deleted file mode 100644 index 9cb96a7ec..000000000 --- a/RestSharp.Tests/NamespacedXmlTests.cs +++ /dev/null @@ -1,291 +0,0 @@ -#region Licensed - -// Copyright 2010 John Sheehan -// -// Licensed under the Apache License, Version 2.0 (the "License"); -// you may not use this file except in compliance with the License. -// You may obtain a copy of the License at -// -// http://www.apache.org/licenses/LICENSE-2.0 -// -// Unless required by applicable law or agreed to in writing, software -// distributed under the License is distributed on an "AS IS" BASIS, -// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -// See the License for the specific language governing permissions and -// limitations under the License. - -#endregion - -using System; -using System.Collections.Generic; -using System.Xml.Linq; -using NUnit.Framework; -using RestSharp.Deserializers; -using RestSharp.Tests.SampleClasses; -using RestSharp.Tests.SampleClasses.Lastfm; - -namespace RestSharp.Tests -{ - [TestFixture] - public class NamespacedXmlTests - { - private const string GUID_STRING = "AC1FC4BC-087A-4242-B8EE-C53EBE9887A5"; - - [Test] - public void Can_Deserialize_Elements_With_Namespace() - { - string doc = CreateElementsXml(); - RestResponse response = new RestResponse { Content = doc }; - XmlDeserializer d = new XmlDeserializer { Namespace = "http://restsharp.org" }; - PersonForXml p = d.Deserialize(response); - - Assert.AreEqual("John Sheehan", p.Name); - Assert.AreEqual(new DateTime(2009, 9, 25, 0, 6, 1), p.StartDate); - Assert.AreEqual(28, p.Age); - Assert.AreEqual(long.MaxValue, p.BigNumber); - Assert.AreEqual(99.9999m, p.Percent); - Assert.AreEqual(false, p.IsCool); - Assert.AreEqual(new Guid(GUID_STRING), p.UniqueId); - Assert.AreEqual(new Uri("http://example.com", UriKind.RelativeOrAbsolute), p.Url); - Assert.AreEqual(new Uri("/foo/bar", UriKind.RelativeOrAbsolute), p.UrlPath); - Assert.NotNull(p.Friends); - Assert.AreEqual(10, p.Friends.Count); - Assert.NotNull(p.BestFriend); - Assert.AreEqual("The Fonz", p.BestFriend.Name); - Assert.AreEqual(1952, p.BestFriend.Since); - } - - [Test] - public void Can_Deserialize_Elements_With_Namespace_Autodetect_Namespace() - { - string doc = CreateElementsXml(); - RestResponse response = new RestResponse { Content = doc }; - XmlDeserializer d = new XmlDeserializer(); - PersonForXml p = d.Deserialize(response); - - Assert.AreEqual("John Sheehan", p.Name); - Assert.AreEqual(new DateTime(2009, 9, 25, 0, 6, 1), p.StartDate); - Assert.AreEqual(28, p.Age); - Assert.AreEqual(long.MaxValue, p.BigNumber); - Assert.AreEqual(99.9999m, p.Percent); - Assert.AreEqual(false, p.IsCool); - Assert.AreEqual(new Guid(GUID_STRING), p.UniqueId); - Assert.AreEqual(new Uri("http://example.com", UriKind.RelativeOrAbsolute), p.Url); - Assert.AreEqual(new Uri("/foo/bar", UriKind.RelativeOrAbsolute), p.UrlPath); - Assert.NotNull(p.Friends); - Assert.AreEqual(10, p.Friends.Count); - Assert.NotNull(p.BestFriend); - Assert.AreEqual("The Fonz", p.BestFriend.Name); - Assert.AreEqual(1952, p.BestFriend.Since); - } - - [Test] - public void Can_Deserialize_Attributes_With_Namespace() - { - string doc = CreateAttributesXml(); - RestResponse response = new RestResponse { Content = doc }; - XmlDeserializer d = new XmlDeserializer { Namespace = "http://restsharp.org" }; - PersonForXml p = d.Deserialize(response); - - Assert.AreEqual("John Sheehan", p.Name); - Assert.AreEqual(new DateTime(2009, 9, 25, 0, 6, 1), p.StartDate); - Assert.AreEqual(28, p.Age); - Assert.AreEqual(long.MaxValue, p.BigNumber); - Assert.AreEqual(99.9999m, p.Percent); - Assert.AreEqual(false, p.IsCool); - Assert.AreEqual(new Guid(GUID_STRING), p.UniqueId); - Assert.AreEqual(new Uri("http://example.com", UriKind.RelativeOrAbsolute), p.Url); - Assert.AreEqual(new Uri("/foo/bar", UriKind.RelativeOrAbsolute), p.UrlPath); - Assert.NotNull(p.BestFriend); - Assert.AreEqual("The Fonz", p.BestFriend.Name); - Assert.AreEqual(1952, p.BestFriend.Since); - } - - [Test] - public void Ignore_Protected_Property_That_Exists_In_Data() - { - string doc = CreateElementsXml(); - RestResponse response = new RestResponse { Content = doc }; - XmlDeserializer d = new XmlDeserializer { Namespace = "http://restsharp.org" }; - PersonForXml p = d.Deserialize(response); - - Assert.Null(p.IgnoreProxy); - } - - [Test] - public void Ignore_ReadOnly_Property_That_Exists_In_Data() - { - string doc = CreateElementsXml(); - RestResponse response = new RestResponse { Content = doc }; - XmlDeserializer d = new XmlDeserializer { Namespace = "http://restsharp.org" }; - PersonForXml p = d.Deserialize(response); - - Assert.Null(p.ReadOnlyProxy); - } - - [Test] - public void Can_Deserialize_Names_With_Underscores_With_Namespace() - { - string doc = CreateUnderscoresXml(); - RestResponse response = new RestResponse { Content = doc }; - XmlDeserializer d = new XmlDeserializer { Namespace = "http://restsharp.org" }; - PersonForXml p = d.Deserialize(response); - - Assert.AreEqual("John Sheehan", p.Name); - Assert.AreEqual(new DateTime(2009, 9, 25, 0, 6, 1), p.StartDate); - Assert.AreEqual(28, p.Age); - Assert.AreEqual(long.MaxValue, p.BigNumber); - Assert.AreEqual(99.9999m, p.Percent); - Assert.AreEqual(false, p.IsCool); - Assert.AreEqual(new Guid(GUID_STRING), p.UniqueId); - Assert.AreEqual(new Uri("http://example.com", UriKind.RelativeOrAbsolute), p.Url); - Assert.AreEqual(new Uri("/foo/bar", UriKind.RelativeOrAbsolute), p.UrlPath); - Assert.NotNull(p.Friends); - Assert.AreEqual(10, p.Friends.Count); - Assert.NotNull(p.BestFriend); - Assert.AreEqual("The Fonz", p.BestFriend.Name); - Assert.AreEqual(1952, p.BestFriend.Since); - Assert.NotNull(p.Foes); - Assert.AreEqual(5, p.Foes.Count); - Assert.AreEqual("Yankees", p.Foes.Team); - } - - [Test] - public void Can_Deserialize_List_Of_Primitives_With_Namespace() - { - string doc = CreateListOfPrimitivesXml(); - RestResponse response = new RestResponse { Content = doc }; - XmlDeserializer d = new XmlDeserializer { Namespace = "http://restsharp.org" }; - List a = d.Deserialize>(response); - - Assert.AreEqual(2, a.Count); - Assert.AreEqual("first", a[0].Value); - Assert.AreEqual("second", a[1].Value); - } - - private static string CreateListOfPrimitivesXml() - { - XDocument doc = new XDocument(); - XNamespace ns = XNamespace.Get("http://restsharp.org"); - XElement root = new XElement(ns + "artists"); - - root.Add(new XElement(ns + "artist", "first")); - root.Add(new XElement(ns + "artist", "second")); - doc.Add(root); - - return doc.ToString(); - } - - private static string CreateUnderscoresXml() - { - XDocument doc = new XDocument(); - XNamespace ns = XNamespace.Get("http://restsharp.org"); - XElement root = new XElement(ns + "Person"); - - root.Add(new XElement(ns + "Name", "John Sheehan")); - root.Add(new XElement(ns + "Start_Date", new DateTime(2009, 9, 25, 0, 6, 1))); - root.Add(new XAttribute(ns + "Age", 28)); - root.Add(new XElement(ns + "Percent", 99.9999m)); - root.Add(new XElement(ns + "Big_Number", long.MaxValue)); - root.Add(new XAttribute(ns + "Is_Cool", false)); - root.Add(new XElement(ns + "Ignore", "dummy")); - root.Add(new XAttribute(ns + "Read_Only", "dummy")); - root.Add(new XAttribute(ns + "Unique_Id", new Guid(GUID_STRING))); - root.Add(new XElement(ns + "Url", "http://example.com")); - root.Add(new XElement(ns + "Url_Path", "/foo/bar")); - root.Add(new XElement(ns + "Best_Friend", - new XElement(ns + "Name", "The Fonz"), - new XAttribute(ns + "Since", 1952))); - - XElement friends = new XElement(ns + "Friends"); - - for (int i = 0; i < 10; i++) - { - friends.Add(new XElement(ns + "Friend", - new XElement(ns + "Name", "Friend" + i), - new XAttribute(ns + "Since", DateTime.Now.Year - i))); - } - - root.Add(friends); - - XElement foes = new XElement(ns + "Foes"); - - foes.Add(new XAttribute(ns + "Team", "Yankees")); - - for (int i = 0; i < 5; i++) - { - foes.Add(new XElement(ns + "Foe", new XElement(ns + "Nickname", "Foe" + i))); - } - - root.Add(foes); - doc.Add(root); - - return doc.ToString(); - } - - private static string CreateElementsXml() - { - XDocument doc = new XDocument(); - XNamespace ns = XNamespace.Get("http://restsharp.org"); - XElement root = new XElement(ns + "Person"); - - root.Add(new XElement(ns + "Name", "John Sheehan")); - root.Add(new XElement(ns + "StartDate", new DateTime(2009, 9, 25, 0, 6, 1))); - root.Add(new XElement(ns + "Age", 28)); - root.Add(new XElement(ns + "Percent", 99.9999m)); - root.Add(new XElement(ns + "BigNumber", long.MaxValue)); - root.Add(new XElement(ns + "IsCool", false)); - root.Add(new XElement(ns + "Ignore", "dummy")); - root.Add(new XElement(ns + "ReadOnly", "dummy")); - root.Add(new XElement(ns + "UniqueId", new Guid(GUID_STRING))); - root.Add(new XElement(ns + "Url", "http://example.com")); - root.Add(new XElement(ns + "UrlPath", "/foo/bar")); - root.Add(new XElement(ns + "BestFriend", - new XElement(ns + "Name", "The Fonz"), - new XElement(ns + "Since", 1952))); - - XElement friends = new XElement(ns + "Friends"); - - for (int i = 0; i < 10; i++) - { - friends.Add(new XElement(ns + "Friend", - new XElement(ns + "Name", "Friend" + i), - new XElement(ns + "Since", DateTime.Now.Year - i))); - } - - root.Add(friends); - root.Add(new XElement(ns + "FavoriteBand", - new XElement(ns + "Name", "Goldfinger"))); - - doc.Add(root); - - return doc.ToString(); - } - - private static string CreateAttributesXml() - { - XDocument doc = new XDocument(); - XNamespace ns = XNamespace.Get("http://restsharp.org"); - XElement root = new XElement(ns + "Person"); - - root.Add(new XAttribute(ns + "Name", "John Sheehan")); - root.Add(new XAttribute(ns + "StartDate", new DateTime(2009, 9, 25, 0, 6, 1))); - root.Add(new XAttribute(ns + "Age", 28)); - root.Add(new XAttribute(ns + "Percent", 99.9999m)); - root.Add(new XAttribute(ns + "BigNumber", long.MaxValue)); - root.Add(new XAttribute(ns + "IsCool", false)); - root.Add(new XAttribute(ns + "Ignore", "dummy")); - root.Add(new XAttribute(ns + "ReadOnly", "dummy")); - root.Add(new XAttribute(ns + "UniqueId", new Guid(GUID_STRING))); - root.Add(new XAttribute(ns + "Url", "http://example.com")); - root.Add(new XAttribute(ns + "UrlPath", "/foo/bar")); - root.Add(new XElement(ns + "BestFriend", - new XAttribute(ns + "Name", "The Fonz"), - new XAttribute(ns + "Since", 1952))); - - doc.Add(root); - - return doc.ToString(); - } - } -} diff --git a/RestSharp.Tests/OAuthTests.cs b/RestSharp.Tests/OAuthTests.cs deleted file mode 100644 index f860c45a6..000000000 --- a/RestSharp.Tests/OAuthTests.cs +++ /dev/null @@ -1,68 +0,0 @@ -using System; -using System.Globalization; -using System.Threading; -using NUnit.Framework; -using RestSharp.Authenticators.OAuth; -using RestSharp.Authenticators.OAuth.Extensions; - -namespace RestSharp.Tests -{ - [TestFixture] - public class OAuthTests - { - public OAuthTests() - { - Thread.CurrentThread.CurrentCulture = CultureInfo.InvariantCulture; - Thread.CurrentThread.CurrentUICulture = CultureInfo.InstalledUICulture; - } - - [Test] - [TestCase("abcdefghijklmnopqrstuvwxyz", "abcdefghijklmnopqrstuvwxyz")] - [TestCase("ABCDEFGHIJKLMNOPQRSTUVWXYZ", "ABCDEFGHIJKLMNOPQRSTUVWXYZ")] - [TestCase("0123456789", "0123456789")] - [TestCase("-._~", "-._~")] - [TestCase(" !\"#$%&'()*+,", "%20%21%22%23%24%25%26%27%28%29%2A%2B%2C")] - [TestCase("%$%", "%25%24%25")] - [TestCase("%", "%25")] - [TestCase("/:;<=>?@", "%2F%3A%3B%3C%3D%3E%3F%40")] - [TestCase("\x00\x01\a\b\f\n\r\t\v", @"%00%01%07%08%0C%0A%0D%09%0B")] - public void UrlStrictEncode_Encodes_Correctly(string value, string expected) - { - string actual = OAuthTools.UrlEncodeStrict(value); - - Assert.AreEqual(expected, actual); - } - - [Test] - [TestCase("1234", "%31%32%33%34")] - [TestCase("\x00\x01\x02\x03", "%00%01%02%03")] - [TestCase("\r\n\t", "%0D%0A%09")] - public void PercentEncode_Encodes_Correctly(string value, string expected) - { - string actual = value.PercentEncode(); - - Assert.AreEqual(expected, actual); - } - - [Test] - [TestCase("The quick brown fox jumps over the lazy dog", "rVL90tHhGt0eQ0TCITY74nVL22P%2FltlWS7WvJXpECPs%3D")] - [TestCase("The quick\tbrown\nfox\rjumps\r\nover\t\tthe\n\nlazy\r\n\r\ndog", "C%2B2RY0Hna6VrfK1crCkU%2FV1e0ECoxoDh41iOOdmEMx8%3D")] - [TestCase("", "%2BnkCwZfv%2FQVmBbNZsPKbBT3kAg3JtVn3f3YMBtV83L8%3D")] - [TestCase(" !\"#$%&'()*+,", "xcTgWGBVZaw%2Bilg6kjWAGt%2FhCcsVBMMe1CcDEnxnh8Y%3D")] - public void HmacSha256_Hashes_Correctly(string value, string expected) - { - string consumerSecret = "12345678"; - string actual = OAuthTools.GetSignature(OAuthSignatureMethod.HmacSha256, value, consumerSecret); - - Assert.AreEqual(expected, actual); - } - - [Test] - public void HmacSha256_Does_Not_Accept_Nulls() - { - string consumerSecret = "12345678"; - Assert.That(() => OAuthTools.GetSignature(OAuthSignatureMethod.HmacSha256, null, consumerSecret), - Throws.TypeOf()); - } - } -} \ No newline at end of file diff --git a/RestSharp.Tests/RestRequestTests.cs b/RestSharp.Tests/RestRequestTests.cs deleted file mode 100644 index a6307de1b..000000000 --- a/RestSharp.Tests/RestRequestTests.cs +++ /dev/null @@ -1,92 +0,0 @@ -using System; -using System.Globalization; -using System.Linq; -using System.Threading; -using NUnit.Framework; - -namespace RestSharp.Tests -{ - public class RestRequestTests - { - public RestRequestTests() - { - Thread.CurrentThread.CurrentCulture = CultureInfo.InvariantCulture; - Thread.CurrentThread.CurrentUICulture = CultureInfo.InstalledUICulture; - } - - [Test] - public void Can_Add_Object_With_IntegerArray_property() - { - RestRequest request = new RestRequest(); - - request.AddObject(new { Items = new [] { 2, 3, 4 } }); - } - - [Test] - public void Cannot_Set_Empty_Host_Header() - { - RestRequest request = new RestRequest(); - ArgumentException exception = Assert.Throws(() => request.AddHeader("Host", string.Empty)); - - Assert.AreEqual("value", exception.ParamName); - } - - [Test] - [TestCase("http://localhost")] - [TestCase("hostname 1234")] - [TestCase("-leading.hyphen.not.allowed")] - [TestCase("bad:port")] - [TestCase(" no.leading.white-space")] - [TestCase("no.trailing.white-space ")] - [TestCase(".leading.dot.not.allowed")] - [TestCase("double.dots..not.allowed")] - [TestCase(".")] - [TestCase(".:2345")] - [TestCase(":5678")] - [TestCase("")] - [TestCase("foo:bar:baz")] - public void Cannot_Set_Invalid_Host_Header(string value) - { - RestRequest request = new RestRequest(); - ArgumentException exception = Assert.Throws(() => request.AddHeader("Host", value)); - - Assert.AreEqual("value", exception.ParamName); - } - - [Test] - [TestCase("localhost")] - [TestCase("localhost:1234")] - [TestCase("host.local")] - [TestCase("anotherhost.local:2345")] - [TestCase("www.w3.org")] - [TestCase("www.w3.org:3456")] - [TestCase("8.8.8.8")] - [TestCase("a.1.b.2")] - [TestCase("10.20.30.40:1234")] - [TestCase("0host")] - [TestCase("hypenated-hostname")] - [TestCase("multi--hyphens")] - public void Can_Set_Valid_Host_Header(string value) - { - RestRequest request = new RestRequest(); - - Assert.DoesNotThrow(() => request.AddHeader("Host", value)); - } - - [Test] - [TestCase(1, "1")] - [TestCase("1", "1")] - [TestCase("entity", "entity")] - public void Can_Add_Object_To_UrlSegment(object value, string expectedValue) - { - const string ParameterName = "Id"; - RestRequest request = new RestRequest(); - request.AddUrlSegment(ParameterName, value); - - var parameter = request.Parameters.FirstOrDefault(x => x.Name.Equals(ParameterName)); - Assert.IsNotNull(parameter); - Assert.AreEqual(expectedValue, parameter.Value.ToString()); - Assert.AreEqual(ParameterType.UrlSegment, parameter.Type); - } - } -} diff --git a/RestSharp.Tests/RestSharp.Tests.csproj b/RestSharp.Tests/RestSharp.Tests.csproj deleted file mode 100644 index 554b734e3..000000000 --- a/RestSharp.Tests/RestSharp.Tests.csproj +++ /dev/null @@ -1,111 +0,0 @@ - - - net452;netcoreapp2.0 - false - ..\RestSharp.snk - true - - - - - - - - - - - - - - - PreserveNewest - - - PreserveNewest - - - PreserveNewest - - - PreserveNewest - - - PreserveNewest - - - PreserveNewest - - - PreserveNewest - - - PreserveNewest - - - PreserveNewest - - - PreserveNewest - - - PreserveNewest - - - PreserveNewest - - - PreserveNewest - - - PreserveNewest - - - PreserveNewest - - - PreserveNewest - - - PreserveNewest - - - PreserveNewest - - - PreserveNewest - - - PreserveNewest - - - PreserveNewest - - - PreserveNewest - - - PreserveNewest - - - PreserveNewest - - - PreserveNewest - - - PreserveNewest - - - PreserveNewest - - - PreserveNewest - - - PreserveNewest - - - PreserveNewest - - - diff --git a/RestSharp.Tests/SampleClasses/BearerToken.cs b/RestSharp.Tests/SampleClasses/BearerToken.cs deleted file mode 100644 index 0b03ffa35..000000000 --- a/RestSharp.Tests/SampleClasses/BearerToken.cs +++ /dev/null @@ -1,17 +0,0 @@ -using System; -using RestSharp.Deserializers; - -namespace RestSharp.Tests.SampleClasses -{ - public class BearerToken - { - public string AccessToken { get; set; } - public string TokenType { get; set; } - public uint ExpiresIn { get; set; } - public string UserName { get; set; } - [DeserializeAs(Name = ".issued")] - public DateTimeOffset Issued { get; set; } - [DeserializeAs(Name = ".expires")] - public DateTimeOffset Expires { get; set; } - } -} diff --git a/RestSharp.Tests/SampleClasses/BooleanTest.cs b/RestSharp.Tests/SampleClasses/BooleanTest.cs deleted file mode 100644 index 6ba70e851..000000000 --- a/RestSharp.Tests/SampleClasses/BooleanTest.cs +++ /dev/null @@ -1,7 +0,0 @@ -namespace RestSharp.Tests.SampleClasses -{ - public class BooleanTest - { - public bool Value { get; set; } - } -} diff --git a/RestSharp.Tests/SampleClasses/EmployeeTracker.cs b/RestSharp.Tests/SampleClasses/EmployeeTracker.cs deleted file mode 100644 index 02bec0162..000000000 --- a/RestSharp.Tests/SampleClasses/EmployeeTracker.cs +++ /dev/null @@ -1,39 +0,0 @@ -using System.Collections.Generic; - -namespace RestSharp.Tests.SampleClasses -{ - public class EmployeeTracker - { - /// - /// Key: Employee name. - /// Value: Messages sent to employee. - /// - public Dictionary> EmployeesMail { get; set; } - - /// - /// Key: Employee name. - /// Value: Hours worked this each week. - /// - public Dictionary>> EmployeesTime { get; set; } - - /// - /// Key: Employee name. - /// Value: Payments made to employee - /// - public Dictionary> EmployeesPay { get; set; } - } - - public class Payment - { - public PaymentType Type { get; set; } - - public int Amount { get; set; } - } - - public enum PaymentType - { - Bonus, - Monthly, - BiWeekly - } -} diff --git a/RestSharp.Tests/SampleClasses/EnumTest.cs b/RestSharp.Tests/SampleClasses/EnumTest.cs deleted file mode 100644 index 50ce9307b..000000000 --- a/RestSharp.Tests/SampleClasses/EnumTest.cs +++ /dev/null @@ -1,70 +0,0 @@ - -namespace RestSharp.Tests.SampleClasses -{ - public enum ByteEnum : byte - { - EnumMin = 0, - EnumMax = 255 - } - - public enum SByteEnum : sbyte - { - EnumMin = -128, - EnumMax = 127 - } - - public enum ShortEnum : short - { - EnumMin = -32768, - EnumMax = 32767 - } - - public enum UShortEnum : ushort - { - EnumMin = 0, - EnumMax = 65535 - } - - public enum IntEnum - { - EnumMin = -2147483648, - EnumMax = 2147483647 - } - - public enum UIntEnum : uint - { - EnumMin = 0, - EnumMax = 4294967295 - } - - public enum LongEnum : long - { - EnumMin = -9223372036854775808, - EnumMax = 9223372036854775807 - } - - public enum ULongEnum : ulong - { - EnumMin = 0, - EnumMax = 18446744073709551615 - } - - public class JsonEnumTypesTestStructure - { - public ByteEnum ByteEnumType { get; set; } - - public SByteEnum SByteEnumType { get; set; } - - public ShortEnum ShortEnumType { get; set; } - - public UShortEnum UShortEnumType { get; set; } - - public IntEnum IntEnumType { get; set; } - - public UIntEnum UIntEnumType { get; set; } - - public LongEnum LongEnumType { get; set; } - - public ULongEnum ULongEnumType { get; set; } - } -} diff --git a/RestSharp.Tests/SampleClasses/Goodreads.cs b/RestSharp.Tests/SampleClasses/Goodreads.cs deleted file mode 100644 index 7f0109d0a..000000000 --- a/RestSharp.Tests/SampleClasses/Goodreads.cs +++ /dev/null @@ -1,27 +0,0 @@ -using System.Collections.Generic; - -namespace RestSharp.Tests.SampleClasses -{ - public class GoodReadsReviewCollection - { - public int Start { get; set; } - - public int End { get; set; } - - public int Total { get; set; } - - public List Reviews { get; set; } - } - - public class GoodReadsReview - { - public string Id { get; set; } - - public GoodReadsBook Book { get; set; } - } - - public class GoodReadsBook - { - public string Isbn { get; set; } - } -} diff --git a/RestSharp.Tests/SampleClasses/GoogleWeatherWithAttributes.cs b/RestSharp.Tests/SampleClasses/GoogleWeatherWithAttributes.cs deleted file mode 100644 index 19002c2a1..000000000 --- a/RestSharp.Tests/SampleClasses/GoogleWeatherWithAttributes.cs +++ /dev/null @@ -1,75 +0,0 @@ -using System.Collections.Generic; -using RestSharp.Deserializers; - -namespace RestSharp.Tests.SampleClasses -{ - public class GoogleWeatherApi - { - public string Version { get; set; } - - public GoogleWeather Weather { get; set; } - } - - public class GoogleWeather : List - { - public string ModuleId { get; set; } - - public string TabId { get; set; } - - public string MobileRow { get; set; } - - public string MobileZipped { get; set; } - - public string Row { get; set; } - - public string Section { get; set; } - - [DeserializeAs(Name = "forecast_information")] - public ForecastInformation Forecast { get; set; } - - [DeserializeAs(Name = "current_conditions")] - public CurrentConditions Current { get; set; } - } - - public class GoogleDataElement - { - public string Data { get; set; } - } - - public class ForecastInformation - { - public GoogleDataElement City { get; set; } - - public GoogleDataElement PostalCode { get; set; } - - public GoogleDataElement ForecastDate { get; set; } - - public GoogleDataElement UnitSystem { get; set; } - } - - public class CurrentConditions - { - public GoogleDataElement Condition { get; set; } - - public GoogleDataElement TempC { get; set; } - - public GoogleDataElement Humidity { get; set; } - - public GoogleDataElement Icon { get; set; } - - public GoogleDataElement WindCondition { get; set; } - } - - public class ForecastConditions - { - public GoogleDataElement DayOfWeek { get; set; } - - public GoogleDataElement Condition { get; set; } - - public GoogleDataElement Low { get; set; } - - public GoogleDataElement High { get; set; } - - public GoogleDataElement Icon { get; set; } - } -} diff --git a/RestSharp.Tests/SampleClasses/JsonLists.cs b/RestSharp.Tests/SampleClasses/JsonLists.cs deleted file mode 100644 index 0ea41edee..000000000 --- a/RestSharp.Tests/SampleClasses/JsonLists.cs +++ /dev/null @@ -1,11 +0,0 @@ -using System.Collections.Generic; - -namespace RestSharp.Tests.SampleClasses -{ - public class JsonLists - { - public List Names { get; set; } - - public List Numbers { get; set; } - } -} diff --git a/RestSharp.Tests/SampleClasses/Lastfm.cs b/RestSharp.Tests/SampleClasses/Lastfm.cs deleted file mode 100644 index 56e57eb79..000000000 --- a/RestSharp.Tests/SampleClasses/Lastfm.cs +++ /dev/null @@ -1,53 +0,0 @@ -using System; -using System.Collections.Generic; - -namespace RestSharp.Tests.SampleClasses.Lastfm -{ - public class Event : LastfmBase - { - public string id { get; set; } - - public string title { get; set; } - - public EventArtistList artists { get; set; } - - public Venue venue { get; set; } - - public DateTime startDate { get; set; } - - public string description { get; set; } - - public int attendance { get; set; } - - public int reviews { get; set; } - - public string tag { get; set; } - - public string url { get; set; } - - public string headliner { get; set; } - - public int cancelled { get; set; } - } - - public class EventArtistList : List { } - - public class artist - { - public string Value { get; set; } - } - - public abstract class LastfmBase - { - public string status { get; set; } - - public Error error { get; set; } - } - - public class Error - { - public string Value { get; set; } - - public int code { get; set; } - } -} diff --git a/RestSharp.Tests/SampleClasses/ListSamples.cs b/RestSharp.Tests/SampleClasses/ListSamples.cs deleted file mode 100644 index 888f210da..000000000 --- a/RestSharp.Tests/SampleClasses/ListSamples.cs +++ /dev/null @@ -1,48 +0,0 @@ -using System.Collections.Generic; - -namespace RestSharp.Tests.SampleClasses -{ - public class SimpleTypesListSample - { - public List Names { get; set; } - - public List Numbers { get; set; } - } - - public class InlineListSample - { - public int Count { get; set; } - - public List images { get; set; } - - public List Images { get; set; } - } - - public class NestedListSample - { - public List images { get; set; } - - public List Images { get; set; } - } - - public class EmptyListSample - { - public List images { get; set; } - - public List Images { get; set; } - } - - public class Image - { - public string Src { get; set; } - - public string Value { get; set; } - } - - public class image - { - public string Src { get; set; } - - public string Value { get; set; } - } -} diff --git a/RestSharp.Tests/SampleClasses/Oddball.cs b/RestSharp.Tests/SampleClasses/Oddball.cs deleted file mode 100644 index 9fb272c75..000000000 --- a/RestSharp.Tests/SampleClasses/Oddball.cs +++ /dev/null @@ -1,13 +0,0 @@ -namespace RestSharp.Tests.SampleClasses -{ - [Deserializers.DeserializeAs(Name = "oddballRootName")] - public class Oddball - { - public string Sid { get; set; } - - public string FriendlyName { get; set; } - - [Deserializers.DeserializeAs(Name = "oddballPropertyName")] - public string GoodPropertyName { get; set; } - } -} diff --git a/RestSharp.Tests/SampleClasses/SOUser.cs b/RestSharp.Tests/SampleClasses/SOUser.cs deleted file mode 100644 index c2b490cc7..000000000 --- a/RestSharp.Tests/SampleClasses/SOUser.cs +++ /dev/null @@ -1,31 +0,0 @@ -namespace RestSharp.Tests.SampleClasses -{ - public class SoUser - { - public int Id { get; set; } - - public int Reputation { get; set; } - - public long CreationDate { get; set; } - - public string DisplayName { get; set; } - - public string EmailHash { get; set; } - - public string Age { get; set; } - - public long LastAccessDate { get; set; } - - public string WebsiteUrl { get; set; } - - public string Location { get; set; } - - public string AboutMe { get; set; } - - public int Views { get; set; } - - public int UpVotes { get; set; } - - public int DownVotes { get; set; } - } -} diff --git a/RestSharp.Tests/SampleClasses/Struct.cs b/RestSharp.Tests/SampleClasses/Struct.cs deleted file mode 100644 index e09f74817..000000000 --- a/RestSharp.Tests/SampleClasses/Struct.cs +++ /dev/null @@ -1,11 +0,0 @@ -namespace RestSharp.Tests.SampleClasses -{ - public struct SimpleStruct - { - public string One { get; set; } - - public string Two { get; set; } - - public int Three { get; set; } - } -} diff --git a/RestSharp.Tests/SampleClasses/TwilioCallList.cs b/RestSharp.Tests/SampleClasses/TwilioCallList.cs deleted file mode 100644 index c245679f3..000000000 --- a/RestSharp.Tests/SampleClasses/TwilioCallList.cs +++ /dev/null @@ -1,16 +0,0 @@ -using System.Collections.Generic; - -namespace RestSharp.Tests.SampleClasses -{ - public class TwilioCallList : List - { - public int Page { get; set; } - - public int NumPages { get; set; } - } - - public class Call - { - public string Sid { get; set; } - } -} diff --git a/RestSharp.Tests/SampleClasses/eventful.cs b/RestSharp.Tests/SampleClasses/eventful.cs deleted file mode 100644 index 49eb479bb..000000000 --- a/RestSharp.Tests/SampleClasses/eventful.cs +++ /dev/null @@ -1,138 +0,0 @@ -using System; -using System.Collections.Generic; - -namespace RestSharp.Tests.SampleClasses -{ - public class VenueSearch - { - public string total_items { get; set; } - - public string page_size { get; set; } - - public string page_count { get; set; } - - public string page_number { get; set; } - - public string page_items { get; set; } - - public string first_item { get; set; } - - public string last_item { get; set; } - - public string search_time { get; set; } - - public List venues { get; set; } - } - - public class PerformerSearch - { - public string total_items { get; set; } - - public string page_size { get; set; } - - public string page_count { get; set; } - - public string page_number { get; set; } - - public string page_items { get; set; } - - public string first_item { get; set; } - - public string last_item { get; set; } - - public string search_time { get; set; } - - public List performers { get; set; } - } - - public class Performer - { - public string id { get; set; } - - public string url { get; set; } - - public string name { get; set; } - - public string short_bio { get; set; } - - public DateTime? created { get; set; } - - public string creator { get; set; } - - public string demand_count { get; set; } - - public string demand_member_count { get; set; } - - public string event_count { get; set; } - - public ServiceImage image { get; set; } - } - - public class Venue - { - public string id { get; set; } - - public string url { get; set; } - - public string name { get; set; } - - public string venue_name { get; set; } - - public string description { get; set; } - - public string venue_type { get; set; } - - public string address { get; set; } - - public string city_name { get; set; } - - public string region_name { get; set; } - - public string postal_code { get; set; } - - public string country_name { get; set; } - - public string longitude { get; set; } - - public string latitude { get; set; } - - public string event_count { get; set; } - } - - public class ServiceImage - { - public ServiceImage1 thumb { get; set; } - - public ServiceImage1 small { get; set; } - - public ServiceImage1 medium { get; set; } - } - - public class ServiceImage1 - { - public string url { get; set; } - - public string width { get; set; } - - public string height { get; set; } - } - - public class Event - { - public string id { get; set; } - - public string url { get; set; } - - public string title { get; set; } - - public string description { get; set; } - - public string start_time { get; set; } - - public string venue_name { get; set; } - - public string venue_id { get; set; } - - public List performers { get; set; } - } -} diff --git a/RestSharp.Tests/SampleClasses/foursq.cs b/RestSharp.Tests/SampleClasses/foursq.cs deleted file mode 100644 index 43f84f24e..000000000 --- a/RestSharp.Tests/SampleClasses/foursq.cs +++ /dev/null @@ -1,14 +0,0 @@ -using System.Collections.Generic; - -namespace RestSharp.Tests.SampleClasses -{ - public class VenuesResponse - { - public List Groups { get; set; } - } - - public class Group - { - public string Name { get; set; } - } -} diff --git a/RestSharp.Tests/SampleClasses/googleweather.cs b/RestSharp.Tests/SampleClasses/googleweather.cs deleted file mode 100644 index c3c0969f3..000000000 --- a/RestSharp.Tests/SampleClasses/googleweather.cs +++ /dev/null @@ -1,74 +0,0 @@ -using System.Collections.Generic; - -namespace RestSharp.Tests.SampleClasses -{ - public class xml_api_reply - { - public string version { get; set; } - - public Weather weather { get; set; } - } - - public class Weather : List - { - public string module_id { get; set; } - - public string tab_id { get; set; } - - public string mobile_row { get; set; } - - public string mobile_zipped { get; set; } - - public string row { get; set; } - - public string section { get; set; } - - public Forecast_information forecast_information { get; set; } - - public Current_conditions current_conditions { get; set; } - - //public T forecast_conditions { get; set; } - } - - public class DataElement - { - public string data { get; set; } - } - - public class Forecast_information - { - public DataElement city { get; set; } - - public DataElement postal_code { get; set; } - - public DataElement forecast_date { get; set; } - - public DataElement unit_system { get; set; } - } - - public class Current_conditions - { - public DataElement condition { get; set; } - - public DataElement temp_c { get; set; } - - public DataElement humidity { get; set; } - - public DataElement icon { get; set; } - - public DataElement wind_condition { get; set; } - } - - public class forecast_conditions - { - public DataElement day_of_week { get; set; } - - public DataElement condition { get; set; } - - public DataElement low { get; set; } - - public DataElement high { get; set; } - - public DataElement icon { get; set; } - } -} diff --git a/RestSharp.Tests/SampleClasses/misc.cs b/RestSharp.Tests/SampleClasses/misc.cs deleted file mode 100644 index b78b13066..000000000 --- a/RestSharp.Tests/SampleClasses/misc.cs +++ /dev/null @@ -1,308 +0,0 @@ -#region Licensed - -// Copyright 2010 John Sheehan -// -// Licensed under the Apache License, Version 2.0 (the "License"); -// you may not use this file except in compliance with the License. -// You may obtain a copy of the License at -// -// http://www.apache.org/licenses/LICENSE-2.0 -// -// Unless required by applicable law or agreed to in writing, software -// distributed under the License is distributed on an "AS IS" BASIS, -// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -// See the License for the specific language governing permissions and -// limitations under the License. - -#endregion - -using System; -using System.Collections.Generic; -using RestSharp.Serializers; - -namespace RestSharp.Tests.SampleClasses -{ - public class PersonForXml - { - public string Name { get; set; } - - public DateTime StartDate { get; set; } - - public int Age { get; set; } - - public decimal Percent { get; set; } - - public long BigNumber { get; set; } - - public bool IsCool { get; set; } - - public List Friends { get; set; } - - public Friend BestFriend { get; set; } - - protected string Ignore { get; set; } - - public string IgnoreProxy - { - get { return this.Ignore; } - } - - protected string ReadOnly - { - get { return null; } - } - - public string ReadOnlyProxy - { - get { return this.ReadOnly; } - } - - public FoeList Foes { get; set; } - - public Guid UniqueId { get; set; } - - public Guid EmptyGuid { get; set; } - - public Uri Url { get; set; } - - public Uri UrlPath { get; set; } - - public Order Order { get; set; } - - public Disposition Disposition { get; set; } - - public Band FavoriteBand { get; set; } - - public class Band - { - public string Name { get; set; } - } - } - - public class ValueCollectionForXml - { - public string Value { get; set; } - public List Values { get; set; } - } - - public class ValueForXml - { - public DateTime Timestamp { get; set; } - public string Value { get; set; } - } - - public class IncomingInvoice - { - public int ConceptId { get; set; } - } - - public class PersonForJson - { - public string Name { get; set; } - - public DateTime StartDate { get; set; } - - public int Age { get; set; } - - public decimal Percent { get; set; } - - public long BigNumber { get; set; } - - public bool IsCool { get; set; } - - public List Friends { get; set; } - - public Friend BestFriend { get; set; } - - public Guid Guid { get; set; } - - public Guid EmptyGuid { get; set; } - - public Uri Url { get; set; } - - public Uri UrlPath { get; set; } - - protected string Ignore { get; set; } - - public string IgnoreProxy - { - get { return this.Ignore; } - } - - protected string ReadOnly - { - get { return null; } - } - - public string ReadOnlyProxy - { - get { return this.ReadOnly; } - } - - public Dictionary Foes { get; set; } - - public Order Order { get; set; } - - public Disposition Disposition { get; set; } - } - - public enum Order - { - First, - - Second, - - Third - } - - public enum Disposition - { - Friendly, - - SoSo, - - SteerVeryClear - } - - public class Friend - { - public string Name { get; set; } - - public int Since { get; set; } - } - - public class Foe - { - public string Nickname { get; set; } - } - - public class FoeList : List - { - public string Team { get; set; } - } - - public class Birthdate - { - public DateTime Value { get; set; } - } - - public class OrderedProperties - { - [SerializeAs(Index = 2)] - public string Name { get; set; } - - [SerializeAs(Index = 3)] - public int Age { get; set; } - - [SerializeAs(Index = 1)] - public DateTime StartDate { get; set; } - } - - public class ObjectProperties - { - public object ObjectProperty { get; set; } - } - - public class DatabaseCollection : List { } - - public class Database - { - public string Name { get; set; } - - public string InitialCatalog { get; set; } - - public string DataSource { get; set; } - } - - public class Generic - { - public T Data { get; set; } - } - - public class GenericWithList - { - public List Items { get; set; } - } - - public class GuidList - { - public List Ids { get; set; } - } - - public class DateTimeTestStructure - { - public DateTime DateTime { get; set; } - - public DateTime? NullableDateTimeWithNull { get; set; } - - public DateTime? NullableDateTimeWithValue { get; set; } - - public DateTimeOffset DateTimeOffset { get; set; } - - public DateTimeOffset? NullableDateTimeOffsetWithNull { get; set; } - - public DateTimeOffset? NullableDateTimeOffsetWithValue { get; set; } - } - - public class Iso8601DateTimeTestStructure - { - public DateTime DateTimeLocal { get; set; } - - public DateTime DateTimeUtc { get; set; } - - public DateTime DateTimeWithOffset { get; set; } - } - - public class TimeSpanTestStructure - { - public TimeSpan Tick { get; set; } - - public TimeSpan Millisecond { get; set; } - - public TimeSpan Second { get; set; } - - public TimeSpan Minute { get; set; } - - public TimeSpan Hour { get; set; } - - public TimeSpan? NullableWithoutValue { get; set; } - - public TimeSpan? NullableWithValue { get; set; } - - public TimeSpan? IsoSecond { get; set; } - - public TimeSpan? IsoMinute { get; set; } - - public TimeSpan? IsoHour { get; set; } - - public TimeSpan? IsoDay { get; set; } - - public TimeSpan? IsoMonth { get; set; } - - public TimeSpan? IsoYear { get; set; } - } - - public class JsonEnumsTestStructure - { - public Disposition Upper { get; set; } - - public Disposition Lower { get; set; } - - public Disposition CamelCased { get; set; } - - public Disposition Underscores { get; set; } - - public Disposition LowerUnderscores { get; set; } - - public Disposition Dashes { get; set; } - - public Disposition LowerDashes { get; set; } - - public Disposition Integer { get; set; } - } - - public class DecimalNumber - { - public decimal Value { get; set; } - } -} diff --git a/RestSharp.Tests/SampleClasses/nullables.cs b/RestSharp.Tests/SampleClasses/nullables.cs deleted file mode 100644 index 4865a56d9..000000000 --- a/RestSharp.Tests/SampleClasses/nullables.cs +++ /dev/null @@ -1,13 +0,0 @@ -using System; - -namespace RestSharp.Tests.SampleClasses -{ - public class NullableValues - { - public int? Id { get; set; } - - public DateTime? StartDate { get; set; } - - public Guid? UniqueId { get; set; } - } -} diff --git a/RestSharp.Tests/SampleClasses/twitter.cs b/RestSharp.Tests/SampleClasses/twitter.cs deleted file mode 100644 index 1383f4ee3..000000000 --- a/RestSharp.Tests/SampleClasses/twitter.cs +++ /dev/null @@ -1,119 +0,0 @@ -using System.Collections.Generic; -using RestSharp.Deserializers; - -namespace RestSharp.Tests.SampleClasses -{ - public class status - { - public bool truncated { get; set; } - - public string created_at { get; set; } - - public string source { get; set; } - - public bool favorited { get; set; } - - public string in_reply_to_user_id { get; set; } - - public string in_reply_to_status_id { get; set; } - - public string in_reply_to_screen_name { get; set; } - - // ignore contributors for now - public user user { get; set; } - - // ignore geo - public long id { get; set; } - - public string text { get; set; } - } - - public class user - { - public string url { get; set; } - - public string description { get; set; } - - public string profile_text_color { get; set; } - - public int followers_count { get; set; } - - public int statuses_count { get; set; } - - public bool geo_enabled { get; set; } - - public string profile_background_image_url { get; set; } - - public bool notifications { get; set; } - - public string created_at { get; set; } - - public int friends_count { get; set; } - - public string profile_link_color { get; set; } - - public bool contributors_enabled { get; set; } - - public bool profile_background_tile { get; set; } - - public int favourites_count { get; set; } - - public string profile_background_color { get; set; } - - public string profile_image_url { get; set; } - - public string lang { get; set; } - - public bool verified { get; set; } - - public string profile_sidebar_fill_color { get; set; } - - public bool @protected { get; set; } - - public string screen_name { get; set; } - - public bool following { get; set; } - - public string location { get; set; } - - public string name { get; set; } - - public string time_zone { get; set; } - - public string profile_sidebar_border_color { get; set; } - - public long id { get; set; } - - public int utc_offset { get; set; } - } - - public class StatusList : List { } - - public class complexStatus - { - public bool truncated { get; set; } - - public string created_at { get; set; } - - public string source { get; set; } - - public bool favorited { get; set; } - - public string in_reply_to_user_id { get; set; } - - public string in_reply_to_status_id { get; set; } - - public string in_reply_to_screen_name { get; set; } - - // ignore contributors for now - [DeserializeAs(Name = "user.following")] - public bool follow { get; set; } - - // ignore geo - public long id { get; set; } - - public string text { get; set; } - } - - public class StatusComplexList : List { } -} diff --git a/RestSharp.Tests/SampleData/Lastfm.xml b/RestSharp.Tests/SampleData/Lastfm.xml deleted file mode 100644 index a14a0d218..000000000 --- a/RestSharp.Tests/SampleData/Lastfm.xml +++ /dev/null @@ -1,46 +0,0 @@ - - - 328799 - Philip Glass - - Philip Glass - Orchestra and Chorus of Erfurt Theatre - Philip Glass - - - 8777860 - Barbican Centre - - London - United Kingdom - Silk Street - EC2Y 8DS - - 51.520099 - -0.093609 - - - http://www.last.fm/venue/8777860+Barbican+Centre - http://www.barbican.org.uk - - http://userserve-ak.last.fm/serve/34/418510.jpg - http://userserve-ak.last.fm/serve/64/418510.jpg - http://userserve-ak.last.fm/serve/126/418510.jpg - http://userserve-ak.last.fm/serve/252/418510.jpg - http://userserve-ak.last.fm/serve/500/418510/Barbican+Centre.jpg - - Thu, 12 Jun 2008 19:30:00 - - http://userserve-ak.last.fm/serve/34/39466081.png - http://userserve-ak.last.fm/serve/64/39466081.png - http://userserve-ak.last.fm/serve/126/39466081.png - http://userserve-ak.last.fm/serve/252/39466081.png - 48 - 0 - lastfm:event=328799 - http://www.last.fm/event/328799+Philip+Glass+at+Barbican+Centre+on+12+June+2008 - - - 0 - - diff --git a/RestSharp.Tests/SampleData/underscore_prefix.txt b/RestSharp.Tests/SampleData/underscore_prefix.txt deleted file mode 100644 index 9e895fed5..000000000 --- a/RestSharp.Tests/SampleData/underscore_prefix.txt +++ /dev/null @@ -1,18 +0,0 @@ -{ - "User":{ - "_id":1786, - "_displayName":"John Sheehan", - "Reputation":18332, - "CreationDate":1219071163, - "_displayName":"John Sheehan", - "EmailHash":"lkdsafadfjsadfkjlsdjflkjdsf", - "Age":"28", - "LastAccessDate":1269715453, - "WebsiteUrl":"http://john-sheehan.com/blog", - "Location":"Minnesota", - "AboutMe":"

Follow me on Twitter

\r\n\r\n

Read my blog

\r\n\r\n

Visit managedassembly.com - A community for .NET developers.

\r\n\r\n

I am the founder of RIM Systems, maker of SnapLeague, a web-based league management system for recreational athletics.

", - "Views":1639, - "UpVotes":1665, - "DownVotes":427 - } -} \ No newline at end of file diff --git a/RestSharp.Tests/SerializerTests.cs b/RestSharp.Tests/SerializerTests.cs deleted file mode 100644 index f872e7910..000000000 --- a/RestSharp.Tests/SerializerTests.cs +++ /dev/null @@ -1,460 +0,0 @@ -#region License - -// Copyright 2010 John Sheehan -// -// Licensed under the Apache License, Version 2.0 (the "License"); -// you may not use this file except in compliance with the License. -// You may obtain a copy of the License at -// -// http://www.apache.org/licenses/LICENSE-2.0 -// -// Unless required by applicable law or agreed to in writing, software -// distributed under the License is distributed on an "AS IS" BASIS, -// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -// See the License for the specific language governing permissions and -// limitations under the License. - -#endregion - -using System; -using System.Collections.Generic; -using System.Globalization; -using System.Threading; -using System.Xml.Linq; -using NUnit.Framework; -using RestSharp.Serializers; -using RestSharp.Tests.SampleClasses; - -namespace RestSharp.Tests -{ - [TestFixture] - public class SerializerTests - { - public SerializerTests() - { - Thread.CurrentThread.CurrentCulture = CultureInfo.InvariantCulture; - Thread.CurrentThread.CurrentUICulture = CultureInfo.InstalledUICulture; - } - - [Test] - public void Serializes_Properties_In_Specified_Order() - { - OrderedProperties ordered = new OrderedProperties - { - Name = "Name", - Age = 99, - StartDate = new DateTime(2010, 1, 1) - }; - XmlSerializer xml = new XmlSerializer(); - string doc = xml.Serialize(ordered); - XDocument expected = GetSortedPropsXDoc(); - - Assert.AreEqual(expected.ToString(), doc); - } - - [Test] - public void Can_serialize_simple_POCO() - { - Person poco = new Person - { - Name = "Foo", - Age = 50, - Price = 19.95m, - StartDate = new DateTime(2009, 12, 18, 10, 2, 23), - Items = new List - { - new Item { Name = "One", Value = 1 }, - new Item { Name = "Two", Value = 2 }, - new Item { Name = "Three", Value = 3 } - } - }; - XmlSerializer xml = new XmlSerializer(); - string doc = xml.Serialize(poco); - XDocument expected = GetSimplePocoXDoc(); - - Assert.AreEqual(expected.ToString(), doc); - } - - [Test] - public void Can_serialize_Enum() - { - ClassWithEnum enumClass = new ClassWithEnum { Color = Color.Red }; - XmlSerializer xml = new XmlSerializer(); - string doc = xml.Serialize(enumClass); - XDocument expected = new XDocument(); - XElement root = new XElement("ClassWithEnum"); - - root.Add(new XElement("Color", "Red")); - expected.Add(root); - - Assert.AreEqual(expected.ToString(), doc); - } - - [Test] - public void Can_serialize_simple_POCO_With_DateFormat_Specified() - { - Person poco = new Person - { - Name = "Foo", - Age = 50, - Price = 19.95m, - StartDate = new DateTime(2009, 12, 18, 10, 2, 23) - }; - XmlSerializer xml = new XmlSerializer { DateFormat = DateFormat.ISO_8601 }; - string doc = xml.Serialize(poco); - XDocument expected = GetSimplePocoXDocWithIsoDate(); - - Assert.AreEqual(expected.ToString(), doc); - } - - [Test] - public void Can_serialize_simple_POCO_With_XmlFormat_Specified() - { - Person poco = new Person - { - Name = "Foo", - Age = 50, - Price = 19.95m, - StartDate = new DateTime(2009, 12, 18, 10, 2, 23), - IsCool = false - }; - XmlSerializer xml = new XmlSerializer { DateFormat = DateFormat.ISO_8601 }; - string doc = xml.Serialize(poco); - XDocument expected = GetSimplePocoXDocWithXmlProperty(); - - Assert.AreEqual(expected.ToString(), doc); - } - - [Test] - public void Can_serialize_simple_POCO_With_Different_Root_Element() - { - Person poco = new Person - { - Name = "Foo", - Age = 50, - Price = 19.95m, - StartDate = new DateTime(2009, 12, 18, 10, 2, 23) - }; - XmlSerializer xml = new XmlSerializer { RootElement = "Result" }; - string doc = xml.Serialize(poco); - XDocument expected = GetSimplePocoXDocWithRoot(); - - Assert.AreEqual(expected.ToString(), doc); - } - - [Test] - public void Can_serialize_simple_POCO_With_Attribute_Options_Defined() - { - WackyPerson poco = new WackyPerson - { - Name = "Foo", - Age = 50, - Price = 19.95m, - StartDate = new DateTime(2009, 12, 18, 10, 2, 23) - }; - XmlSerializer xml = new XmlSerializer(); - string doc = xml.Serialize(poco); - XDocument expected = GetSimplePocoXDocWackyNames(); - - Assert.AreEqual(expected.ToString(), doc); - } - - [Test] - public void Can_serialize_simple_POCO_With_Attribute_Options_Defined_And_Property_Containing_IList_Elements() - { - WackyPerson poco = new WackyPerson - { - Name = "Foo", - Age = 50, - Price = 19.95m, - StartDate = new DateTime(2009, 12, 18, 10, 2, 23), - ContactData = new ContactData - { - EmailAddresses = new List - { - new EmailAddress - { - Address = "test@test.com", - Location = "Work" - } - } - } - }; - XmlSerializer xml = new XmlSerializer(); - string doc = xml.Serialize(poco); - XDocument expected = GetSimplePocoXDocWackyNamesWithIListProperty(); - - Assert.AreEqual(expected.ToString(), doc); - } - - [Test] - public void Can_serialize_a_list_which_is_the_root_element() - { - PersonList pocoList = new PersonList - { - new Person - { - Name = "Foo", - Age = 50, - Price = 19.95m, - StartDate = new DateTime(2009, 12, 18, 10, 2, 23), - Items = new List - { - new Item { Name = "One", Value = 1 }, - new Item { Name = "Two", Value = 2 }, - new Item { Name = "Three", Value = 3 } - } - }, - new Person - { - Name = "Bar", - Age = 23, - Price = 23.23m, - StartDate = new DateTime(2009, 12, 23, 10, 23, 23), - Items = new List - { - new Item { Name = "One", Value = 1 }, - new Item { Name = "Two", Value = 2 }, - new Item { Name = "Three", Value = 3 } - } - } - }; - XmlSerializer xml = new XmlSerializer(); - string doc = xml.Serialize(pocoList); - XDocument expected = GetPeopleXDoc(CultureInfo.InvariantCulture); - - Assert.AreEqual(expected.ToString(), doc); - } - - private class Person - { - public string Name { get; set; } - - public int Age { get; set; } - - public decimal Price { get; set; } - - public DateTime StartDate { get; set; } - - public List Items { get; set; } - - public bool? IsCool { get; set; } - } - - private class Item - { - public string Name { get; set; } - - public int Value { get; set; } - } - - private enum Color - { - Red, - - Blue, - - Green - } - - private class ClassWithEnum - { - public Color Color { get; set; } - } - - [SerializeAs(Name = "Person")] - private class WackyPerson - { - [SerializeAs(Name = "WackyName", Attribute = true)] - public string Name { get; set; } - - public int Age { get; set; } - - [SerializeAs(Attribute = true)] - public decimal Price { get; set; } - - [SerializeAs(Name = "start_date", Attribute = true)] - public DateTime StartDate { get; set; } - - [SerializeAs(Name = "contact-data")] - public ContactData ContactData { get; set; } - } - - [SerializeAs(Name = "People")] - private class PersonList : List { } - - private class ContactData - { - public ContactData() - { - this.EmailAddresses = new List(); - } - - [SerializeAs(Name = "email-addresses")] - public List EmailAddresses { get; set; } - } - - [SerializeAs(Name = "email-address")] - private class EmailAddress - { - [SerializeAs(Name = "address")] - public string Address { get; set; } - - [SerializeAs(Name = "location")] - public string Location { get; set; } - } - - private static XDocument GetSimplePocoXDoc() - { - XDocument doc = new XDocument(); - XElement root = new XElement("Person"); - - root.Add(new XElement("Name", "Foo"), - new XElement("Age", 50), - new XElement("Price", 19.95m), - new XElement("StartDate", new DateTime(2009, 12, 18, 10, 2, 23).ToString(CultureInfo.InvariantCulture))); - - XElement items = new XElement("Items"); - - items.Add(new XElement("Item", new XElement("Name", "One"), new XElement("Value", 1))); - items.Add(new XElement("Item", new XElement("Name", "Two"), new XElement("Value", 2))); - items.Add(new XElement("Item", new XElement("Name", "Three"), new XElement("Value", 3))); - - root.Add(items); - doc.Add(root); - - return doc; - } - - private static XDocument GetSimplePocoXDocWithIsoDate() - { - XDocument doc = new XDocument(); - XElement root = new XElement("Person"); - - root.Add(new XElement("Name", "Foo"), - new XElement("Age", 50), - new XElement("Price", 19.95m), - new XElement("StartDate", new DateTime(2009, 12, 18, 10, 2, 23).ToString("s"))); - - doc.Add(root); - - return doc; - } - - private static XDocument GetSimplePocoXDocWithXmlProperty() - { - XDocument doc = new XDocument(); - XElement root = new XElement("Person"); - - root.Add(new XElement("Name", "Foo"), - new XElement("Age", 50), - new XElement("Price", 19.95m), - new XElement("StartDate", new DateTime(2009, 12, 18, 10, 2, 23).ToString("s")), - new XElement("IsCool", false)); - - doc.Add(root); - - return doc; - } - - private static XDocument GetSimplePocoXDocWithRoot() - { - XDocument doc = new XDocument(); - XElement root = new XElement("Result"); - XElement start = new XElement("Person"); - - start.Add(new XElement("Name", "Foo"), - new XElement("Age", 50), - new XElement("Price", 19.95m), - new XElement("StartDate", new DateTime(2009, 12, 18, 10, 2, 23).ToString(CultureInfo.InvariantCulture))); - - root.Add(start); - doc.Add(root); - - return doc; - } - - private static XDocument GetSimplePocoXDocWackyNames() - { - XDocument doc = new XDocument(); - XElement root = new XElement("Person"); - - root.Add(new XAttribute("WackyName", "Foo"), - new XElement("Age", 50), - new XAttribute("Price", 19.95m), - new XAttribute("start_date", new DateTime(2009, 12, 18, 10, 2, 23).ToString(CultureInfo.InvariantCulture))); - - doc.Add(root); - - return doc; - } - - private static XDocument GetSimplePocoXDocWackyNamesWithIListProperty() - { - XDocument doc = new XDocument(); - XElement root = new XElement("Person"); - - root.Add(new XAttribute("WackyName", "Foo"), - new XElement("Age", 50), - new XAttribute("Price", 19.95m), - new XAttribute("start_date", - new DateTime(2009, 12, 18, 10, 2, 23).ToString(CultureInfo.InvariantCulture)), - new XElement("contact-data", - new XElement("email-addresses", - new XElement("email-address", - new XElement("address", "test@test.com"), - new XElement("location", "Work"))))); - - doc.Add(root); - - return doc; - } - - private static XDocument GetSortedPropsXDoc() - { - XDocument doc = new XDocument(); - XElement root = new XElement("OrderedProperties"); - - root.Add(new XElement("StartDate", new DateTime(2010, 1, 1).ToString(CultureInfo.InvariantCulture))); - root.Add(new XElement("Name", "Name")); - root.Add(new XElement("Age", 99)); - - doc.Add(root); - - return doc; - } - - private static XDocument GetPeopleXDoc(IFormatProvider culture) - { - XDocument doc = new XDocument(); - XElement root = new XElement("People"); - XElement element = new XElement("Person"); - XElement items = new XElement("Items"); - - items.Add(new XElement("Item", new XElement("Name", "One"), new XElement("Value", 1))); - items.Add(new XElement("Item", new XElement("Name", "Two"), new XElement("Value", 2))); - items.Add(new XElement("Item", new XElement("Name", "Three"), new XElement("Value", 3))); - - element.Add(new XElement("Name", "Foo"), - new XElement("Age", 50), - new XElement("Price", 19.95m.ToString(culture)), - new XElement("StartDate", new DateTime(2009, 12, 18, 10, 2, 23).ToString(culture))); - - element.Add(items); - root.Add(element); - element = new XElement("Person"); - - element.Add(new XElement("Name", "Bar"), - new XElement("Age", 23), - new XElement("Price", 23.23m.ToString(culture)), - new XElement("StartDate", new DateTime(2009, 12, 23, 10, 23, 23).ToString(culture))); - - element.Add(items); - - root.Add(element); - doc.Add(root); - - return doc; - } - } -} diff --git a/RestSharp.Tests/SimpleJson.cs b/RestSharp.Tests/SimpleJson.cs deleted file mode 100644 index 9cbf43338..000000000 --- a/RestSharp.Tests/SimpleJson.cs +++ /dev/null @@ -1,2127 +0,0 @@ -//----------------------------------------------------------------------- -// -// Copyright (c) 2011, The Outercurve Foundation. -// -// Licensed under the MIT License (the "License"); -// you may not use this file except in compliance with the License. -// You may obtain a copy of the License at -// http://www.opensource.org/licenses/mit-license.php -// -// Unless required by applicable law or agreed to in writing, software -// distributed under the License is distributed on an "AS IS" BASIS, -// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -// See the License for the specific language governing permissions and -// limitations under the License. -// -// Nathan Totten (ntotten.com), Jim Zimmerman (jimzimmerman.com) and Prabir Shrestha (prabir.me) -// https://github.com/facebook-csharp-sdk/simple-json -//----------------------------------------------------------------------- - -// VERSION: 0.38.0 - -// NOTE: uncomment the following line to make SimpleJson class internal. -//#define SIMPLE_JSON_INTERNAL - -// NOTE: uncomment the following line to make JsonArray and JsonObject class internal. -//#define SIMPLE_JSON_OBJARRAYINTERNAL - -// NOTE: uncomment the following line to enable dynamic support. -//#define SIMPLE_JSON_DYNAMIC - -// NOTE: uncomment the following line to enable DataContract support. -//#define SIMPLE_JSON_DATACONTRACT - -// NOTE: uncomment the following line to enable IReadOnlyCollection and IReadOnlyList support. -//#define SIMPLE_JSON_READONLY_COLLECTIONS - -// NOTE: uncomment the following line to disable linq expressions/compiled lambda (better performance) instead of method.invoke(). -// define if you are using .net framework <= 3.0 or < WP7.5 -//#define SIMPLE_JSON_NO_LINQ_EXPRESSION - -// NOTE: uncomment the following line if you are compiling under Window Metro style application/library. -// usually already defined in properties -//#define NETFX_CORE; - -// If you are targetting WinStore, WP8 and NET4.5+ PCL make sure to #define SIMPLE_JSON_TYPEINFO; - -// original json parsing code from http://techblog.procurios.nl/k/618/news/view/14605/14863/How-do-I-write-my-own-parser-for-JSON.html - -#if NETFX_CORE -#define SIMPLE_JSON_TYPEINFO -#endif - -using System; -using System.CodeDom.Compiler; -using System.Collections; -using System.Collections.Generic; -#if !SIMPLE_JSON_NO_LINQ_EXPRESSION -using System.Linq.Expressions; -#endif -using System.ComponentModel; -using System.Diagnostics.CodeAnalysis; -#if SIMPLE_JSON_DYNAMIC -using System.Dynamic; -#endif -using System.Globalization; -using System.Reflection; -using System.Runtime.Serialization; -using System.Text; -using RestSharp.Tests.Reflection; - -// ReSharper disable LoopCanBeConvertedToQuery -// ReSharper disable RedundantExplicitArrayCreation -// ReSharper disable SuggestUseVarKeywordEvident -namespace RestSharp.Tests -{ - /// - /// Represents the json array. - /// - [GeneratedCode("simple-json", "1.0.0")] - [EditorBrowsable(EditorBrowsableState.Never)] - [SuppressMessage("Microsoft.Naming", "CA1710:IdentifiersShouldHaveCorrectSuffix")] -#if SIMPLE_JSON_OBJARRAYINTERNAL - internal -#else - public -#endif - class JsonArray : List - { - /// - /// Initializes a new instance of the class. - /// - public JsonArray() { } - - /// - /// Initializes a new instance of the class. - /// - /// The capacity of the json array. - public JsonArray(int capacity) : base(capacity) { } - - /// - /// The json representation of the array. - /// - /// The json representation of the array. - public override string ToString() - { - return SimpleJson.SerializeObject(this) ?? string.Empty; - } - } - - /// - /// Represents the json object. - /// - [GeneratedCode("simple-json", "1.0.0")] - [EditorBrowsable(EditorBrowsableState.Never)] - [SuppressMessage("Microsoft.Naming", "CA1710:IdentifiersShouldHaveCorrectSuffix")] -#if SIMPLE_JSON_OBJARRAYINTERNAL - internal -#else - public -#endif - class JsonObject : -#if SIMPLE_JSON_DYNAMIC - DynamicObject, -#endif - IDictionary - { - /// - /// The internal member dictionary. - /// - private readonly Dictionary _members; - - /// - /// Initializes a new instance of . - /// - public JsonObject() - { - _members = new Dictionary(); - } - - /// - /// Initializes a new instance of . - /// - /// The implementation to use when comparing keys, or null to use the default for the type of the key. - public JsonObject(IEqualityComparer comparer) - { - _members = new Dictionary(comparer); - } - - /// - /// Gets the at the specified index. - /// - /// - public object this[int index] - { - get { return GetAtIndex(_members, index); } - } - - internal static object GetAtIndex(IDictionary obj, int index) - { - if (obj == null) - throw new ArgumentNullException("obj"); - if (index >= obj.Count) - throw new ArgumentOutOfRangeException("index"); - int i = 0; - foreach (KeyValuePair o in obj) - if (i++ == index) return o.Value; - return null; - } - - /// - /// Adds the specified key. - /// - /// The key. - /// The value. - public void Add(string key, object value) - { - _members.Add(key, value); - } - - /// - /// Determines whether the specified key contains key. - /// - /// The key. - /// - /// true if the specified key contains key; otherwise, false. - /// - public bool ContainsKey(string key) - { - return _members.ContainsKey(key); - } - - /// - /// Gets the keys. - /// - /// The keys. - public ICollection Keys - { - get { return _members.Keys; } - } - - /// - /// Removes the specified key. - /// - /// The key. - /// - public bool Remove(string key) - { - return _members.Remove(key); - } - - /// - /// Tries the get value. - /// - /// The key. - /// The value. - /// - public bool TryGetValue(string key, out object value) - { - return _members.TryGetValue(key, out value); - } - - /// - /// Gets the values. - /// - /// The values. - public ICollection Values - { - get { return _members.Values; } - } - - /// - /// Gets or sets the with the specified key. - /// - /// - public object this[string key] - { - get { return _members[key]; } - set { _members[key] = value; } - } - - /// - /// Adds the specified item. - /// - /// The item. - public void Add(KeyValuePair item) - { - _members.Add(item.Key, item.Value); - } - - /// - /// Clears this instance. - /// - public void Clear() - { - _members.Clear(); - } - - /// - /// Determines whether [contains] [the specified item]. - /// - /// The item. - /// - /// true if [contains] [the specified item]; otherwise, false. - /// - public bool Contains(KeyValuePair item) - { - return _members.ContainsKey(item.Key) && _members[item.Key] == item.Value; - } - - /// - /// Copies to. - /// - /// The array. - /// Index of the array. - public void CopyTo(KeyValuePair[] array, int arrayIndex) - { - if (array == null) throw new ArgumentNullException("array"); - int num = Count; - foreach (KeyValuePair kvp in this) - { - array[arrayIndex++] = kvp; - if (--num <= 0) - return; - } - } - - /// - /// Gets the count. - /// - /// The count. - public int Count - { - get { return _members.Count; } - } - - /// - /// Gets a value indicating whether this instance is read only. - /// - /// - /// true if this instance is read only; otherwise, false. - /// - public bool IsReadOnly - { - get { return false; } - } - - /// - /// Removes the specified item. - /// - /// The item. - /// - public bool Remove(KeyValuePair item) - { - return _members.Remove(item.Key); - } - - /// - /// Gets the enumerator. - /// - /// - public IEnumerator> GetEnumerator() - { - return _members.GetEnumerator(); - } - - /// - /// Returns an enumerator that iterates through a collection. - /// - /// - /// An object that can be used to iterate through the collection. - /// - IEnumerator IEnumerable.GetEnumerator() - { - return _members.GetEnumerator(); - } - - /// - /// Returns a json that represents the current . - /// - /// - /// A json that represents the current . - /// - public override string ToString() - { - return SimpleJson.SerializeObject(this); - } - -#if SIMPLE_JSON_DYNAMIC - /// - /// Provides implementation for type conversion operations. Classes derived from the class can override this method to specify dynamic behavior for operations that convert an object from one type to another. - /// - /// Provides information about the conversion operation. The binder.Type property provides the type to which the object must be converted. For example, for the statement (String)sampleObject in C# (CType(sampleObject, Type) in Visual Basic), where sampleObject is an instance of the class derived from the class, binder.Type returns the type. The binder.Explicit property provides information about the kind of conversion that occurs. It returns true for explicit conversion and false for implicit conversion. - /// The result of the type conversion operation. - /// - /// Alwasy returns true. - /// - public override bool TryConvert(ConvertBinder binder, out object result) - { - // - if (binder == null) - throw new ArgumentNullException("binder"); - // - Type targetType = binder.Type; - - if ((targetType == typeof(IEnumerable)) || - (targetType == typeof(IEnumerable>)) || - (targetType == typeof(IDictionary)) || - (targetType == typeof(IDictionary))) - { - result = this; - return true; - } - - return base.TryConvert(binder, out result); - } - - /// - /// Provides the implementation for operations that delete an object member. This method is not intended for use in C# or Visual Basic. - /// - /// Provides information about the deletion. - /// - /// Alwasy returns true. - /// - public override bool TryDeleteMember(DeleteMemberBinder binder) - { - // - if (binder == null) - throw new ArgumentNullException("binder"); - // - return _members.Remove(binder.Name); - } - - /// - /// Provides the implementation for operations that get a value by index. Classes derived from the class can override this method to specify dynamic behavior for indexing operations. - /// - /// Provides information about the operation. - /// The indexes that are used in the operation. For example, for the sampleObject[3] operation in C# (sampleObject(3) in Visual Basic), where sampleObject is derived from the DynamicObject class, is equal to 3. - /// The result of the index operation. - /// - /// Alwasy returns true. - /// - public override bool TryGetIndex(GetIndexBinder binder, object[] indexes, out object result) - { - if (indexes == null) throw new ArgumentNullException("indexes"); - if (indexes.Length == 1) - { - result = ((IDictionary)this)[(string)indexes[0]]; - return true; - } - result = null; - return true; - } - - /// - /// Provides the implementation for operations that get member values. Classes derived from the class can override this method to specify dynamic behavior for operations such as getting a value for a property. - /// - /// Provides information about the object that called the dynamic operation. The binder.Name property provides the name of the member on which the dynamic operation is performed. For example, for the Console.WriteLine(sampleObject.SampleProperty) statement, where sampleObject is an instance of the class derived from the class, binder.Name returns "SampleProperty". The binder.IgnoreCase property specifies whether the member name is case-sensitive. - /// The result of the get operation. For example, if the method is called for a property, you can assign the property value to . - /// - /// Alwasy returns true. - /// - public override bool TryGetMember(GetMemberBinder binder, out object result) - { - object value; - if (_members.TryGetValue(binder.Name, out value)) - { - result = value; - return true; - } - result = null; - return true; - } - - /// - /// Provides the implementation for operations that set a value by index. Classes derived from the class can override this method to specify dynamic behavior for operations that access objects by a specified index. - /// - /// Provides information about the operation. - /// The indexes that are used in the operation. For example, for the sampleObject[3] = 10 operation in C# (sampleObject(3) = 10 in Visual Basic), where sampleObject is derived from the class, is equal to 3. - /// The value to set to the object that has the specified index. For example, for the sampleObject[3] = 10 operation in C# (sampleObject(3) = 10 in Visual Basic), where sampleObject is derived from the class, is equal to 10. - /// - /// true if the operation is successful; otherwise, false. If this method returns false, the run-time binder of the language determines the behavior. (In most cases, a language-specific run-time exception is thrown. - /// - public override bool TrySetIndex(SetIndexBinder binder, object[] indexes, object value) - { - if (indexes == null) throw new ArgumentNullException("indexes"); - if (indexes.Length == 1) - { - ((IDictionary)this)[(string)indexes[0]] = value; - return true; - } - return base.TrySetIndex(binder, indexes, value); - } - - /// - /// Provides the implementation for operations that set member values. Classes derived from the class can override this method to specify dynamic behavior for operations such as setting a value for a property. - /// - /// Provides information about the object that called the dynamic operation. The binder.Name property provides the name of the member to which the value is being assigned. For example, for the statement sampleObject.SampleProperty = "Test", where sampleObject is an instance of the class derived from the class, binder.Name returns "SampleProperty". The binder.IgnoreCase property specifies whether the member name is case-sensitive. - /// The value to set to the member. For example, for sampleObject.SampleProperty = "Test", where sampleObject is an instance of the class derived from the class, the is "Test". - /// - /// true if the operation is successful; otherwise, false. If this method returns false, the run-time binder of the language determines the behavior. (In most cases, a language-specific run-time exception is thrown.) - /// - public override bool TrySetMember(SetMemberBinder binder, object value) - { - // - if (binder == null) - throw new ArgumentNullException("binder"); - // - _members[binder.Name] = value; - return true; - } - - /// - /// Returns the enumeration of all dynamic member names. - /// - /// - /// A sequence that contains dynamic member names. - /// - public override IEnumerable GetDynamicMemberNames() - { - foreach (var key in Keys) - yield return key; - } -#endif - } -} - -namespace RestSharp.Tests -{ - /// - /// This class encodes and decodes JSON strings. - /// Spec. details, see http://www.json.org/ - /// - /// JSON uses Arrays and Objects. These correspond here to the datatypes JsonArray(IList<object>) and JsonObject(IDictionary<string,object>). - /// All numbers are parsed to doubles. - /// - [GeneratedCode("simple-json", "1.0.0")] -#if SIMPLE_JSON_INTERNAL - internal -#else - public -#endif - static class SimpleJson - { - private const int TOKEN_NONE = 0; - private const int TOKEN_CURLY_OPEN = 1; - private const int TOKEN_CURLY_CLOSE = 2; - private const int TOKEN_SQUARED_OPEN = 3; - private const int TOKEN_SQUARED_CLOSE = 4; - private const int TOKEN_COLON = 5; - private const int TOKEN_COMMA = 6; - private const int TOKEN_STRING = 7; - private const int TOKEN_NUMBER = 8; - private const int TOKEN_TRUE = 9; - private const int TOKEN_FALSE = 10; - private const int TOKEN_NULL = 11; - private const int BUILDER_CAPACITY = 2000; - - private static readonly char[] EscapeTable; - private static readonly char[] EscapeCharacters = new char[] { '"', '\\', '\b', '\f', '\n', '\r', '\t' }; - private static readonly string EscapeCharactersString = new string(EscapeCharacters); - - static SimpleJson() - { - EscapeTable = new char[93]; - EscapeTable['"'] = '"'; - EscapeTable['\\'] = '\\'; - EscapeTable['\b'] = 'b'; - EscapeTable['\f'] = 'f'; - EscapeTable['\n'] = 'n'; - EscapeTable['\r'] = 'r'; - EscapeTable['\t'] = 't'; - } - - /// - /// Parses the string json into a value - /// - /// A JSON string. - /// An IList<object>, a IDictionary<string,object>, a double, a string, null, true, or false - public static object DeserializeObject(string json) - { - object obj; - if (TryDeserializeObject(json, out obj)) - return obj; - throw new SerializationException("Invalid JSON string"); - } - - /// - /// Try parsing the json string into a value. - /// - /// - /// A JSON string. - /// - /// - /// The object. - /// - /// - /// Returns true if successfull otherwise false. - /// - [SuppressMessage("Microsoft.Design", "CA1007:UseGenericsWhereAppropriate", Justification="Need to support .NET 2")] - public static bool TryDeserializeObject(string json, out object obj) - { - bool success = true; - if (json != null) - { - char[] charArray = json.ToCharArray(); - int index = 0; - obj = ParseValue(charArray, ref index, ref success); - } - else - obj = null; - - return success; - } - - public static object DeserializeObject(string json, Type type, IJsonSerializerStrategy jsonSerializerStrategy) - { - object jsonObject = DeserializeObject(json); - return type == null || jsonObject != null && ReflectionUtils.IsAssignableFrom(jsonObject.GetType(), type) - ? jsonObject - : (jsonSerializerStrategy ?? CurrentJsonSerializerStrategy).DeserializeObject(jsonObject, type); - } - - public static object DeserializeObject(string json, Type type) - { - return DeserializeObject(json, type, null); - } - - public static T DeserializeObject(string json, IJsonSerializerStrategy jsonSerializerStrategy) - { - return (T)DeserializeObject(json, typeof(T), jsonSerializerStrategy); - } - - public static T DeserializeObject(string json) - { - return (T)DeserializeObject(json, typeof(T), null); - } - - /// - /// Converts a IDictionary<string,object> / IList<object> object into a JSON string - /// - /// A IDictionary<string,object> / IList<object> - /// Serializer strategy to use - /// A JSON encoded string, or null if object 'json' is not serializable - public static string SerializeObject(object json, IJsonSerializerStrategy jsonSerializerStrategy) - { - StringBuilder builder = new StringBuilder(BUILDER_CAPACITY); - bool success = SerializeValue(jsonSerializerStrategy, json, builder); - return (success ? builder.ToString() : null); - } - - public static string SerializeObject(object json) - { - return SerializeObject(json, CurrentJsonSerializerStrategy); - } - - public static string EscapeToJavascriptString(string jsonString) - { - if (string.IsNullOrEmpty(jsonString)) - return jsonString; - - StringBuilder sb = new StringBuilder(); - char c; - - for (int i = 0; i < jsonString.Length; ) - { - c = jsonString[i++]; - - if (c == '\\') - { - int remainingLength = jsonString.Length - i; - if (remainingLength >= 2) - { - char lookahead = jsonString[i]; - if (lookahead == '\\') - { - sb.Append('\\'); - ++i; - } - else if (lookahead == '"') - { - sb.Append("\""); - ++i; - } - else if (lookahead == 't') - { - sb.Append('\t'); - ++i; - } - else if (lookahead == 'b') - { - sb.Append('\b'); - ++i; - } - else if (lookahead == 'n') - { - sb.Append('\n'); - ++i; - } - else if (lookahead == 'r') - { - sb.Append('\r'); - ++i; - } - } - } - else - { - sb.Append(c); - } - } - return sb.ToString(); - } - - static IDictionary ParseObject(char[] json, ref int index, ref bool success) - { - IDictionary table = new JsonObject(); - int token; - - // { - NextToken(json, ref index); - - bool done = false; - while (!done) - { - token = LookAhead(json, index); - if (token == TOKEN_NONE) - { - success = false; - return null; - } - else if (token == TOKEN_COMMA) - NextToken(json, ref index); - else if (token == TOKEN_CURLY_CLOSE) - { - NextToken(json, ref index); - return table; - } - else - { - // name - string name = ParseString(json, ref index, ref success); - if (!success) - { - success = false; - return null; - } - // : - token = NextToken(json, ref index); - if (token != TOKEN_COLON) - { - success = false; - return null; - } - // value - object value = ParseValue(json, ref index, ref success); - if (!success) - { - success = false; - return null; - } - table[name] = value; - } - } - return table; - } - - static JsonArray ParseArray(char[] json, ref int index, ref bool success) - { - JsonArray array = new JsonArray(); - - // [ - NextToken(json, ref index); - - bool done = false; - while (!done) - { - int token = LookAhead(json, index); - if (token == TOKEN_NONE) - { - success = false; - return null; - } - else if (token == TOKEN_COMMA) - NextToken(json, ref index); - else if (token == TOKEN_SQUARED_CLOSE) - { - NextToken(json, ref index); - break; - } - else - { - object value = ParseValue(json, ref index, ref success); - if (!success) - return null; - array.Add(value); - } - } - return array; - } - - static object ParseValue(char[] json, ref int index, ref bool success) - { - switch (LookAhead(json, index)) - { - case TOKEN_STRING: - return ParseString(json, ref index, ref success); - case TOKEN_NUMBER: - return ParseNumber(json, ref index, ref success); - case TOKEN_CURLY_OPEN: - return ParseObject(json, ref index, ref success); - case TOKEN_SQUARED_OPEN: - return ParseArray(json, ref index, ref success); - case TOKEN_TRUE: - NextToken(json, ref index); - return true; - case TOKEN_FALSE: - NextToken(json, ref index); - return false; - case TOKEN_NULL: - NextToken(json, ref index); - return null; - case TOKEN_NONE: - break; - } - success = false; - return null; - } - - static string ParseString(char[] json, ref int index, ref bool success) - { - StringBuilder s = new StringBuilder(BUILDER_CAPACITY); - char c; - - EatWhitespace(json, ref index); - - // " - c = json[index++]; - bool complete = false; - while (!complete) - { - if (index == json.Length) - break; - - c = json[index++]; - if (c == '"') - { - complete = true; - break; - } - else if (c == '\\') - { - if (index == json.Length) - break; - c = json[index++]; - if (c == '"') - s.Append('"'); - else if (c == '\\') - s.Append('\\'); - else if (c == '/') - s.Append('/'); - else if (c == 'b') - s.Append('\b'); - else if (c == 'f') - s.Append('\f'); - else if (c == 'n') - s.Append('\n'); - else if (c == 'r') - s.Append('\r'); - else if (c == 't') - s.Append('\t'); - else if (c == 'u') - { - int remainingLength = json.Length - index; - if (remainingLength >= 4) - { - // parse the 32 bit hex into an integer codepoint - uint codePoint; - if (!(success = UInt32.TryParse(new string(json, index, 4), NumberStyles.HexNumber, CultureInfo.InvariantCulture, out codePoint))) - return ""; - - // convert the integer codepoint to a unicode char and add to string - if (0xD800 <= codePoint && codePoint <= 0xDBFF) // if high surrogate - { - index += 4; // skip 4 chars - remainingLength = json.Length - index; - if (remainingLength >= 6) - { - uint lowCodePoint; - if (new string(json, index, 2) == "\\u" && UInt32.TryParse(new string(json, index + 2, 4), NumberStyles.HexNumber, CultureInfo.InvariantCulture, out lowCodePoint)) - { - if (0xDC00 <= lowCodePoint && lowCodePoint <= 0xDFFF) // if low surrogate - { - s.Append((char)codePoint); - s.Append((char)lowCodePoint); - index += 6; // skip 6 chars - continue; - } - } - } - success = false; // invalid surrogate pair - return ""; - } - s.Append(ConvertFromUtf32((int)codePoint)); - // skip 4 chars - index += 4; - } - else - break; - } - } - else - s.Append(c); - } - if (!complete) - { - success = false; - return null; - } - return s.ToString(); - } - - private static string ConvertFromUtf32(int utf32) - { - // http://www.java2s.com/Open-Source/CSharp/2.6.4-mono-.net-core/System/System/Char.cs.htm - if (utf32 < 0 || utf32 > 0x10FFFF) - throw new ArgumentOutOfRangeException("utf32", "The argument must be from 0 to 0x10FFFF."); - if (0xD800 <= utf32 && utf32 <= 0xDFFF) - throw new ArgumentOutOfRangeException("utf32", "The argument must not be in surrogate pair range."); - if (utf32 < 0x10000) - return new string((char)utf32, 1); - utf32 -= 0x10000; - return new string(new char[] { (char)((utf32 >> 10) + 0xD800), (char)(utf32 % 0x0400 + 0xDC00) }); - } - - static object ParseNumber(char[] json, ref int index, ref bool success) - { - EatWhitespace(json, ref index); - int lastIndex = GetLastIndexOfNumber(json, index); - int charLength = (lastIndex - index) + 1; - object returnNumber; - string str = new string(json, index, charLength); - if (str.IndexOf(".", StringComparison.OrdinalIgnoreCase) != -1 || str.IndexOf("e", StringComparison.OrdinalIgnoreCase) != -1) - { - double number; - success = double.TryParse(new string(json, index, charLength), NumberStyles.Any, CultureInfo.InvariantCulture, out number); - returnNumber = number; - } - else - { - long number; - success = long.TryParse(new string(json, index, charLength), NumberStyles.Any, CultureInfo.InvariantCulture, out number); - returnNumber = number; - } - index = lastIndex + 1; - return returnNumber; - } - - static int GetLastIndexOfNumber(char[] json, int index) - { - int lastIndex; - for (lastIndex = index; lastIndex < json.Length; lastIndex++) - if ("0123456789+-.eE".IndexOf(json[lastIndex]) == -1) break; - return lastIndex - 1; - } - - static void EatWhitespace(char[] json, ref int index) - { - for (; index < json.Length; index++) - if (" \t\n\r\b\f".IndexOf(json[index]) == -1) break; - } - - static int LookAhead(char[] json, int index) - { - int saveIndex = index; - return NextToken(json, ref saveIndex); - } - - [SuppressMessage("Microsoft.Maintainability", "CA1502:AvoidExcessiveComplexity")] - static int NextToken(char[] json, ref int index) - { - EatWhitespace(json, ref index); - if (index == json.Length) - return TOKEN_NONE; - char c = json[index]; - index++; - switch (c) - { - case '{': - return TOKEN_CURLY_OPEN; - case '}': - return TOKEN_CURLY_CLOSE; - case '[': - return TOKEN_SQUARED_OPEN; - case ']': - return TOKEN_SQUARED_CLOSE; - case ',': - return TOKEN_COMMA; - case '"': - return TOKEN_STRING; - case '0': - case '1': - case '2': - case '3': - case '4': - case '5': - case '6': - case '7': - case '8': - case '9': - case '-': - return TOKEN_NUMBER; - case ':': - return TOKEN_COLON; - } - index--; - int remainingLength = json.Length - index; - // false - if (remainingLength >= 5) - { - if (json[index] == 'f' && json[index + 1] == 'a' && json[index + 2] == 'l' && json[index + 3] == 's' && json[index + 4] == 'e') - { - index += 5; - return TOKEN_FALSE; - } - } - // true - if (remainingLength >= 4) - { - if (json[index] == 't' && json[index + 1] == 'r' && json[index + 2] == 'u' && json[index + 3] == 'e') - { - index += 4; - return TOKEN_TRUE; - } - } - // null - if (remainingLength >= 4) - { - if (json[index] == 'n' && json[index + 1] == 'u' && json[index + 2] == 'l' && json[index + 3] == 'l') - { - index += 4; - return TOKEN_NULL; - } - } - return TOKEN_NONE; - } - - static bool SerializeValue(IJsonSerializerStrategy jsonSerializerStrategy, object value, StringBuilder builder) - { - bool success = true; - string stringValue = value as string; - if (stringValue != null) - success = SerializeString(stringValue, builder); - else - { - IDictionary dict = value as IDictionary; - if (dict != null) - { - success = SerializeObject(jsonSerializerStrategy, dict.Keys, dict.Values, builder); - } - else - { - IDictionary stringDictionary = value as IDictionary; - if (stringDictionary != null) - { - success = SerializeObject(jsonSerializerStrategy, stringDictionary.Keys, stringDictionary.Values, builder); - } - else - { - IEnumerable enumerableValue = value as IEnumerable; - if (enumerableValue != null) - success = SerializeArray(jsonSerializerStrategy, enumerableValue, builder); - else if (IsNumeric(value)) - success = SerializeNumber(value, builder); - else if (value is bool) - builder.Append((bool)value ? "true" : "false"); - else if (value == null) - builder.Append("null"); - else - { - object serializedObject; - success = jsonSerializerStrategy.TrySerializeNonPrimitiveObject(value, out serializedObject); - if (success) - SerializeValue(jsonSerializerStrategy, serializedObject, builder); - } - } - } - } - return success; - } - - static bool SerializeObject(IJsonSerializerStrategy jsonSerializerStrategy, IEnumerable keys, IEnumerable values, StringBuilder builder) - { - builder.Append("{"); - IEnumerator ke = keys.GetEnumerator(); - IEnumerator ve = values.GetEnumerator(); - bool first = true; - while (ke.MoveNext() && ve.MoveNext()) - { - object key = ke.Current; - object value = ve.Current; - if (!first) - builder.Append(","); - string stringKey = key as string; - if (stringKey != null) - SerializeString(stringKey, builder); - else - if (!SerializeValue(jsonSerializerStrategy, value, builder)) return false; - builder.Append(":"); - if (!SerializeValue(jsonSerializerStrategy, value, builder)) - return false; - first = false; - } - builder.Append("}"); - return true; - } - - static bool SerializeArray(IJsonSerializerStrategy jsonSerializerStrategy, IEnumerable anArray, StringBuilder builder) - { - builder.Append("["); - bool first = true; - foreach (object value in anArray) - { - if (!first) - builder.Append(","); - if (!SerializeValue(jsonSerializerStrategy, value, builder)) - return false; - first = false; - } - builder.Append("]"); - return true; - } - - static bool SerializeString(string aString, StringBuilder builder) - { - // Happy path if there's nothing to be escaped. IndexOfAny is highly optimized (and unmanaged) - if (aString.IndexOfAny(EscapeCharacters) == -1) - { - builder.Append('"'); - builder.Append(aString); - builder.Append('"'); - - return true; - } - - builder.Append('"'); - int safeCharacterCount = 0; - char[] charArray = aString.ToCharArray(); - - for (int i = 0; i < charArray.Length; i++) - { - char c = charArray[i]; - - // Non ascii characters are fine, buffer them up and send them to the builder - // in larger chunks if possible. The escape table is a 1:1 translation table - // with \0 [default(char)] denoting a safe character. - if (c >= EscapeTable.Length || EscapeTable[c] == default(char)) - { - safeCharacterCount++; - } - else - { - if (safeCharacterCount > 0) - { - builder.Append(charArray, i - safeCharacterCount, safeCharacterCount); - safeCharacterCount = 0; - } - - builder.Append('\\'); - builder.Append(EscapeTable[c]); - } - } - - if (safeCharacterCount > 0) - { - builder.Append(charArray, charArray.Length - safeCharacterCount, safeCharacterCount); - } - - builder.Append('"'); - return true; - } - - static bool SerializeNumber(object number, StringBuilder builder) - { - if (number is long) - builder.Append(((long)number).ToString(CultureInfo.InvariantCulture)); - else if (number is ulong) - builder.Append(((ulong)number).ToString(CultureInfo.InvariantCulture)); - else if (number is int) - builder.Append(((int)number).ToString(CultureInfo.InvariantCulture)); - else if (number is uint) - builder.Append(((uint)number).ToString(CultureInfo.InvariantCulture)); - else if (number is decimal) - builder.Append(((decimal)number).ToString(CultureInfo.InvariantCulture)); - else if (number is float) - builder.Append(((float)number).ToString(CultureInfo.InvariantCulture)); - else - builder.Append(Convert.ToDouble(number, CultureInfo.InvariantCulture).ToString("r", CultureInfo.InvariantCulture)); - return true; - } - - /// - /// Determines if a given object is numeric in any way - /// (can be integer, double, null, etc). - /// - static bool IsNumeric(object value) - { - if (value is sbyte) return true; - if (value is byte) return true; - if (value is short) return true; - if (value is ushort) return true; - if (value is int) return true; - if (value is uint) return true; - if (value is long) return true; - if (value is ulong) return true; - if (value is float) return true; - if (value is double) return true; - if (value is decimal) return true; - return false; - } - - private static IJsonSerializerStrategy _currentJsonSerializerStrategy; - public static IJsonSerializerStrategy CurrentJsonSerializerStrategy - { - get - { - return _currentJsonSerializerStrategy ?? - (_currentJsonSerializerStrategy = -#if SIMPLE_JSON_DATACONTRACT - DataContractJsonSerializerStrategy -#else - PocoJsonSerializerStrategy -#endif -); - } - set - { - _currentJsonSerializerStrategy = value; - } - } - - private static PocoJsonSerializerStrategy _pocoJsonSerializerStrategy; - [EditorBrowsable(EditorBrowsableState.Advanced)] - public static PocoJsonSerializerStrategy PocoJsonSerializerStrategy - { - get - { - return _pocoJsonSerializerStrategy ?? (_pocoJsonSerializerStrategy = new PocoJsonSerializerStrategy()); - } - } - -#if SIMPLE_JSON_DATACONTRACT - - private static DataContractJsonSerializerStrategy _dataContractJsonSerializerStrategy; - [System.ComponentModel.EditorBrowsable(EditorBrowsableState.Advanced)] - public static DataContractJsonSerializerStrategy DataContractJsonSerializerStrategy - { - get - { - return _dataContractJsonSerializerStrategy ?? (_dataContractJsonSerializerStrategy = new DataContractJsonSerializerStrategy()); - } - } - -#endif - } - - [GeneratedCode("simple-json", "1.0.0")] -#if SIMPLE_JSON_INTERNAL - internal -#else - public -#endif - interface IJsonSerializerStrategy - { - [SuppressMessage("Microsoft.Design", "CA1007:UseGenericsWhereAppropriate", Justification="Need to support .NET 2")] - bool TrySerializeNonPrimitiveObject(object input, out object output); - object DeserializeObject(object value, Type type); - } - - [GeneratedCode("simple-json", "1.0.0")] -#if SIMPLE_JSON_INTERNAL - internal -#else - public -#endif - class PocoJsonSerializerStrategy : IJsonSerializerStrategy - { - internal IDictionary ConstructorCache; - internal IDictionary> GetCache; - internal IDictionary>> SetCache; - - internal static readonly Type[] EmptyTypes = new Type[0]; - internal static readonly Type[] ArrayConstructorParameterTypes = new Type[] { typeof(int) }; - - private static readonly string[] Iso8601Format = new string[] - { - @"yyyy-MM-dd\THH:mm:ss.FFFFFFF\Z", - @"yyyy-MM-dd\THH:mm:ss\Z", - @"yyyy-MM-dd\THH:mm:ssK" - }; - - public PocoJsonSerializerStrategy() - { - ConstructorCache = new ReflectionUtils.ThreadSafeDictionary(ContructorDelegateFactory); - GetCache = new ReflectionUtils.ThreadSafeDictionary>(GetterValueFactory); - SetCache = new ReflectionUtils.ThreadSafeDictionary>>(SetterValueFactory); - } - - protected virtual string MapClrMemberNameToJsonFieldName(string clrPropertyName) - { - return clrPropertyName; - } - - internal virtual ReflectionUtils.ConstructorDelegate ContructorDelegateFactory(Type key) - { - return ReflectionUtils.GetContructor(key, key.IsArray ? ArrayConstructorParameterTypes : EmptyTypes); - } - - internal virtual IDictionary GetterValueFactory(Type type) - { - IDictionary result = new Dictionary(); - foreach (PropertyInfo propertyInfo in ReflectionUtils.GetProperties(type)) - { - if (propertyInfo.CanRead) - { - MethodInfo getMethod = ReflectionUtils.GetGetterMethodInfo(propertyInfo); - if (getMethod.IsStatic || !getMethod.IsPublic) - continue; - result[MapClrMemberNameToJsonFieldName(propertyInfo.Name)] = ReflectionUtils.GetGetMethod(propertyInfo); - } - } - foreach (FieldInfo fieldInfo in ReflectionUtils.GetFields(type)) - { - if (fieldInfo.IsStatic || !fieldInfo.IsPublic) - continue; - result[MapClrMemberNameToJsonFieldName(fieldInfo.Name)] = ReflectionUtils.GetGetMethod(fieldInfo); - } - return result; - } - - internal virtual IDictionary> SetterValueFactory(Type type) - { - IDictionary> result = new Dictionary>(); - foreach (PropertyInfo propertyInfo in ReflectionUtils.GetProperties(type)) - { - if (propertyInfo.CanWrite) - { - MethodInfo setMethod = ReflectionUtils.GetSetterMethodInfo(propertyInfo); - if (setMethod.IsStatic || !setMethod.IsPublic) - continue; - result[MapClrMemberNameToJsonFieldName(propertyInfo.Name)] = new KeyValuePair(propertyInfo.PropertyType, ReflectionUtils.GetSetMethod(propertyInfo)); - } - } - foreach (FieldInfo fieldInfo in ReflectionUtils.GetFields(type)) - { - if (fieldInfo.IsInitOnly || fieldInfo.IsStatic || !fieldInfo.IsPublic) - continue; - result[MapClrMemberNameToJsonFieldName(fieldInfo.Name)] = new KeyValuePair(fieldInfo.FieldType, ReflectionUtils.GetSetMethod(fieldInfo)); - } - return result; - } - - public virtual bool TrySerializeNonPrimitiveObject(object input, out object output) - { - return TrySerializeKnownTypes(input, out output) || TrySerializeUnknownTypes(input, out output); - } - - [SuppressMessage("Microsoft.Maintainability", "CA1502:AvoidExcessiveComplexity")] - public virtual object DeserializeObject(object value, Type type) - { - if (type == null) throw new ArgumentNullException("type"); - string str = value as string; - - if (type == typeof (Guid) && string.IsNullOrEmpty(str)) - return default(Guid); - - if (value == null) - return null; - - object obj = null; - - if (str != null) - { - if (str.Length != 0) // We know it can't be null now. - { - if (type == typeof(DateTime) || (ReflectionUtils.IsNullableType(type) && Nullable.GetUnderlyingType(type) == typeof(DateTime))) - return DateTime.ParseExact(str, Iso8601Format, CultureInfo.InvariantCulture, DateTimeStyles.AssumeUniversal | DateTimeStyles.AdjustToUniversal); - if (type == typeof(DateTimeOffset) || (ReflectionUtils.IsNullableType(type) && Nullable.GetUnderlyingType(type) == typeof(DateTimeOffset))) - return DateTimeOffset.ParseExact(str, Iso8601Format, CultureInfo.InvariantCulture, DateTimeStyles.AssumeUniversal | DateTimeStyles.AdjustToUniversal); - if (type == typeof(Guid) || (ReflectionUtils.IsNullableType(type) && Nullable.GetUnderlyingType(type) == typeof(Guid))) - return new Guid(str); - if (type == typeof(Uri)) - { - bool isValid = Uri.IsWellFormedUriString(str, UriKind.RelativeOrAbsolute); - - Uri result; - if (isValid && Uri.TryCreate(str, UriKind.RelativeOrAbsolute, out result)) - return result; - - return null; - } - - if (type == typeof(string)) - return str; - - return Convert.ChangeType(str, type, CultureInfo.InvariantCulture); - } - else - { - if (type == typeof(Guid)) - obj = default(Guid); - else if (ReflectionUtils.IsNullableType(type) && Nullable.GetUnderlyingType(type) == typeof(Guid)) - obj = null; - else - obj = str; - } - // Empty string case - if (!ReflectionUtils.IsNullableType(type) && Nullable.GetUnderlyingType(type) == typeof(Guid)) - return str; - } - else if (value is bool) - return value; - - bool valueIsLong = value is long; - bool valueIsDouble = value is double; - if ((valueIsLong && type == typeof(long)) || (valueIsDouble && type == typeof(double))) - return value; - if ((valueIsDouble && type != typeof(double)) || (valueIsLong && type != typeof(long))) - { - obj = type == typeof(int) || type == typeof(long) || type == typeof(double) || type == typeof(float) || type == typeof(bool) || type == typeof(decimal) || type == typeof(byte) || type == typeof(short) - ? Convert.ChangeType(value, type, CultureInfo.InvariantCulture) - : value; - } - else - { - IDictionary objects = value as IDictionary; - if (objects != null) - { - IDictionary jsonObject = objects; - - if (ReflectionUtils.IsTypeDictionary(type)) - { - // if dictionary then - Type[] types = ReflectionUtils.GetGenericTypeArguments(type); - Type keyType = types[0]; - Type valueType = types[1]; - - Type genericType = typeof(Dictionary<,>).MakeGenericType(keyType, valueType); - - IDictionary dict = (IDictionary)ConstructorCache[genericType](); - - foreach (KeyValuePair kvp in jsonObject) - dict.Add(kvp.Key, DeserializeObject(kvp.Value, valueType)); - - obj = dict; - } - else - { - if (type == typeof(object)) - obj = value; - else - { - obj = ConstructorCache[type](); - foreach (KeyValuePair> setter in SetCache[type]) - { - object jsonValue; - if (jsonObject.TryGetValue(setter.Key, out jsonValue)) - { - jsonValue = DeserializeObject(jsonValue, setter.Value.Key); - setter.Value.Value(obj, jsonValue); - } - } - } - } - } - else - { - IList valueAsList = value as IList; - if (valueAsList != null) - { - IList jsonObject = valueAsList; - IList list = null; - - if (type.IsArray) - { - list = (IList)ConstructorCache[type](jsonObject.Count); - int i = 0; - foreach (object o in jsonObject) - list[i++] = DeserializeObject(o, type.GetElementType()); - } - else if (ReflectionUtils.IsTypeGenericeCollectionInterface(type) || ReflectionUtils.IsAssignableFrom(typeof(IList), type)) - { - Type innerType = ReflectionUtils.GetGenericListElementType(type); - list = (IList)(ConstructorCache[type] ?? ConstructorCache[typeof(List<>).MakeGenericType(innerType)])(jsonObject.Count); - foreach (object o in jsonObject) - list.Add(DeserializeObject(o, innerType)); - } - obj = list; - } - } - return obj; - } - if (ReflectionUtils.IsNullableType(type)) - return ReflectionUtils.ToNullableType(obj, type); - return obj; - } - - protected virtual object SerializeEnum(Enum p) - { - return Convert.ToDouble(p, CultureInfo.InvariantCulture); - } - - [SuppressMessage("Microsoft.Design", "CA1007:UseGenericsWhereAppropriate", Justification="Need to support .NET 2")] - protected virtual bool TrySerializeKnownTypes(object input, out object output) - { - bool returnValue = true; - if (input is DateTime) - output = ((DateTime)input).ToUniversalTime().ToString(Iso8601Format[0], CultureInfo.InvariantCulture); - else if (input is DateTimeOffset) - output = ((DateTimeOffset)input).ToUniversalTime().ToString(Iso8601Format[0], CultureInfo.InvariantCulture); - else if (input is Guid) - output = ((Guid)input).ToString("D"); - else if (input is Uri) - output = input.ToString(); - else - { - Enum inputEnum = input as Enum; - if (inputEnum != null) - output = SerializeEnum(inputEnum); - else - { - returnValue = false; - output = null; - } - } - return returnValue; - } - [SuppressMessage("Microsoft.Design", "CA1007:UseGenericsWhereAppropriate", Justification="Need to support .NET 2")] - protected virtual bool TrySerializeUnknownTypes(object input, out object output) - { - if (input == null) throw new ArgumentNullException("input"); - output = null; - Type type = input.GetType(); - if (type.FullName == null) - return false; - IDictionary obj = new JsonObject(); - IDictionary getters = GetCache[type]; - foreach (KeyValuePair getter in getters) - { - if (getter.Value != null) - obj.Add(MapClrMemberNameToJsonFieldName(getter.Key), getter.Value(input)); - } - output = obj; - return true; - } - } - -#if SIMPLE_JSON_DATACONTRACT - [GeneratedCode("simple-json", "1.0.0")] -#if SIMPLE_JSON_INTERNAL - internal -#else - public -#endif - class DataContractJsonSerializerStrategy : PocoJsonSerializerStrategy - { - public DataContractJsonSerializerStrategy() - { - GetCache = new ReflectionUtils.ThreadSafeDictionary>(GetterValueFactory); - SetCache = new ReflectionUtils.ThreadSafeDictionary>>(SetterValueFactory); - } - - internal override IDictionary GetterValueFactory(Type type) - { - bool hasDataContract = ReflectionUtils.GetAttribute(type, typeof(DataContractAttribute)) != null; - if (!hasDataContract) - return base.GetterValueFactory(type); - string jsonKey; - IDictionary result = new Dictionary(); - foreach (PropertyInfo propertyInfo in ReflectionUtils.GetProperties(type)) - { - if (propertyInfo.CanRead) - { - MethodInfo getMethod = ReflectionUtils.GetGetterMethodInfo(propertyInfo); - if (!getMethod.IsStatic && CanAdd(propertyInfo, out jsonKey)) - result[jsonKey] = ReflectionUtils.GetGetMethod(propertyInfo); - } - } - foreach (FieldInfo fieldInfo in ReflectionUtils.GetFields(type)) - { - if (!fieldInfo.IsStatic && CanAdd(fieldInfo, out jsonKey)) - result[jsonKey] = ReflectionUtils.GetGetMethod(fieldInfo); - } - return result; - } - - internal override IDictionary> SetterValueFactory(Type type) - { - bool hasDataContract = ReflectionUtils.GetAttribute(type, typeof(DataContractAttribute)) != null; - if (!hasDataContract) - return base.SetterValueFactory(type); - string jsonKey; - IDictionary> result = new Dictionary>(); - foreach (PropertyInfo propertyInfo in ReflectionUtils.GetProperties(type)) - { - if (propertyInfo.CanWrite) - { - MethodInfo setMethod = ReflectionUtils.GetSetterMethodInfo(propertyInfo); - if (!setMethod.IsStatic && CanAdd(propertyInfo, out jsonKey)) - result[jsonKey] = new KeyValuePair(propertyInfo.PropertyType, ReflectionUtils.GetSetMethod(propertyInfo)); - } - } - foreach (FieldInfo fieldInfo in ReflectionUtils.GetFields(type)) - { - if (!fieldInfo.IsInitOnly && !fieldInfo.IsStatic && CanAdd(fieldInfo, out jsonKey)) - result[jsonKey] = new KeyValuePair(fieldInfo.FieldType, ReflectionUtils.GetSetMethod(fieldInfo)); - } - // todo implement sorting for DATACONTRACT. - return result; - } - - private static bool CanAdd(MemberInfo info, out string jsonKey) - { - jsonKey = null; - if (ReflectionUtils.GetAttribute(info, typeof(IgnoreDataMemberAttribute)) != null) - return false; - DataMemberAttribute dataMemberAttribute = (DataMemberAttribute)ReflectionUtils.GetAttribute(info, typeof(DataMemberAttribute)); - if (dataMemberAttribute == null) - return false; - jsonKey = string.IsNullOrEmpty(dataMemberAttribute.Name) ? info.Name : dataMemberAttribute.Name; - return true; - } - } - -#endif - - namespace Reflection - { - // This class is meant to be copied into other libraries. So we want to exclude it from Code Analysis rules - // that might be in place in the target project. - [GeneratedCode("reflection-utils", "1.0.0")] -#if SIMPLE_JSON_REFLECTION_UTILS_PUBLIC - public -#else - internal -#endif - class ReflectionUtils - { - private static readonly object[] EmptyObjects = new object[] { }; - - public delegate object GetDelegate(object source); - public delegate void SetDelegate(object source, object value); - public delegate object ConstructorDelegate(params object[] args); - - public delegate TValue ThreadSafeDictionaryValueFactory(TKey key); - -#if SIMPLE_JSON_TYPEINFO - public static TypeInfo GetTypeInfo(Type type) - { - return type.GetTypeInfo(); - } -#else - public static Type GetTypeInfo(Type type) - { - return type; - } -#endif - - public static Attribute GetAttribute(MemberInfo info, Type type) - { -#if SIMPLE_JSON_TYPEINFO - if (info == null || type == null || !info.IsDefined(type)) - return null; - return info.GetCustomAttribute(type); -#else - if (info == null || type == null || !Attribute.IsDefined(info, type)) - return null; - return Attribute.GetCustomAttribute(info, type); -#endif - } - - public static Type GetGenericListElementType(Type type) - { - IEnumerable interfaces; -#if SIMPLE_JSON_TYPEINFO - interfaces = type.GetTypeInfo().ImplementedInterfaces; -#else - interfaces = type.GetInterfaces(); -#endif - foreach (Type implementedInterface in interfaces) - { - if (IsTypeGeneric(implementedInterface) && - implementedInterface.GetGenericTypeDefinition() == typeof (IList<>)) - { - return GetGenericTypeArguments(implementedInterface)[0]; - } - } - return GetGenericTypeArguments(type)[0]; - } - - public static Attribute GetAttribute(Type objectType, Type attributeType) - { - -#if SIMPLE_JSON_TYPEINFO - if (objectType == null || attributeType == null || !objectType.GetTypeInfo().IsDefined(attributeType)) - return null; - return objectType.GetTypeInfo().GetCustomAttribute(attributeType); -#else - if (objectType == null || attributeType == null || !Attribute.IsDefined(objectType, attributeType)) - return null; - return Attribute.GetCustomAttribute(objectType, attributeType); -#endif - } - - public static Type[] GetGenericTypeArguments(Type type) - { -#if SIMPLE_JSON_TYPEINFO - return type.GetTypeInfo().GenericTypeArguments; -#else - return type.GetGenericArguments(); -#endif - } - - public static bool IsTypeGeneric(Type type) - { - return GetTypeInfo(type).IsGenericType; - } - - public static bool IsTypeGenericeCollectionInterface(Type type) - { - if (!IsTypeGeneric(type)) - return false; - - Type genericDefinition = type.GetGenericTypeDefinition(); - - return (genericDefinition == typeof(IList<>) - || genericDefinition == typeof(ICollection<>) - || genericDefinition == typeof(IEnumerable<>) -#if SIMPLE_JSON_READONLY_COLLECTIONS - || genericDefinition == typeof(IReadOnlyCollection<>) - || genericDefinition == typeof(IReadOnlyList<>) -#endif - ); - } - - public static bool IsAssignableFrom(Type type1, Type type2) - { - return GetTypeInfo(type1).IsAssignableFrom(GetTypeInfo(type2)); - } - - public static bool IsTypeDictionary(Type type) - { -#if SIMPLE_JSON_TYPEINFO - if (typeof(IDictionary<,>).GetTypeInfo().IsAssignableFrom(type.GetTypeInfo())) - return true; -#else - if (typeof(System.Collections.IDictionary).IsAssignableFrom(type)) - return true; -#endif - if (!GetTypeInfo(type).IsGenericType) - return false; - - Type genericDefinition = type.GetGenericTypeDefinition(); - return genericDefinition == typeof(IDictionary<,>); - } - - public static bool IsNullableType(Type type) - { - return GetTypeInfo(type).IsGenericType && type.GetGenericTypeDefinition() == typeof(Nullable<>); - } - - public static object ToNullableType(object obj, Type nullableType) - { - return obj == null ? null : Convert.ChangeType(obj, Nullable.GetUnderlyingType(nullableType), CultureInfo.InvariantCulture); - } - - public static bool IsValueType(Type type) - { - return GetTypeInfo(type).IsValueType; - } - - public static IEnumerable GetConstructors(Type type) - { -#if SIMPLE_JSON_TYPEINFO - return type.GetTypeInfo().DeclaredConstructors; -#else - return type.GetConstructors(); -#endif - } - - public static ConstructorInfo GetConstructorInfo(Type type, params Type[] argsType) - { - IEnumerable constructorInfos = GetConstructors(type); - int i; - bool matches; - foreach (ConstructorInfo constructorInfo in constructorInfos) - { - ParameterInfo[] parameters = constructorInfo.GetParameters(); - if (argsType.Length != parameters.Length) - continue; - - i = 0; - matches = true; - foreach (ParameterInfo parameterInfo in constructorInfo.GetParameters()) - { - if (parameterInfo.ParameterType != argsType[i]) - { - matches = false; - break; - } - } - - if (matches) - return constructorInfo; - } - - return null; - } - - public static IEnumerable GetProperties(Type type) - { -#if SIMPLE_JSON_TYPEINFO - return type.GetRuntimeProperties(); -#else - return type.GetProperties(BindingFlags.Instance | BindingFlags.Public | BindingFlags.NonPublic | BindingFlags.Static); -#endif - } - - public static IEnumerable GetFields(Type type) - { -#if SIMPLE_JSON_TYPEINFO - return type.GetRuntimeFields(); -#else - return type.GetFields(BindingFlags.Instance | BindingFlags.Public | BindingFlags.NonPublic | BindingFlags.Static); -#endif - } - - public static MethodInfo GetGetterMethodInfo(PropertyInfo propertyInfo) - { -#if SIMPLE_JSON_TYPEINFO - return propertyInfo.GetMethod; -#else - return propertyInfo.GetGetMethod(true); -#endif - } - - public static MethodInfo GetSetterMethodInfo(PropertyInfo propertyInfo) - { -#if SIMPLE_JSON_TYPEINFO - return propertyInfo.SetMethod; -#else - return propertyInfo.GetSetMethod(true); -#endif - } - - public static ConstructorDelegate GetContructor(ConstructorInfo constructorInfo) - { -#if SIMPLE_JSON_NO_LINQ_EXPRESSION - return GetConstructorByReflection(constructorInfo); -#else - return GetConstructorByExpression(constructorInfo); -#endif - } - - public static ConstructorDelegate GetContructor(Type type, params Type[] argsType) - { -#if SIMPLE_JSON_NO_LINQ_EXPRESSION - return GetConstructorByReflection(type, argsType); -#else - return GetConstructorByExpression(type, argsType); -#endif - } - - public static ConstructorDelegate GetConstructorByReflection(ConstructorInfo constructorInfo) - { - return delegate(object[] args) { return constructorInfo.Invoke(args); }; - } - - public static ConstructorDelegate GetConstructorByReflection(Type type, params Type[] argsType) - { - ConstructorInfo constructorInfo = GetConstructorInfo(type, argsType); - return constructorInfo == null ? null : GetConstructorByReflection(constructorInfo); - } - -#if !SIMPLE_JSON_NO_LINQ_EXPRESSION - - public static ConstructorDelegate GetConstructorByExpression(ConstructorInfo constructorInfo) - { - ParameterInfo[] paramsInfo = constructorInfo.GetParameters(); - ParameterExpression param = Expression.Parameter(typeof(object[]), "args"); - Expression[] argsExp = new Expression[paramsInfo.Length]; - for (int i = 0; i < paramsInfo.Length; i++) - { - Expression index = Expression.Constant(i); - Type paramType = paramsInfo[i].ParameterType; - Expression paramAccessorExp = Expression.ArrayIndex(param, index); - Expression paramCastExp = Expression.Convert(paramAccessorExp, paramType); - argsExp[i] = paramCastExp; - } - NewExpression newExp = Expression.New(constructorInfo, argsExp); - Expression> lambda = Expression.Lambda>(newExp, param); - Func compiledLambda = lambda.Compile(); - return delegate(object[] args) { return compiledLambda(args); }; - } - - public static ConstructorDelegate GetConstructorByExpression(Type type, params Type[] argsType) - { - ConstructorInfo constructorInfo = GetConstructorInfo(type, argsType); - return constructorInfo == null ? null : GetConstructorByExpression(constructorInfo); - } - -#endif - - public static GetDelegate GetGetMethod(PropertyInfo propertyInfo) - { -#if SIMPLE_JSON_NO_LINQ_EXPRESSION - return GetGetMethodByReflection(propertyInfo); -#else - return GetGetMethodByExpression(propertyInfo); -#endif - } - - public static GetDelegate GetGetMethod(FieldInfo fieldInfo) - { -#if SIMPLE_JSON_NO_LINQ_EXPRESSION - return GetGetMethodByReflection(fieldInfo); -#else - return GetGetMethodByExpression(fieldInfo); -#endif - } - - public static GetDelegate GetGetMethodByReflection(PropertyInfo propertyInfo) - { - MethodInfo methodInfo = GetGetterMethodInfo(propertyInfo); - return delegate(object source) { return methodInfo.Invoke(source, EmptyObjects); }; - } - - public static GetDelegate GetGetMethodByReflection(FieldInfo fieldInfo) - { - return delegate(object source) { return fieldInfo.GetValue(source); }; - } - -#if !SIMPLE_JSON_NO_LINQ_EXPRESSION - - public static GetDelegate GetGetMethodByExpression(PropertyInfo propertyInfo) - { - MethodInfo getMethodInfo = GetGetterMethodInfo(propertyInfo); - ParameterExpression instance = Expression.Parameter(typeof(object), "instance"); - UnaryExpression instanceCast = (!IsValueType(propertyInfo.DeclaringType)) ? Expression.TypeAs(instance, propertyInfo.DeclaringType) : Expression.Convert(instance, propertyInfo.DeclaringType); - Func compiled = Expression.Lambda>(Expression.TypeAs(Expression.Call(instanceCast, getMethodInfo), typeof(object)), instance).Compile(); - return delegate(object source) { return compiled(source); }; - } - - public static GetDelegate GetGetMethodByExpression(FieldInfo fieldInfo) - { - ParameterExpression instance = Expression.Parameter(typeof(object), "instance"); - MemberExpression member = Expression.Field(Expression.Convert(instance, fieldInfo.DeclaringType), fieldInfo); - GetDelegate compiled = Expression.Lambda(Expression.Convert(member, typeof(object)), instance).Compile(); - return delegate(object source) { return compiled(source); }; - } - -#endif - - public static SetDelegate GetSetMethod(PropertyInfo propertyInfo) - { -#if SIMPLE_JSON_NO_LINQ_EXPRESSION - return GetSetMethodByReflection(propertyInfo); -#else - return GetSetMethodByExpression(propertyInfo); -#endif - } - - public static SetDelegate GetSetMethod(FieldInfo fieldInfo) - { -#if SIMPLE_JSON_NO_LINQ_EXPRESSION - return GetSetMethodByReflection(fieldInfo); -#else - return GetSetMethodByExpression(fieldInfo); -#endif - } - - public static SetDelegate GetSetMethodByReflection(PropertyInfo propertyInfo) - { - MethodInfo methodInfo = GetSetterMethodInfo(propertyInfo); - return delegate(object source, object value) { methodInfo.Invoke(source, new object[] { value }); }; - } - - public static SetDelegate GetSetMethodByReflection(FieldInfo fieldInfo) - { - return delegate(object source, object value) { fieldInfo.SetValue(source, value); }; - } - -#if !SIMPLE_JSON_NO_LINQ_EXPRESSION - - public static SetDelegate GetSetMethodByExpression(PropertyInfo propertyInfo) - { - MethodInfo setMethodInfo = GetSetterMethodInfo(propertyInfo); - ParameterExpression instance = Expression.Parameter(typeof(object), "instance"); - ParameterExpression value = Expression.Parameter(typeof(object), "value"); - UnaryExpression instanceCast = (!IsValueType(propertyInfo.DeclaringType)) ? Expression.TypeAs(instance, propertyInfo.DeclaringType) : Expression.Convert(instance, propertyInfo.DeclaringType); - UnaryExpression valueCast = (!IsValueType(propertyInfo.PropertyType)) ? Expression.TypeAs(value, propertyInfo.PropertyType) : Expression.Convert(value, propertyInfo.PropertyType); - Action compiled = Expression.Lambda>(Expression.Call(instanceCast, setMethodInfo, valueCast), new ParameterExpression[] { instance, value }).Compile(); - return delegate(object source, object val) { compiled(source, val); }; - } - - public static SetDelegate GetSetMethodByExpression(FieldInfo fieldInfo) - { - ParameterExpression instance = Expression.Parameter(typeof(object), "instance"); - ParameterExpression value = Expression.Parameter(typeof(object), "value"); - Action compiled = Expression.Lambda>( - Assign(Expression.Field(Expression.Convert(instance, fieldInfo.DeclaringType), fieldInfo), Expression.Convert(value, fieldInfo.FieldType)), instance, value).Compile(); - return delegate(object source, object val) { compiled(source, val); }; - } - - public static BinaryExpression Assign(Expression left, Expression right) - { -#if SIMPLE_JSON_TYPEINFO - return Expression.Assign(left, right); -#else - MethodInfo assign = typeof(Assigner<>).MakeGenericType(left.Type).GetMethod("Assign"); - BinaryExpression assignExpr = Expression.Add(left, right, assign); - return assignExpr; -#endif - } - - private static class Assigner - { - public static T Assign(ref T left, T right) - { - return (left = right); - } - } - -#endif - - public sealed class ThreadSafeDictionary : IDictionary - { - private readonly object _lock = new object(); - private readonly ThreadSafeDictionaryValueFactory _valueFactory; - private Dictionary _dictionary; - - public ThreadSafeDictionary(ThreadSafeDictionaryValueFactory valueFactory) - { - _valueFactory = valueFactory; - } - - private TValue Get(TKey key) - { - if (_dictionary == null) - return AddValue(key); - TValue value; - if (!_dictionary.TryGetValue(key, out value)) - return AddValue(key); - return value; - } - - private TValue AddValue(TKey key) - { - TValue value = _valueFactory(key); - lock (_lock) - { - if (_dictionary == null) - { - _dictionary = new Dictionary(); - _dictionary[key] = value; - } - else - { - TValue val; - if (_dictionary.TryGetValue(key, out val)) - return val; - Dictionary dict = new Dictionary(_dictionary); - dict[key] = value; - _dictionary = dict; - } - } - return value; - } - - public void Add(TKey key, TValue value) - { - throw new NotImplementedException(); - } - - public bool ContainsKey(TKey key) - { - return _dictionary.ContainsKey(key); - } - - public ICollection Keys - { - get { return _dictionary.Keys; } - } - - public bool Remove(TKey key) - { - throw new NotImplementedException(); - } - - public bool TryGetValue(TKey key, out TValue value) - { - value = this[key]; - return true; - } - - public ICollection Values - { - get { return _dictionary.Values; } - } - - public TValue this[TKey key] - { - get { return Get(key); } - set { throw new NotImplementedException(); } - } - - public void Add(KeyValuePair item) - { - throw new NotImplementedException(); - } - - public void Clear() - { - throw new NotImplementedException(); - } - - public bool Contains(KeyValuePair item) - { - throw new NotImplementedException(); - } - - public void CopyTo(KeyValuePair[] array, int arrayIndex) - { - throw new NotImplementedException(); - } - - public int Count - { - get { return _dictionary.Count; } - } - - public bool IsReadOnly - { - get { throw new NotImplementedException(); } - } - - public bool Remove(KeyValuePair item) - { - throw new NotImplementedException(); - } - - public IEnumerator> GetEnumerator() - { - return _dictionary.GetEnumerator(); - } - - System.Collections.IEnumerator System.Collections.IEnumerable.GetEnumerator() - { - return _dictionary.GetEnumerator(); - } - } - - } - } -} -// ReSharper restore LoopCanBeConvertedToQuery -// ReSharper restore RedundantExplicitArrayCreation -// ReSharper restore SuggestUseVarKeywordEvident diff --git a/RestSharp.Tests/StringExtensionTests.cs b/RestSharp.Tests/StringExtensionTests.cs deleted file mode 100644 index cc76a44b6..000000000 --- a/RestSharp.Tests/StringExtensionTests.cs +++ /dev/null @@ -1,20 +0,0 @@ -using System.Globalization; -using NUnit.Framework; -using RestSharp.Extensions; - -namespace RestSharp.Tests -{ - [TestFixture] - public class StringExtensionTests - { - [Test] - [TestCase("this_is_a_test", true, "ThisIsATest")] - [TestCase("this_is_a_test", false, "This_Is_A_Test")] - public void ToPascalCase(string start, bool removeUnderscores, string finish) - { - string result = start.ToPascalCase(removeUnderscores, CultureInfo.InvariantCulture); - - Assert.AreEqual(finish, result); - } - } -} diff --git a/RestSharp.Tests/StringExtensionsTests.cs b/RestSharp.Tests/StringExtensionsTests.cs deleted file mode 100644 index ab449f088..000000000 --- a/RestSharp.Tests/StringExtensionsTests.cs +++ /dev/null @@ -1,35 +0,0 @@ -using System; -using NUnit.Framework; -using RestSharp.Extensions; - -namespace RestSharp.Tests -{ - public class StringExtensionsTests - { - [Test] - public void UrlEncode_Throws_ArgumentNullException_For_Null_Input() - { - const string nullString = null; - Assert.Throws( - delegate { nullString.UrlEncode(); }); - } - - [Test] - public void UrlEncode_Returns_Correct_Length_When_Less_Than_Limit() - { - const int numLessThanLimit = 32766; - var stringWithLimitLength = new string('*', numLessThanLimit); - var encodedAndDecoded = stringWithLimitLength.UrlEncode().UrlDecode(); - Assert.AreEqual(numLessThanLimit, encodedAndDecoded.Length); - } - - [Test] - public void UrlEncode_Returns_Correct_Length_When_More_Than_Limit() - { - const int numGreaterThanLimit = 65000; - var stringWithLimitLength = new string('*', numGreaterThanLimit); - var encodedAndDecoded = stringWithLimitLength.UrlEncode().UrlDecode(); - Assert.AreEqual(numGreaterThanLimit, encodedAndDecoded.Length); - } - } -} \ No newline at end of file diff --git a/RestSharp.Tests/UrlBuilderTests.cs b/RestSharp.Tests/UrlBuilderTests.cs deleted file mode 100644 index b140a2dc7..000000000 --- a/RestSharp.Tests/UrlBuilderTests.cs +++ /dev/null @@ -1,302 +0,0 @@ -using System; -using NUnit.Framework; - -namespace RestSharp.Tests -{ - /// - /// Note: These tests do not handle QueryString building, which is handled in Http, not RestClient - /// - [TestFixture] - public class UrlBuilderTests - { - [Test] - public void Should_not_duplicate_question_mark() - { - RestRequest request = new RestRequest(); - - request.AddParameter("param2", "value2"); - - RestClient client = new RestClient("http://example.com/resource?param1=value1"); - Uri expected = new Uri("http://example.com/resource?param1=value1¶m2=value2"); - Uri output = client.BuildUri(request); - - Assert.AreEqual(expected, output); - } - - [Test] - public void GET_with_leading_slash() - { - RestRequest request = new RestRequest("/resource"); - RestClient client = new RestClient(new Uri("http://example.com")); - Uri expected = new Uri("http://example.com/resource"); - Uri output = client.BuildUri(request); - - Assert.AreEqual(expected, output); - } - - [Test] - public void POST_with_leading_slash() - { - RestRequest request = new RestRequest("/resource", Method.POST); - RestClient client = new RestClient(new Uri("http://example.com")); - Uri expected = new Uri("http://example.com/resource"); - Uri output = client.BuildUri(request); - - Assert.AreEqual(expected, output); - } - - [Test] - public void GET_with_leading_slash_and_baseurl_trailing_slash() - { - RestRequest request = new RestRequest("/resource"); - - request.AddParameter("foo", "bar"); - - RestClient client = new RestClient(new Uri("http://example.com")); - Uri expected = new Uri("http://example.com/resource?foo=bar"); - Uri output = client.BuildUri(request); - - Assert.AreEqual(expected, output); - } - - [Test] - public void GET_wth_trailing_slash_and_query_parameters() - { - RestRequest request = new RestRequest("/resource/"); - RestClient client = new RestClient("http://example.com"); - - request.AddParameter("foo", "bar"); - - Uri expected = new Uri("http://example.com/resource/?foo=bar"); - Uri output = client.BuildUri(request); - - client.Execute(request); - - Assert.AreEqual(expected, output); - } - - [Test] - public void POST_with_leading_slash_and_baseurl_trailing_slash() - { - RestRequest request = new RestRequest("/resource", Method.POST); - RestClient client = new RestClient(new Uri("http://example.com")); - Uri expected = new Uri("http://example.com/resource"); - Uri output = client.BuildUri(request); - - Assert.AreEqual(expected, output); - } - - [Test] - public void GET_with_resource_containing_slashes() - { - RestRequest request = new RestRequest("resource/foo"); - RestClient client = new RestClient(new Uri("http://example.com")); - Uri expected = new Uri("http://example.com/resource/foo"); - Uri output = client.BuildUri(request); - - Assert.AreEqual(expected, output); - } - - [Test] - public void POST_with_resource_containing_slashes() - { - RestRequest request = new RestRequest("resource/foo", Method.POST); - RestClient client = new RestClient(new Uri("http://example.com")); - Uri expected = new Uri("http://example.com/resource/foo"); - Uri output = client.BuildUri(request); - - Assert.AreEqual(expected, output); - } - - [Test] - public void GET_with_resource_containing_tokens() - { - RestRequest request = new RestRequest("resource/{foo}"); - - request.AddUrlSegment("foo", "bar"); - - RestClient client = new RestClient(new Uri("http://example.com")); - Uri expected = new Uri("http://example.com/resource/bar"); - Uri output = client.BuildUri(request); - - Assert.AreEqual(expected, output); - } - - [Test] - public void GET_with_resource_containing_null_token() - { - RestRequest request = new RestRequest("/resource/{foo}", Method.GET); - - request.AddUrlSegment("foo", null); - - RestClient client = new RestClient("http://example.com/api/1.0"); - ArgumentException exception = Assert.Throws(() => client.BuildUri(request)); - - Assert.IsNotNull(exception); - Assert.False(string.IsNullOrEmpty(exception.Message)); - Assert.IsTrue(exception.Message.Contains("foo")); - } - - [Test] - public void POST_with_resource_containing_tokens() - { - RestRequest request = new RestRequest("resource/{foo}", Method.POST); - - request.AddUrlSegment("foo", "bar"); - - RestClient client = new RestClient(new Uri("http://example.com")); - Uri expected = new Uri("http://example.com/resource/bar"); - Uri output = client.BuildUri(request); - - Assert.AreEqual(expected, output); - } - - [Test] - public void GET_with_empty_request() - { - RestRequest request = new RestRequest(); - RestClient client = new RestClient(new Uri("http://example.com")); - Uri expected = new Uri("http://example.com/"); - Uri output = client.BuildUri(request); - - Assert.AreEqual(expected, output); - } - - [Test] - public void GET_with_empty_request_and_bare_hostname() - { - RestRequest request = new RestRequest(); - RestClient client = new RestClient(new Uri("http://example.com")); - Uri expected = new Uri("http://example.com/"); - Uri output = client.BuildUri(request); - - Assert.AreEqual(expected, output); - } - - [Test] - public void POST_with_querystring_containing_tokens() - { - RestRequest request = new RestRequest("resource", Method.POST); - - request.AddParameter("foo", "bar", ParameterType.QueryString); - - RestClient client = new RestClient("http://example.com"); - Uri expected = new Uri("http://example.com/resource?foo=bar"); - Uri output = client.BuildUri(request); - - Assert.AreEqual(expected, output); - } - - [Test] - public void GET_with_multiple_instances_of_same_key() - { - RestRequest request = new RestRequest("v1/people/~/network/updates", Method.GET); - - request.AddParameter("type", "STAT"); - request.AddParameter("type", "PICT"); - request.AddParameter("count", "50"); - request.AddParameter("start", "50"); - - RestClient client = new RestClient("http://api.linkedin.com"); - Uri expected = new Uri("http://api.linkedin.com/v1/people/~/network/updates?type=STAT&type=PICT&count=50&start=50"); - Uri output = client.BuildUri(request); - - Assert.AreEqual(expected, output); - } - - [Test] - public void GET_with_Uri_containing_tokens() - { - RestRequest request = new RestRequest(); - - request.AddUrlSegment("foo", "bar"); - - RestClient client = new RestClient(new Uri("http://example.com/{foo}")); - Uri expected = new Uri("http://example.com/bar"); - Uri output = client.BuildUri(request); - - Assert.AreEqual(expected, output); - } - - [Test] - public void GET_with_Url_string_containing_tokens() - { - RestRequest request = new RestRequest(); - - request.AddUrlSegment("foo", "bar"); - - RestClient client = new RestClient("http://example.com/{foo}"); - Uri expected = new Uri("http://example.com/bar"); - Uri output = client.BuildUri(request); - - Assert.AreEqual(expected, output); - } - - [Test] - public void GET_with_Uri_and_resource_containing_tokens() - { - RestRequest request = new RestRequest("resource/{baz}"); - - request.AddUrlSegment("foo", "bar"); - request.AddUrlSegment("baz", "bat"); - - RestClient client = new RestClient(new Uri("http://example.com/{foo}")); - Uri expected = new Uri("http://example.com/bar/resource/bat"); - Uri output = client.BuildUri(request); - - Assert.AreEqual(expected, output); - } - - [Test] - public void GET_with_Url_string_and_resource_containing_tokens() - { - RestRequest request = new RestRequest("resource/{baz}"); - - request.AddUrlSegment("foo", "bar"); - request.AddUrlSegment("baz", "bat"); - - RestClient client = new RestClient("http://example.com/{foo}"); - Uri expected = new Uri("http://example.com/bar/resource/bat"); - Uri output = client.BuildUri(request); - - Assert.AreEqual(expected, output); - } - - [Test] - public void GET_with_Invalid_Url_string_throws_exception() - { - Assert.Throws(delegate { new RestClient("invalid url"); }); - } - - [Test] - public void Should_add_parameter_if_it_is_new() - { - RestRequest request = new RestRequest(); - - request.AddOrUpdateParameter("param2", "value2"); - request.AddOrUpdateParameter("param3", "value3"); - - RestClient client = new RestClient("http://example.com/resource?param1=value1"); - Uri expected = new Uri("http://example.com/resource?param1=value1¶m2=value2¶m3=value3"); - Uri output = client.BuildUri(request); - - Assert.AreEqual(expected, output); - } - - [Test] - public void Should_update_parameter_if_it_already_exists() - { - RestRequest request = new RestRequest(); - - request.AddOrUpdateParameter("param2", "value2"); - request.AddOrUpdateParameter("param2", "value2-1"); - - RestClient client = new RestClient("http://example.com/resource?param1=value1"); - Uri expected = new Uri("http://example.com/resource?param1=value1¶m2=value2-1"); - Uri output = client.BuildUri(request); - - Assert.AreEqual(expected, output); - } - - } -} diff --git a/RestSharp.Tests/XmlAttributeDeserializerTests.cs b/RestSharp.Tests/XmlAttributeDeserializerTests.cs deleted file mode 100644 index 412d99d21..000000000 --- a/RestSharp.Tests/XmlAttributeDeserializerTests.cs +++ /dev/null @@ -1,917 +0,0 @@ -#region License - -// Copyright 2010 John Sheehan -// -// Licensed under the Apache License, Version 2.0 (the "License"); -// you may not use this file except in compliance with the License. -// You may obtain a copy of the License at -// -// http://www.apache.org/licenses/LICENSE-2.0 -// -// Unless required by applicable law or agreed to in writing, software -// distributed under the License is distributed on an "AS IS" BASIS, -// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -// See the License for the specific language governing permissions and -// limitations under the License. - -#endregion - -using System; -using System.Collections.Generic; -using System.Globalization; -using System.IO; -using System.Linq; -using System.Xml.Linq; -using NUnit.Framework; -using RestSharp.Deserializers; -using RestSharp.Tests.SampleClasses; -using Event = RestSharp.Tests.SampleClasses.Lastfm.Event; - -namespace RestSharp.Tests -{ - public class XmlAttributeDeserializerTests - { - private const string GUID_STRING = "AC1FC4BC-087A-4242-B8EE-C53EBE9887A5"; - - private readonly string sampleDataPath = Path.Combine(AppDomain.CurrentDomain.BaseDirectory, "SampleData"); - - private string PathFor(string sampleFile) - { - return Path.Combine(this.sampleDataPath, sampleFile); - } - - [Test] - public void Can_Deserialize_Lists_of_Simple_Types() - { - string xmlpath = this.PathFor("xmllists.xml"); - XDocument doc = XDocument.Load(xmlpath); - XmlAttributeDeserializer xml = new XmlAttributeDeserializer(); - SimpleTypesListSample output = xml.Deserialize( - new RestResponse { Content = doc.ToString() }); - - Assert.IsNotEmpty(output.Names); - Assert.IsNotEmpty(output.Numbers); - Assert.False(output.Names[0].Length == 0); - Assert.False(output.Numbers.Sum() == 0); - } - - [Test] - public void Can_Deserialize_To_List_Inheritor_From_Custom_Root_With_Attributes() - { - string xmlpath = this.PathFor("ListWithAttributes.xml"); - XDocument doc = XDocument.Load(xmlpath); - XmlAttributeDeserializer xml = new XmlAttributeDeserializer { RootElement = "Calls" }; - TwilioCallList output = xml.Deserialize(new RestResponse { Content = doc.ToString() }); - - Assert.AreEqual(3, output.NumPages); - Assert.IsNotEmpty(output); - Assert.AreEqual(2, output.Count); - } - - [Test] - public void Can_Deserialize_To_Standalone_List_Without_Matching_Class_Case() - { - string xmlpath = this.PathFor("InlineListSample.xml"); - XDocument doc = XDocument.Load(xmlpath); - XmlAttributeDeserializer xml = new XmlAttributeDeserializer(); - List output = xml.Deserialize>(new RestResponse { Content = doc.ToString() }); - - Assert.IsNotEmpty(output); - Assert.AreEqual(4, output.Count); - } - - [Test] - public void Can_Deserialize_To_Standalone_List_With_Matching_Class_Case() - { - string xmlpath = this.PathFor("InlineListSample.xml"); - XDocument doc = XDocument.Load(xmlpath); - XmlAttributeDeserializer xml = new XmlAttributeDeserializer(); - List output = xml.Deserialize>(new RestResponse { Content = doc.ToString() }); - - Assert.IsNotEmpty(output); - Assert.AreEqual(4, output.Count); - } - - [Test] - public void Can_Deserialize_Directly_To_Lists_Off_Root_Element() - { - string xmlpath = this.PathFor("directlists.xml"); - XDocument doc = XDocument.Load(xmlpath); - XmlAttributeDeserializer xml = new XmlAttributeDeserializer(); - List output = xml.Deserialize>(new RestResponse { Content = doc.ToString() }); - - Assert.IsNotEmpty(output); - Assert.AreEqual(2, output.Count); - } - - [Test] - public void Can_Deserialize_Parentless_aka_Inline_List_Items_Without_Matching_Class_Name() - { - string xmlpath = this.PathFor("InlineListSample.xml"); - XDocument doc = XDocument.Load(xmlpath); - XmlAttributeDeserializer xml = new XmlAttributeDeserializer(); - InlineListSample output = xml.Deserialize(new RestResponse { Content = doc.ToString() }); - - Assert.IsNotEmpty(output.Images); - Assert.AreEqual(4, output.Images.Count); - } - - [Test] - public void Can_Deserialize_Parentless_aka_Inline_List_Items_With_Matching_Class_Name() - { - string xmlpath = this.PathFor("InlineListSample.xml"); - XDocument doc = XDocument.Load(xmlpath); - XmlAttributeDeserializer xml = new XmlAttributeDeserializer(); - InlineListSample output = xml.Deserialize(new RestResponse { Content = doc.ToString() }); - - Assert.IsNotEmpty(output.images); - Assert.AreEqual(4, output.images.Count); - } - - [Test] - public void Can_Deserialize_Parentless_aka_Inline_List_Items_With_Matching_Class_Name_With_Additional_Property() - { - string xmlpath = this.PathFor("InlineListSample.xml"); - XDocument doc = XDocument.Load(xmlpath); - XmlAttributeDeserializer xml = new XmlAttributeDeserializer(); - InlineListSample output = xml.Deserialize(new RestResponse { Content = doc.ToString() }); - - Assert.AreEqual(4, output.Count); - } - - [Test] - public void Can_Deserialize_Nested_List_Items_Without_Matching_Class_Name() - { - string xmlpath = this.PathFor("NestedListSample.xml"); - XDocument doc = XDocument.Load(xmlpath); - XmlAttributeDeserializer xml = new XmlAttributeDeserializer(); - InlineListSample output = xml.Deserialize(new RestResponse { Content = doc.ToString() }); - - Assert.IsNotEmpty(output.Images); - Assert.AreEqual(4, output.Images.Count); - } - - [Test] - public void Can_Deserialize_Nested_List_Items_With_Matching_Class_Name() - { - string xmlpath = this.PathFor("NestedListSample.xml"); - XDocument doc = XDocument.Load(xmlpath); - XmlAttributeDeserializer xml = new XmlAttributeDeserializer(); - InlineListSample output = xml.Deserialize(new RestResponse { Content = doc.ToString() }); - - Assert.IsNotEmpty(output.images); - Assert.AreEqual(4, output.images.Count); - } - - [Test] - public void Can_Deserialize_Nested_List_Without_Elements_To_Empty_List() - { - string doc = CreateXmlWithEmptyNestedList(); - XmlAttributeDeserializer xml = new XmlAttributeDeserializer(); - EmptyListSample output = xml.Deserialize(new RestResponse { Content = doc }); - - Assert.NotNull(output.images); - Assert.NotNull(output.Images); - Assert.IsEmpty(output.images); - Assert.IsEmpty(output.Images); - } - - [Test] - public void Can_Deserialize_Inline_List_Without_Elements_To_Empty_List() - { - string doc = CreateXmlWithEmptyInlineList(); - XmlAttributeDeserializer xml = new XmlAttributeDeserializer(); - EmptyListSample output = xml.Deserialize(new RestResponse { Content = doc }); - - Assert.NotNull(output.images); - Assert.NotNull(output.Images); - Assert.IsEmpty(output.images); - Assert.IsEmpty(output.Images); - } - - [Test] - public void Can_Deserialize_Empty_Elements_to_Nullable_Values() - { - string doc = CreateXmlWithNullValues(); - XmlAttributeDeserializer xml = new XmlAttributeDeserializer(); - NullableValues output = xml.Deserialize(new RestResponse { Content = doc }); - - Assert.Null(output.Id); - Assert.Null(output.StartDate); - Assert.Null(output.UniqueId); - } - - [Test] - public void Can_Deserialize_Elements_to_Nullable_Values() - { - CultureInfo culture = CultureInfo.InvariantCulture; - string doc = CreateXmlWithoutEmptyValues(culture); - XmlAttributeDeserializer xml = new XmlAttributeDeserializer - { - Culture = culture - }; - NullableValues output = xml.Deserialize(new RestResponse { Content = doc }); - - Assert.NotNull(output.Id); - Assert.NotNull(output.StartDate); - Assert.NotNull(output.UniqueId); - Assert.AreEqual(123, output.Id); - Assert.AreEqual(new DateTime(2010, 2, 21, 9, 35, 00), output.StartDate); - Assert.AreEqual(new Guid(GUID_STRING), output.UniqueId); - } - - [Test] - public void Can_Deserialize_TimeSpan() - { - CultureInfo culture = CultureInfo.InvariantCulture; - XDocument doc = new XDocument(culture); - - TimeSpan? nullTimespan = null; - TimeSpan? nullValueTimeSpan = new TimeSpan(21, 30, 7); - - XElement root = new XElement("Person"); - - root.Add(new XElement("Tick", new TimeSpan(468006))); - root.Add(new XElement("Millisecond", new TimeSpan(0, 0, 0, 0, 125))); - root.Add(new XElement("Second", new TimeSpan(0, 0, 8))); - root.Add(new XElement("Minute", new TimeSpan(0, 55, 2))); - root.Add(new XElement("Hour", new TimeSpan(21, 30, 7))); - root.Add(new XElement("NullableWithoutValue", nullTimespan)); - root.Add(new XElement("NullableWithValue", nullValueTimeSpan)); - - doc.Add(root); - - RestResponse response = new RestResponse { Content = doc.ToString() }; - XmlAttributeDeserializer d = new XmlAttributeDeserializer { Culture = culture }; - TimeSpanTestStructure payload = d.Deserialize(response); - - Assert.AreEqual(new TimeSpan(468006), payload.Tick); - Assert.AreEqual(new TimeSpan(0, 0, 0, 0, 125), payload.Millisecond); - Assert.AreEqual(new TimeSpan(0, 0, 8), payload.Second); - Assert.AreEqual(new TimeSpan(0, 55, 2), payload.Minute); - Assert.AreEqual(new TimeSpan(21, 30, 7), payload.Hour); - Assert.Null(payload.NullableWithoutValue); - Assert.NotNull(payload.NullableWithValue); - Assert.AreEqual(new TimeSpan(21, 30, 7), payload.NullableWithValue.Value); - } - - [Test] - public void Can_Deserialize_Custom_Formatted_Date() - { - CultureInfo culture = CultureInfo.InvariantCulture; - const string format = "dd yyyy MMM, hh:mm ss tt zzz"; - DateTime date = new DateTime(2010, 2, 8, 11, 11, 11); - XDocument doc = new XDocument(); - XElement root = new XElement("Person"); - - root.Add(new XElement("StartDate", date.ToString(format, culture))); - - doc.Add(root); - - XmlAttributeDeserializer xml = new XmlAttributeDeserializer - { - DateFormat = format, - Culture = culture - }; - RestResponse response = new RestResponse { Content = doc.ToString() }; - PersonForXml output = xml.Deserialize(response); - - Assert.AreEqual(date, output.StartDate); - } - - [Test] - public void Can_Deserialize_Nested_Class() - { - string doc = CreateElementsXml(); - RestResponse response = new RestResponse { Content = doc }; - XmlAttributeDeserializer d = new XmlAttributeDeserializer(); - PersonForXml p = d.Deserialize(response); - - Assert.NotNull(p.FavoriteBand); - Assert.AreEqual("Goldfinger", p.FavoriteBand.Name); - } - - [Test] - public void Can_Deserialize_Elements_On_Default_Root() - { - string doc = CreateElementsXml(); - RestResponse response = new RestResponse { Content = doc }; - XmlAttributeDeserializer d = new XmlAttributeDeserializer(); - PersonForXml p = d.Deserialize(response); - - Assert.AreEqual("John Sheehan", p.Name); - Assert.AreEqual(new DateTime(2009, 9, 25, 0, 6, 1), p.StartDate); - Assert.AreEqual(28, p.Age); - Assert.AreEqual(long.MaxValue, p.BigNumber); - Assert.AreEqual(99.9999m, p.Percent); - Assert.AreEqual(false, p.IsCool); - Assert.AreEqual(new Guid(GUID_STRING), p.UniqueId); - Assert.AreEqual(Guid.Empty, p.EmptyGuid); - Assert.AreEqual(new Uri("http://example.com", UriKind.RelativeOrAbsolute), p.Url); - Assert.AreEqual(new Uri("/foo/bar", UriKind.RelativeOrAbsolute), p.UrlPath); - Assert.AreEqual(Order.Third, p.Order); - Assert.AreEqual(Disposition.SoSo, p.Disposition); - Assert.NotNull(p.Friends); - Assert.AreEqual(10, p.Friends.Count); - Assert.NotNull(p.BestFriend); - Assert.AreEqual("The Fonz", p.BestFriend.Name); - Assert.AreEqual(1952, p.BestFriend.Since); - } - - [Test] - public void Can_Deserialize_Attributes_On_Default_Root() - { - string doc = CreateAttributesXml(); - RestResponse response = new RestResponse { Content = doc }; - XmlAttributeDeserializer d = new XmlAttributeDeserializer(); - PersonForXml p = d.Deserialize(response); - - Assert.AreEqual("John Sheehan", p.Name); - Assert.AreEqual(new DateTime(2009, 9, 25, 0, 6, 1), p.StartDate); - Assert.AreEqual(28, p.Age); - Assert.AreEqual(long.MaxValue, p.BigNumber); - Assert.AreEqual(99.9999m, p.Percent); - Assert.AreEqual(false, p.IsCool); - Assert.AreEqual(new Guid(GUID_STRING), p.UniqueId); - Assert.AreEqual(new Uri("http://example.com", UriKind.RelativeOrAbsolute), p.Url); - Assert.AreEqual(new Uri("/foo/bar", UriKind.RelativeOrAbsolute), p.UrlPath); - Assert.NotNull(p.BestFriend); - Assert.AreEqual("The Fonz", p.BestFriend.Name); - Assert.AreEqual(1952, p.BestFriend.Since); - } - - [Test] - public void Ignore_Protected_Property_That_Exists_In_Data() - { - string doc = CreateElementsXml(); - RestResponse response = new RestResponse { Content = doc }; - XmlAttributeDeserializer d = new XmlAttributeDeserializer(); - PersonForXml p = d.Deserialize(response); - - Assert.Null(p.IgnoreProxy); - } - - [Test] - public void Ignore_ReadOnly_Property_That_Exists_In_Data() - { - string doc = CreateElementsXml(); - RestResponse response = new RestResponse { Content = doc }; - XmlAttributeDeserializer d = new XmlAttributeDeserializer(); - PersonForXml p = d.Deserialize(response); - - Assert.Null(p.ReadOnlyProxy); - } - - [Test] - public void Can_Deserialize_Names_With_Underscores_On_Default_Root() - { - string doc = CreateUnderscoresXml(); - RestResponse response = new RestResponse { Content = doc }; - XmlAttributeDeserializer d = new XmlAttributeDeserializer(); - PersonForXml p = d.Deserialize(response); - - Assert.AreEqual("John Sheehan", p.Name); - Assert.AreEqual(new DateTime(2009, 9, 25, 0, 6, 1), p.StartDate); - Assert.AreEqual(28, p.Age); - Assert.AreEqual(long.MaxValue, p.BigNumber); - Assert.AreEqual(99.9999m, p.Percent); - Assert.AreEqual(false, p.IsCool); - Assert.AreEqual(new Guid(GUID_STRING), p.UniqueId); - Assert.AreEqual(new Uri("http://example.com", UriKind.RelativeOrAbsolute), p.Url); - Assert.AreEqual(new Uri("/foo/bar", UriKind.RelativeOrAbsolute), p.UrlPath); - Assert.NotNull(p.Friends); - Assert.AreEqual(10, p.Friends.Count); - Assert.NotNull(p.BestFriend); - Assert.AreEqual("The Fonz", p.BestFriend.Name); - Assert.AreEqual(1952, p.BestFriend.Since); - Assert.NotNull(p.Foes); - Assert.AreEqual(5, p.Foes.Count); - Assert.AreEqual("Yankees", p.Foes.Team); - } - - [Test] - public void Can_Deserialize_Names_With_Dashes_On_Default_Root() - { - string doc = CreateDashesXml(); - RestResponse response = new RestResponse { Content = doc }; - XmlAttributeDeserializer d = new XmlAttributeDeserializer(); - PersonForXml p = d.Deserialize(response); - - Assert.AreEqual("John Sheehan", p.Name); - Assert.AreEqual(new DateTime(2009, 9, 25, 0, 6, 1), p.StartDate); - Assert.AreEqual(28, p.Age); - Assert.AreEqual(long.MaxValue, p.BigNumber); - Assert.AreEqual(99.9999m, p.Percent); - Assert.AreEqual(false, p.IsCool); - Assert.AreEqual(new Guid(GUID_STRING), p.UniqueId); - Assert.AreEqual(new Uri("http://example.com", UriKind.RelativeOrAbsolute), p.Url); - Assert.AreEqual(new Uri("/foo/bar", UriKind.RelativeOrAbsolute), p.UrlPath); - Assert.NotNull(p.Friends); - Assert.AreEqual(10, p.Friends.Count); - Assert.NotNull(p.BestFriend); - Assert.AreEqual("The Fonz", p.BestFriend.Name); - Assert.AreEqual(1952, p.BestFriend.Since); - Assert.NotNull(p.Foes); - Assert.AreEqual(5, p.Foes.Count); - Assert.AreEqual("Yankees", p.Foes.Team); - } - - [Test] - public void Can_Deserialize_Names_With_Underscores_Without_Matching_Case_On_Default_Root() - { - string doc = CreateLowercaseUnderscoresXml(); - RestResponse response = new RestResponse { Content = doc }; - XmlAttributeDeserializer d = new XmlAttributeDeserializer(); - PersonForXml p = d.Deserialize(response); - - Assert.AreEqual("John Sheehan", p.Name); - Assert.AreEqual(new DateTime(2009, 9, 25, 0, 6, 1), p.StartDate); - Assert.AreEqual(28, p.Age); - Assert.AreEqual(long.MaxValue, p.BigNumber); - Assert.AreEqual(99.9999m, p.Percent); - Assert.AreEqual(false, p.IsCool); - Assert.AreEqual(new Guid(GUID_STRING), p.UniqueId); - Assert.AreEqual(new Uri("http://example.com", UriKind.RelativeOrAbsolute), p.Url); - Assert.AreEqual(new Uri("/foo/bar", UriKind.RelativeOrAbsolute), p.UrlPath); - Assert.NotNull(p.Friends); - Assert.AreEqual(10, p.Friends.Count); - Assert.NotNull(p.BestFriend); - Assert.AreEqual("The Fonz", p.BestFriend.Name); - Assert.AreEqual(1952, p.BestFriend.Since); - Assert.NotNull(p.Foes); - Assert.AreEqual(5, p.Foes.Count); - Assert.AreEqual("Yankees", p.Foes.Team); - } - - [Test] - public void Can_Deserialize_Lower_Cased_Root_Elements_With_Dashes() - { - string doc = CreateDashesXml(); - RestResponse response = new RestResponse { Content = doc }; - XmlAttributeDeserializer d = new XmlAttributeDeserializer(); - PersonForXml p = d.Deserialize(response); - - Assert.AreEqual("John Sheehan", p.Name); - Assert.AreEqual(new DateTime(2009, 9, 25, 0, 6, 1), p.StartDate); - Assert.AreEqual(28, p.Age); - Assert.AreEqual(long.MaxValue, p.BigNumber); - Assert.AreEqual(99.9999m, p.Percent); - Assert.AreEqual(false, p.IsCool); - Assert.AreEqual(new Guid(GUID_STRING), p.UniqueId); - Assert.AreEqual(new Uri("http://example.com", UriKind.RelativeOrAbsolute), p.Url); - Assert.AreEqual(new Uri("/foo/bar", UriKind.RelativeOrAbsolute), p.UrlPath); - Assert.NotNull(p.Friends); - Assert.AreEqual(10, p.Friends.Count); - Assert.NotNull(p.BestFriend); - Assert.AreEqual("The Fonz", p.BestFriend.Name); - Assert.AreEqual(1952, p.BestFriend.Since); - Assert.NotNull(p.Foes); - Assert.AreEqual(5, p.Foes.Count); - Assert.AreEqual("Yankees", p.Foes.Team); - } - - [Test] - public void Can_Deserialize_Root_Elements_Without_Matching_Case_And_Dashes() - { - string doc = CreateLowerCasedRootElementWithDashesXml(); - RestResponse response = new RestResponse { Content = doc }; - XmlAttributeDeserializer d = new XmlAttributeDeserializer(); - List p = d.Deserialize>(response); - - Assert.NotNull(p); - Assert.AreEqual(1, p.Count); - Assert.AreEqual(45, p[0].ConceptId); - } - - [Test] - public void Can_Deserialize_Eventful_Xml() - { - string xmlpath = this.PathFor("eventful.xml"); - XDocument doc = XDocument.Load(xmlpath); - RestResponse response = new RestResponse { Content = doc.ToString() }; - XmlAttributeDeserializer d = new XmlAttributeDeserializer(); - VenueSearch output = d.Deserialize(response); - - Assert.IsNotEmpty(output.venues); - Assert.AreEqual(3, output.venues.Count); - Assert.AreEqual("Tivoli", output.venues[0].name); - Assert.AreEqual("http://eventful.com/brisbane/venues/tivoli-/V0-001-002169294-8", output.venues[1].url); - Assert.AreEqual("V0-001-000266914-3", output.venues[2].id); - } - - [Test] - public void Can_Deserialize_Lastfm_Xml() - { - string xmlpath = this.PathFor("Lastfm.xml"); - XDocument doc = XDocument.Load(xmlpath); - RestResponse response = new RestResponse { Content = doc.ToString() }; - XmlAttributeDeserializer d = new XmlAttributeDeserializer(); - Event output = d.Deserialize(response); - - //Assert.IsNotEmpty(output.artists); - Assert.AreEqual("http://www.last.fm/event/328799+Philip+Glass+at+Barbican+Centre+on+12+June+2008", output.url); - Assert.AreEqual("http://www.last.fm/venue/8777860+Barbican+Centre", output.venue.url); - } - - [Test] - public void Can_Deserialize_Google_Weather_Xml() - { - string xmlpath = this.PathFor("GoogleWeather.xml"); - XDocument doc = XDocument.Load(xmlpath); - RestResponse response = new RestResponse { Content = doc.ToString() }; - XmlAttributeDeserializer d = new XmlAttributeDeserializer(); - xml_api_reply output = d.Deserialize(response); - - Assert.IsNotEmpty(output.weather); - Assert.AreEqual(4, output.weather.Count); - Assert.AreEqual("Sunny", output.weather[0].condition.data); - } - - [Test] - public void Can_Deserialize_Google_Weather_Xml_WithDeserializeAs() - { - string xmlpath = this.PathFor("GoogleWeather.xml"); - XDocument doc = XDocument.Load(xmlpath); - RestResponse response = new RestResponse { Content = doc.ToString() }; - XmlAttributeDeserializer d = new XmlAttributeDeserializer(); - GoogleWeatherApi output = d.Deserialize(response); - - Assert.IsNotEmpty(output.Weather); - Assert.AreEqual(4, output.Weather.Count); - Assert.AreEqual("Sunny", output.Weather[0].Condition.Data); - } - - [Test] - public void Can_Deserialize_Boolean_From_Number() - { - string xmlpath = this.PathFor("boolean_from_number.xml"); - XDocument doc = XDocument.Load(xmlpath); - RestResponse response = new RestResponse { Content = doc.ToString() }; - XmlAttributeDeserializer d = new XmlAttributeDeserializer(); - BooleanTest output = d.Deserialize(response); - - Assert.True(output.Value); - } - - [Test] - public void Can_Deserialize_Boolean_From_String() - { - string xmlpath = this.PathFor("boolean_from_string.xml"); - XDocument doc = XDocument.Load(xmlpath); - RestResponse response = new RestResponse { Content = doc.ToString() }; - XmlAttributeDeserializer d = new XmlAttributeDeserializer(); - BooleanTest output = d.Deserialize(response); - - Assert.True(output.Value); - } - - [Test] - public void Can_Deserialize_Empty_Elements_With_Attributes_to_Nullable_Values() - { - string doc = CreateXmlWithAttributesAndNullValues(); - XmlAttributeDeserializer xml = new XmlAttributeDeserializer(); - NullableValues output = xml.Deserialize(new RestResponse { Content = doc }); - - Assert.Null(output.Id); - Assert.Null(output.StartDate); - Assert.Null(output.UniqueId); - } - - [Test] - public void Can_Deserialize_Mixture_Of_Empty_Elements_With_Attributes_And_Populated_Elements() - { - string doc = CreateXmlWithAttributesAndNullValuesAndPopulatedValues(); - XmlAttributeDeserializer xml = new XmlAttributeDeserializer(); - NullableValues output = xml.Deserialize(new RestResponse { Content = doc }); - - Assert.Null(output.Id); - Assert.Null(output.StartDate); - Assert.AreEqual(new Guid(GUID_STRING), output.UniqueId); - } - - [Test] - public void Can_Deserialize_DateTimeOffset() - { - CultureInfo culture = CultureInfo.InvariantCulture; - XDocument doc = new XDocument(culture); - - DateTimeOffset dateTimeOffset = new DateTimeOffset(2013, 02, 08, 9, 18, 22, TimeSpan.FromHours(10)); - DateTimeOffset? nullableDateTimeOffsetWithValue = new DateTimeOffset(2013, 02, 08, 9, 18, 23, TimeSpan.FromHours(10)); - - XElement root = new XElement("Dates"); - - root.Add(new XElement("DateTimeOffset", dateTimeOffset)); - root.Add(new XElement("NullableDateTimeOffsetWithNull", string.Empty)); - root.Add(new XElement("NullableDateTimeOffsetWithValue", nullableDateTimeOffsetWithValue)); - - doc.Add(root); - - //var xml = new XmlAttributeDeserializer { Culture = culture }; - RestResponse response = new RestResponse { Content = doc.ToString() }; - XmlAttributeDeserializer d = new XmlAttributeDeserializer { Culture = culture }; - DateTimeTestStructure payload = d.Deserialize(response); - - Assert.AreEqual(dateTimeOffset, payload.DateTimeOffset); - Assert.Null(payload.NullableDateTimeOffsetWithNull); - Assert.True(payload.NullableDateTimeOffsetWithValue.HasValue); - Assert.AreEqual(nullableDateTimeOffsetWithValue, payload.NullableDateTimeOffsetWithValue); - } - - private static string CreateUnderscoresXml() - { - XDocument doc = new XDocument(); - XElement root = new XElement("Person"); - - root.Add(new XElement("Name", "John Sheehan")); - root.Add(new XElement("Start_Date", new DateTime(2009, 9, 25, 0, 6, 1))); - root.Add(new XAttribute("Age", 28)); - root.Add(new XElement("Percent", 99.9999m)); - root.Add(new XElement("Big_Number", long.MaxValue)); - root.Add(new XAttribute("Is_Cool", false)); - root.Add(new XElement("Ignore", "dummy")); - root.Add(new XAttribute("Read_Only", "dummy")); - root.Add(new XElement("Unique_Id", new Guid(GUID_STRING))); - root.Add(new XElement("Url", "http://example.com")); - root.Add(new XElement("Url_Path", "/foo/bar")); - root.Add(new XElement("Best_Friend", - new XElement("Name", "The Fonz"), - new XAttribute("Since", 1952))); - - XElement friends = new XElement("Friends"); - - for (int i = 0; i < 10; i++) - { - friends.Add(new XElement("Friend", - new XElement("Name", "Friend" + i), - new XAttribute("Since", DateTime.Now.Year - i))); - } - - root.Add(friends); - - XElement foes = new XElement("Foes"); - - foes.Add(new XAttribute("Team", "Yankees")); - - for (int i = 0; i < 5; i++) - { - foes.Add(new XElement("Foe", new XElement("Nickname", "Foe" + i))); - } - - root.Add(foes); - doc.Add(root); - - return doc.ToString(); - } - - private static string CreateLowercaseUnderscoresXml() - { - XDocument doc = new XDocument(); - XElement root = new XElement("Person"); - - root.Add(new XElement("Name", "John Sheehan")); - root.Add(new XElement("start_date", new DateTime(2009, 9, 25, 0, 6, 1))); - root.Add(new XAttribute("Age", 28)); - root.Add(new XElement("Percent", 99.9999m)); - root.Add(new XElement("big_number", long.MaxValue)); - root.Add(new XAttribute("is_cool", false)); - root.Add(new XElement("Ignore", "dummy")); - root.Add(new XAttribute("read_only", "dummy")); - root.Add(new XElement("unique_id", new Guid(GUID_STRING))); - root.Add(new XElement("Url", "http://example.com")); - root.Add(new XElement("url_path", "/foo/bar")); - root.Add(new XElement("best_friend", - new XElement("name", "The Fonz"), - new XAttribute("Since", 1952))); - - XElement friends = new XElement("Friends"); - - for (int i = 0; i < 10; i++) - { - friends.Add(new XElement("Friend", - new XElement("Name", "Friend" + i), - new XAttribute("Since", DateTime.Now.Year - i))); - } - - root.Add(friends); - - XElement foes = new XElement("Foes"); - - foes.Add(new XAttribute("Team", "Yankees")); - - for (int i = 0; i < 5; i++) - { - foes.Add(new XElement("Foe", new XElement("Nickname", "Foe" + i))); - } - - root.Add(foes); - doc.Add(root); - - return doc.ToString(); - } - - private static string CreateDashesXml() - { - XDocument doc = new XDocument(); - XElement root = new XElement("Person"); - - root.Add(new XElement("Name", "John Sheehan")); - root.Add(new XElement("Start_Date", new DateTime(2009, 9, 25, 0, 6, 1))); - root.Add(new XAttribute("Age", 28)); - root.Add(new XElement("Percent", 99.9999m)); - root.Add(new XElement("Big-Number", long.MaxValue)); - root.Add(new XAttribute("Is-Cool", false)); - root.Add(new XElement("Ignore", "dummy")); - root.Add(new XAttribute("Read-Only", "dummy")); - root.Add(new XElement("Unique-Id", new Guid(GUID_STRING))); - root.Add(new XElement("Url", "http://example.com")); - root.Add(new XElement("Url-Path", "/foo/bar")); - root.Add(new XElement("Best-Friend", - new XElement("Name", "The Fonz"), - new XAttribute("Since", 1952))); - - XElement friends = new XElement("Friends"); - - for (int i = 0; i < 10; i++) - { - friends.Add(new XElement("Friend", - new XElement("Name", "Friend" + i), - new XAttribute("Since", DateTime.Now.Year - i))); - } - - root.Add(friends); - - XElement foes = new XElement("Foes"); - - foes.Add(new XAttribute("Team", "Yankees")); - - for (int i = 0; i < 5; i++) - { - foes.Add(new XElement("Foe", new XElement("Nickname", "Foe" + i))); - } - - root.Add(foes); - doc.Add(root); - - return doc.ToString(); - } - - private static string CreateLowerCasedRootElementWithDashesXml() - { - XDocument doc = new XDocument(); - XElement root = new XElement("incoming-invoices", - new XElement("incoming-invoice", - new XElement("concept-id", 45))); - - doc.Add(root); - - return doc.ToString(); - } - - private static string CreateElementsXml() - { - XDocument doc = new XDocument(); - XElement root = new XElement("Person"); - - root.Add(new XElement("Name", "John Sheehan")); - root.Add(new XElement("StartDate", new DateTime(2009, 9, 25, 0, 6, 1))); - root.Add(new XElement("Age", 28)); - root.Add(new XElement("Percent", 99.9999m)); - root.Add(new XElement("BigNumber", long.MaxValue)); - root.Add(new XElement("IsCool", false)); - root.Add(new XElement("Ignore", "dummy")); - root.Add(new XElement("ReadOnly", "dummy")); - root.Add(new XElement("UniqueId", new Guid(GUID_STRING))); - root.Add(new XElement("EmptyGuid", "")); - root.Add(new XElement("Url", "http://example.com")); - root.Add(new XElement("UrlPath", "/foo/bar")); - root.Add(new XElement("Order", "third")); - root.Add(new XElement("Disposition", "so-so")); - root.Add(new XElement("BestFriend", - new XElement("Name", "The Fonz"), - new XElement("Since", 1952))); - - XElement friends = new XElement("Friends"); - - for (int i = 0; i < 10; i++) - { - friends.Add(new XElement("Friend", - new XElement("Name", "Friend" + i), - new XElement("Since", DateTime.Now.Year - i))); - } - - root.Add(friends); - root.Add(new XElement("FavoriteBand", - new XElement("Name", "Goldfinger"))); - - doc.Add(root); - - return doc.ToString(); - } - - private static string CreateAttributesXml() - { - XDocument doc = new XDocument(); - XElement root = new XElement("Person"); - - root.Add(new XAttribute("Name", "John Sheehan")); - root.Add(new XAttribute("StartDate", new DateTime(2009, 9, 25, 0, 6, 1))); - root.Add(new XAttribute("Age", 28)); - root.Add(new XAttribute("Percent", 99.9999m)); - root.Add(new XAttribute("BigNumber", long.MaxValue)); - root.Add(new XAttribute("IsCool", false)); - root.Add(new XAttribute("Ignore", "dummy")); - root.Add(new XAttribute("ReadOnly", "dummy")); - root.Add(new XAttribute("UniqueId", new Guid(GUID_STRING))); - root.Add(new XAttribute("Url", "http://example.com")); - root.Add(new XAttribute("UrlPath", "/foo/bar")); - root.Add(new XElement("BestFriend", - new XAttribute("Name", "The Fonz"), - new XAttribute("Since", 1952))); - - doc.Add(root); - - return doc.ToString(); - } - - private static string CreateXmlWithNullValues() - { - XDocument doc = new XDocument(); - XElement root = new XElement("NullableValues"); - - root.Add(new XElement("Id", null), - new XElement("StartDate", null), - new XElement("UniqueId", null)); - - doc.Add(root); - - return doc.ToString(); - } - - private static string CreateXmlWithoutEmptyValues(CultureInfo culture) - { - XDocument doc = new XDocument(); - XElement root = new XElement("NullableValues"); - - root.Add(new XElement("Id", 123), - new XElement("StartDate", new DateTime(2010, 2, 21, 9, 35, 00).ToString(culture)), - new XElement("UniqueId", new Guid(GUID_STRING))); - - doc.Add(root); - - return doc.ToString(); - } - - private static string CreateXmlWithEmptyNestedList() - { - XDocument doc = new XDocument(); - XElement root = new XElement("EmptyListSample"); - - root.Add(new XElement("Images")); - doc.Add(root); - - return doc.ToString(); - } - - private static string CreateXmlWithEmptyInlineList() - { - XDocument doc = new XDocument(); - XElement root = new XElement("EmptyListSample"); - - doc.Add(root); - - return doc.ToString(); - } - - private static string CreateXmlWithAttributesAndNullValues() - { - XDocument doc = new XDocument(); - XElement root = new XElement("NullableValues"); - XElement idElement = new XElement("Id", null); - - idElement.SetAttributeValue("SomeAttribute", "SomeAttribute_Value"); - root.Add(idElement, - new XElement("StartDate", null), - new XElement("UniqueId", null)); - - doc.Add(root); - - return doc.ToString(); - } - - private static string CreateXmlWithAttributesAndNullValuesAndPopulatedValues() - { - XDocument doc = new XDocument(); - XElement root = new XElement("NullableValues"); - XElement idElement = new XElement("Id", null); - - idElement.SetAttributeValue("SomeAttribute", "SomeAttribute_Value"); - root.Add(idElement, - new XElement("StartDate", null), - new XElement("UniqueId", new Guid(GUID_STRING))); - - doc.Add(root); - - return doc.ToString(); - } - } -} diff --git a/RestSharp.Tests/XmlDeserializerTests.cs b/RestSharp.Tests/XmlDeserializerTests.cs deleted file mode 100644 index 5cb13fe9b..000000000 --- a/RestSharp.Tests/XmlDeserializerTests.cs +++ /dev/null @@ -1,1018 +0,0 @@ -#region License - -// Copyright 2010 John Sheehan -// -// Licensed under the Apache License, Version 2.0 (the "License"); -// you may not use this file except in compliance with the License. -// You may obtain a copy of the License at -// -// http://www.apache.org/licenses/LICENSE-2.0 -// -// Unless required by applicable law or agreed to in writing, software -// distributed under the License is distributed on an "AS IS" BASIS, -// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -// See the License for the specific language governing permissions and -// limitations under the License. - -#endregion - -using System; -using System.Collections.Generic; -using System.Globalization; -using System.IO; -using System.Linq; -using System.Xml.Linq; -using NUnit.Framework; -using RestSharp.Deserializers; -using RestSharp.Tests.SampleClasses; -using Event = RestSharp.Tests.SampleClasses.Lastfm.Event; - -namespace RestSharp.Tests -{ - [TestFixture] - public class XmlDeserializerTests - { - private const string GUID_STRING = "AC1FC4BC-087A-4242-B8EE-C53EBE9887A5"; - - private readonly string sampleDataPath = Path.Combine(AppDomain.CurrentDomain.BaseDirectory, "SampleData"); - - private string PathFor(string sampleFile) - { - return Path.Combine(sampleDataPath, sampleFile); - } - - [Test] - public void Can_Use_DeserializeAs_Attribute() - { - const string content = - "1Jacksonoddball"; - XmlDeserializer xml = new XmlDeserializer(); - Oddball output = xml.Deserialize(new RestResponse { Content = content }); - - Assert.NotNull(output); - Assert.AreEqual("1", output.Sid); - Assert.AreEqual("Jackson", output.FriendlyName); - Assert.AreEqual("oddball", output.GoodPropertyName); - } - - [Test] - public void Can_Use_DeserializeAs_Attribute_for_List() - { - string xmlpath = this.PathFor("deserialize_as_list.xml"); - XDocument doc = XDocument.Load(xmlpath); - XmlDeserializer xml = new XmlDeserializer(); - List output = xml.Deserialize>(new RestResponse { Content = doc.ToString() }); - - Assert.NotNull(output); - Assert.AreEqual("1", output[0].Sid); - } - - [Test] - public void Can_Deserialize_Into_Struct() - { - const string content = "oneOneOnetwoTwoTwo3"; - XmlDeserializer xml = new XmlDeserializer(); - SimpleStruct output = xml.Deserialize(new RestResponse { Content = content }); - - Assert.NotNull(output); - Assert.AreEqual("oneOneOne", output.One); - Assert.AreEqual("twoTwoTwo", output.Two); - Assert.AreEqual(3, output.Three); - } - - [Test] - public void Can_Deserialize_When_RootElement_Deeper_Then_One() - { - const string content = "oneOneOnetwoTwoTwo3"; - XmlDeserializer xml = new XmlDeserializer() { RootElement = "subsubroot" }; - SimpleStruct output = xml.Deserialize(new RestResponse { Content = content }); - - Assert.NotNull(output); - Assert.AreEqual("oneOneOne", output.One); - Assert.AreEqual("twoTwoTwo", output.Two); - Assert.AreEqual(3, output.Three); - } - - [Test] - public void Can_Deserialize_Lists_of_Simple_Types() - { - string xmlpath = this.PathFor("xmllists.xml"); - XDocument doc = XDocument.Load(xmlpath); - XmlDeserializer xml = new XmlDeserializer(); - SimpleTypesListSample output = xml.Deserialize( - new RestResponse { Content = doc.ToString() }); - - Assert.IsNotEmpty(output.Names); - Assert.IsNotEmpty(output.Numbers); - Assert.False(output.Names[0].Length == 0); - Assert.False(output.Numbers.Sum() == 0); - } - - [Test] - public void Can_Deserialize_To_List_Inheritor_From_Custom_Root_With_Attributes() - { - string xmlpath = this.PathFor("ListWithAttributes.xml"); - XDocument doc = XDocument.Load(xmlpath); - XmlDeserializer xml = new XmlDeserializer { RootElement = "Calls" }; - TwilioCallList output = xml.Deserialize(new RestResponse { Content = doc.ToString() }); - - Assert.AreEqual(3, output.NumPages); - Assert.IsNotEmpty(output); - Assert.AreEqual(2, output.Count); - } - - [Test] - public void Can_Deserialize_To_Standalone_List_Without_Matching_Class_Case() - { - string xmlpath = this.PathFor("InlineListSample.xml"); - XDocument doc = XDocument.Load(xmlpath); - XmlDeserializer xml = new XmlDeserializer(); - List output = xml.Deserialize>(new RestResponse { Content = doc.ToString() }); - - Assert.IsNotEmpty(output); - Assert.AreEqual(4, output.Count); - } - - [Test] - public void Can_Deserialize_To_Standalone_List_With_Matching_Class_Case() - { - string xmlpath = this.PathFor("InlineListSample.xml"); - XDocument doc = XDocument.Load(xmlpath); - XmlDeserializer xml = new XmlDeserializer(); - List output = xml.Deserialize>(new RestResponse { Content = doc.ToString() }); - - Assert.IsNotEmpty(output); - Assert.AreEqual(4, output.Count); - } - - [Test] - public void Can_Deserialize_Directly_To_Lists_Off_Root_Element() - { - string xmlpath = this.PathFor("directlists.xml"); - XDocument doc = XDocument.Load(xmlpath); - XmlDeserializer xml = new XmlDeserializer(); - List output = xml.Deserialize>(new RestResponse { Content = doc.ToString() }); - - Assert.IsNotEmpty(output); - Assert.AreEqual(2, output.Count); - } - - [Test] - public void Can_Deserialize_Parentless_aka_Inline_List_Items_Without_Matching_Class_Name() - { - string xmlpath = this.PathFor("InlineListSample.xml"); - XDocument doc = XDocument.Load(xmlpath); - XmlDeserializer xml = new XmlDeserializer(); - InlineListSample output = xml.Deserialize(new RestResponse { Content = doc.ToString() }); - - Assert.IsNotEmpty(output.Images); - Assert.AreEqual(4, output.Images.Count); - } - - [Test] - public void Can_Deserialize_Parentless_aka_Inline_List_Items_With_Matching_Class_Name() - { - string xmlpath = this.PathFor("InlineListSample.xml"); - XDocument doc = XDocument.Load(xmlpath); - XmlDeserializer xml = new XmlDeserializer(); - InlineListSample output = xml.Deserialize(new RestResponse { Content = doc.ToString() }); - - Assert.IsNotEmpty(output.images); - Assert.AreEqual(4, output.images.Count); - } - - [Test] - public void Can_Deserialize_Parentless_aka_Inline_List_Items_With_Matching_Class_Name_With_Additional_Property() - { - string xmlpath = this.PathFor("InlineListSample.xml"); - XDocument doc = XDocument.Load(xmlpath); - XmlDeserializer xml = new XmlDeserializer(); - InlineListSample output = xml.Deserialize(new RestResponse { Content = doc.ToString() }); - - Assert.AreEqual(4, output.Count); - } - - [Test] - public void Can_Deserialize_Nested_List_Items_Without_Matching_Class_Name() - { - string xmlpath = this.PathFor("NestedListSample.xml"); - XDocument doc = XDocument.Load(xmlpath); - XmlDeserializer xml = new XmlDeserializer(); - InlineListSample output = xml.Deserialize(new RestResponse { Content = doc.ToString() }); - - Assert.IsNotEmpty(output.Images); - Assert.AreEqual(4, output.Images.Count); - } - - [Test] - public void Can_Deserialize_Nested_List_Items_With_Matching_Class_Name() - { - string xmlpath = this.PathFor("NestedListSample.xml"); - XDocument doc = XDocument.Load(xmlpath); - XmlDeserializer xml = new XmlDeserializer(); - InlineListSample output = xml.Deserialize(new RestResponse { Content = doc.ToString() }); - - Assert.IsNotEmpty(output.images); - Assert.AreEqual(4, output.images.Count); - } - - [Test] - public void Can_Deserialize_Nested_List_Without_Elements_To_Empty_List() - { - string doc = CreateXmlWithEmptyNestedList(); - XmlDeserializer xml = new XmlDeserializer(); - EmptyListSample output = xml.Deserialize(new RestResponse { Content = doc }); - - Assert.NotNull(output.images); - Assert.NotNull(output.Images); - Assert.IsEmpty(output.images); - Assert.IsEmpty(output.Images); - } - - [Test] - public void Can_Deserialize_Inline_List_Without_Elements_To_Empty_List() - { - string doc = CreateXmlWithEmptyInlineList(); - XmlDeserializer xml = new XmlDeserializer(); - EmptyListSample output = xml.Deserialize(new RestResponse { Content = doc }); - - Assert.NotNull(output.images); - Assert.NotNull(output.Images); - Assert.IsEmpty(output.images); - Assert.IsEmpty(output.Images); - } - - [Test] - public void Can_Deserialize_Empty_Elements_to_Nullable_Values() - { - string doc = CreateXmlWithNullValues(); - XmlDeserializer xml = new XmlDeserializer(); - NullableValues output = xml.Deserialize(new RestResponse { Content = doc }); - - Assert.Null(output.Id); - Assert.Null(output.StartDate); - Assert.Null(output.UniqueId); - } - - [Test] - public void Can_Deserialize_Elements_to_Nullable_Values() - { - CultureInfo culture = CultureInfo.InvariantCulture; - string doc = CreateXmlWithoutEmptyValues(culture); - XmlDeserializer xml = new XmlDeserializer - { - Culture = culture - }; - NullableValues output = xml.Deserialize(new RestResponse { Content = doc }); - - Assert.NotNull(output.Id); - Assert.NotNull(output.StartDate); - Assert.NotNull(output.UniqueId); - Assert.AreEqual(123, output.Id); - Assert.AreEqual(new DateTime(2010, 2, 21, 9, 35, 00), output.StartDate); - Assert.AreEqual(new Guid(GUID_STRING), output.UniqueId); - } - - [Test] - public void Can_Deserialize_TimeSpan() - { - CultureInfo culture = CultureInfo.InvariantCulture; - XDocument doc = new XDocument(culture); - TimeSpan? nullTimespan = null; - TimeSpan? nullValueTimeSpan = new TimeSpan(21, 30, 7); - XElement root = new XElement("Person"); - - root.Add(new XElement("Tick", new TimeSpan(468006))); - root.Add(new XElement("Millisecond", new TimeSpan(0, 0, 0, 0, 125))); - root.Add(new XElement("Second", new TimeSpan(0, 0, 8))); - root.Add(new XElement("Minute", new TimeSpan(0, 55, 2))); - root.Add(new XElement("Hour", new TimeSpan(21, 30, 7))); - root.Add(new XElement("NullableWithoutValue", nullTimespan)); - root.Add(new XElement("NullableWithValue", nullValueTimeSpan)); - - doc.Add(root); - - RestResponse response = new RestResponse - { - Content = doc.ToString() - }; - XmlDeserializer d = new XmlDeserializer - { - Culture = culture, - }; - TimeSpanTestStructure payload = d.Deserialize(response); - - Assert.AreEqual(new TimeSpan(468006), payload.Tick); - Assert.AreEqual(new TimeSpan(0, 0, 0, 0, 125), payload.Millisecond); - Assert.AreEqual(new TimeSpan(0, 0, 8), payload.Second); - Assert.AreEqual(new TimeSpan(0, 55, 2), payload.Minute); - Assert.AreEqual(new TimeSpan(21, 30, 7), payload.Hour); - Assert.Null(payload.NullableWithoutValue); - Assert.NotNull(payload.NullableWithValue); - Assert.AreEqual(new TimeSpan(21, 30, 7), payload.NullableWithValue.Value); - } - - [Test] - public void Can_Deserialize_Custom_Formatted_Date() - { - CultureInfo culture = CultureInfo.InvariantCulture; - string format = "dd yyyy MMM, hh:mm ss tt zzz"; - DateTime date = new DateTime(2010, 2, 8, 11, 11, 11); - XDocument doc = new XDocument(); - XElement root = new XElement("Person"); - - root.Add(new XElement("StartDate", date.ToString(format, culture))); - doc.Add(root); - - XmlDeserializer xml = new XmlDeserializer - { - DateFormat = format, - Culture = culture - }; - RestResponse response = new RestResponse { Content = doc.ToString() }; - PersonForXml output = xml.Deserialize(response); - - Assert.AreEqual(date, output.StartDate); - } - - [Test] - public void Can_Deserialize_Elements_On_Default_Root() - { - string doc = CreateElementsXml(); - RestResponse response = new RestResponse { Content = doc }; - XmlDeserializer d = new XmlDeserializer(); - PersonForXml p = d.Deserialize(response); - - Assert.AreEqual("John Sheehan", p.Name); - Assert.AreEqual(new DateTime(2009, 9, 25, 0, 6, 1), p.StartDate); - Assert.AreEqual(28, p.Age); - Assert.AreEqual(long.MaxValue, p.BigNumber); - Assert.AreEqual(99.9999m, p.Percent); - Assert.AreEqual(false, p.IsCool); - Assert.AreEqual(new Guid(GUID_STRING), p.UniqueId); - Assert.AreEqual(Guid.Empty, p.EmptyGuid); - Assert.AreEqual(new Uri("http://example.com", UriKind.RelativeOrAbsolute), p.Url); - Assert.AreEqual(new Uri("/foo/bar", UriKind.RelativeOrAbsolute), p.UrlPath); - Assert.AreEqual(Order.Third, p.Order); - Assert.AreEqual(Disposition.SoSo, p.Disposition); - Assert.NotNull(p.Friends); - Assert.AreEqual(10, p.Friends.Count); - Assert.NotNull(p.BestFriend); - Assert.AreEqual("The Fonz", p.BestFriend.Name); - Assert.AreEqual(1952, p.BestFriend.Since); - } - - [Test] - public void Can_Deserialize_Attributes_On_Default_Root() - { - string doc = CreateAttributesXml(); - RestResponse response = new RestResponse { Content = doc }; - XmlDeserializer d = new XmlDeserializer(); - PersonForXml p = d.Deserialize(response); - - Assert.AreEqual("John Sheehan", p.Name); - Assert.AreEqual(new DateTime(2009, 9, 25, 0, 6, 1), p.StartDate); - Assert.AreEqual(28, p.Age); - Assert.AreEqual(long.MaxValue, p.BigNumber); - Assert.AreEqual(99.9999m, p.Percent); - Assert.AreEqual(false, p.IsCool); - Assert.AreEqual(new Guid(GUID_STRING), p.UniqueId); - Assert.AreEqual(new Uri("http://example.com", UriKind.RelativeOrAbsolute), p.Url); - Assert.AreEqual(new Uri("/foo/bar", UriKind.RelativeOrAbsolute), p.UrlPath); - Assert.NotNull(p.BestFriend); - Assert.AreEqual("The Fonz", p.BestFriend.Name); - Assert.AreEqual(1952, p.BestFriend.Since); - } - - [Test] - public void Ignore_Protected_Property_That_Exists_In_Data() - { - string doc = CreateElementsXml(); - RestResponse response = new RestResponse { Content = doc }; - XmlDeserializer d = new XmlDeserializer(); - PersonForXml p = d.Deserialize(response); - - Assert.Null(p.IgnoreProxy); - } - - [Test] - public void Ignore_ReadOnly_Property_That_Exists_In_Data() - { - string doc = CreateElementsXml(); - RestResponse response = new RestResponse { Content = doc }; - XmlDeserializer d = new XmlDeserializer(); - PersonForXml p = d.Deserialize(response); - - Assert.Null(p.ReadOnlyProxy); - } - - [Test] - public void Can_Deserialize_Names_With_Underscores_On_Default_Root() - { - string doc = CreateUnderscoresXml(); - RestResponse response = new RestResponse { Content = doc }; - XmlDeserializer d = new XmlDeserializer(); - PersonForXml p = d.Deserialize(response); - - Assert.AreEqual("John Sheehan", p.Name); - Assert.AreEqual(new DateTime(2009, 9, 25, 0, 6, 1), p.StartDate); - Assert.AreEqual(28, p.Age); - Assert.AreEqual(long.MaxValue, p.BigNumber); - Assert.AreEqual(99.9999m, p.Percent); - Assert.AreEqual(false, p.IsCool); - Assert.AreEqual(new Guid(GUID_STRING), p.UniqueId); - Assert.AreEqual(new Uri("http://example.com", UriKind.RelativeOrAbsolute), p.Url); - Assert.AreEqual(new Uri("/foo/bar", UriKind.RelativeOrAbsolute), p.UrlPath); - Assert.NotNull(p.Friends); - Assert.AreEqual(10, p.Friends.Count); - Assert.NotNull(p.BestFriend); - Assert.AreEqual("The Fonz", p.BestFriend.Name); - Assert.AreEqual(1952, p.BestFriend.Since); - Assert.NotNull(p.Foes); - Assert.AreEqual(5, p.Foes.Count); - Assert.AreEqual("Yankees", p.Foes.Team); - } - - [Test] - public void Can_Deserialize_Names_With_Dashes_On_Default_Root() - { - string doc = CreateDashesXml(); - RestResponse response = new RestResponse { Content = doc }; - XmlDeserializer d = new XmlDeserializer(); - PersonForXml p = d.Deserialize(response); - - Assert.AreEqual("John Sheehan", p.Name); - Assert.AreEqual(new DateTime(2009, 9, 25, 0, 6, 1), p.StartDate); - Assert.AreEqual(28, p.Age); - Assert.AreEqual(long.MaxValue, p.BigNumber); - Assert.AreEqual(99.9999m, p.Percent); - Assert.AreEqual(false, p.IsCool); - Assert.AreEqual(new Guid(GUID_STRING), p.UniqueId); - Assert.AreEqual(new Uri("http://example.com", UriKind.RelativeOrAbsolute), p.Url); - Assert.AreEqual(new Uri("/foo/bar", UriKind.RelativeOrAbsolute), p.UrlPath); - Assert.NotNull(p.Friends); - Assert.AreEqual(10, p.Friends.Count); - Assert.NotNull(p.BestFriend); - Assert.AreEqual("The Fonz", p.BestFriend.Name); - Assert.AreEqual(1952, p.BestFriend.Since); - Assert.NotNull(p.Foes); - Assert.AreEqual(5, p.Foes.Count); - Assert.AreEqual("Yankees", p.Foes.Team); - } - - [Test] - public void Can_Deserialize_Names_With_Underscores_Without_Matching_Case_On_Default_Root() - { - string doc = CreateLowercaseUnderscoresXml(); - RestResponse response = new RestResponse { Content = doc }; - XmlDeserializer d = new XmlDeserializer(); - PersonForXml p = d.Deserialize(response); - - Assert.AreEqual("John Sheehan", p.Name); - Assert.AreEqual(new DateTime(2009, 9, 25, 0, 6, 1), p.StartDate); - Assert.AreEqual(28, p.Age); - Assert.AreEqual(long.MaxValue, p.BigNumber); - Assert.AreEqual(99.9999m, p.Percent); - Assert.AreEqual(false, p.IsCool); - Assert.AreEqual(new Guid(GUID_STRING), p.UniqueId); - Assert.AreEqual(new Uri("http://example.com", UriKind.RelativeOrAbsolute), p.Url); - Assert.AreEqual(new Uri("/foo/bar", UriKind.RelativeOrAbsolute), p.UrlPath); - Assert.NotNull(p.Friends); - Assert.AreEqual(10, p.Friends.Count); - Assert.NotNull(p.BestFriend); - Assert.AreEqual("The Fonz", p.BestFriend.Name); - Assert.AreEqual(1952, p.BestFriend.Since); - Assert.NotNull(p.Foes); - Assert.AreEqual(5, p.Foes.Count); - Assert.AreEqual("Yankees", p.Foes.Team); - } - - [Test] - public void Can_Deserialize_Lower_Cased_Root_Elements_With_Dashes() - { - string doc = CreateDashesXml(); - RestResponse response = new RestResponse { Content = doc }; - XmlDeserializer d = new XmlDeserializer(); - PersonForXml p = d.Deserialize(response); - - Assert.AreEqual("John Sheehan", p.Name); - Assert.AreEqual(new DateTime(2009, 9, 25, 0, 6, 1), p.StartDate); - Assert.AreEqual(28, p.Age); - Assert.AreEqual(long.MaxValue, p.BigNumber); - Assert.AreEqual(99.9999m, p.Percent); - Assert.AreEqual(false, p.IsCool); - Assert.AreEqual(new Guid(GUID_STRING), p.UniqueId); - Assert.AreEqual(new Uri("http://example.com", UriKind.RelativeOrAbsolute), p.Url); - Assert.AreEqual(new Uri("/foo/bar", UriKind.RelativeOrAbsolute), p.UrlPath); - Assert.NotNull(p.Friends); - Assert.AreEqual(10, p.Friends.Count); - Assert.NotNull(p.BestFriend); - Assert.AreEqual("The Fonz", p.BestFriend.Name); - Assert.AreEqual(1952, p.BestFriend.Since); - Assert.NotNull(p.Foes); - Assert.AreEqual(5, p.Foes.Count); - Assert.AreEqual("Yankees", p.Foes.Team); - } - - [Test] - public void Can_Deserialize_Root_Elements_Without_Matching_Case_And_Dashes() - { - string doc = CreateLowerCasedRootElementWithDashesXml(); - RestResponse response = new RestResponse { Content = doc }; - XmlDeserializer d = new XmlDeserializer(); - List p = d.Deserialize>(response); - - Assert.NotNull(p); - Assert.AreEqual(1, p.Count); - Assert.AreEqual(45, p[0].ConceptId); - } - - [Test] - public void Can_Deserialize_Eventful_Xml() - { - string xmlpath = this.PathFor("eventful.xml"); - XDocument doc = XDocument.Load(xmlpath); - RestResponse response = new RestResponse { Content = doc.ToString() }; - XmlDeserializer d = new XmlDeserializer(); - VenueSearch output = d.Deserialize(response); - - Assert.IsNotEmpty(output.venues); - Assert.AreEqual(3, output.venues.Count); - Assert.AreEqual("Tivoli", output.venues[0].name); - Assert.AreEqual("http://eventful.com/brisbane/venues/tivoli-/V0-001-002169294-8", output.venues[1].url); - Assert.AreEqual("V0-001-000266914-3", output.venues[2].id); - } - - [Test] - public void Can_Deserialize_Lastfm_Xml() - { - string xmlpath = this.PathFor("Lastfm.xml"); - XDocument doc = XDocument.Load(xmlpath); - RestResponse response = new RestResponse { Content = doc.ToString() }; - XmlDeserializer d = new XmlDeserializer(); - Event output = d.Deserialize(response); - - //Assert.IsNotEmpty(output.artists); - Assert.AreEqual("http://www.last.fm/event/328799+Philip+Glass+at+Barbican+Centre+on+12+June+2008", output.url); - Assert.AreEqual("http://www.last.fm/venue/8777860+Barbican+Centre", output.venue.url); - } - - [Test] - public void Can_Deserialize_Google_Weather_Xml() - { - string xmlpath = this.PathFor("GoogleWeather.xml"); - XDocument doc = XDocument.Load(xmlpath); - RestResponse response = new RestResponse { Content = doc.ToString() }; - XmlDeserializer d = new XmlDeserializer(); - xml_api_reply output = d.Deserialize(response); - - Assert.IsNotEmpty(output.weather); - Assert.AreEqual(4, output.weather.Count); - Assert.AreEqual("Sunny", output.weather[0].condition.data); - } - - [Test] - public void Can_Deserialize_Goodreads_Xml() - { - string xmlpath = this.PathFor("Goodreads.xml"); - XDocument doc = XDocument.Load(xmlpath); - RestResponse response = new RestResponse { Content = doc.ToString() }; - XmlDeserializer d = new XmlDeserializer(); - GoodReadsReviewCollection output = d.Deserialize(response); - - Assert.AreEqual(2, output.Reviews.Count); - Assert.AreEqual("1208943892", output.Reviews[0].Id); // This fails without fixing the XmlDeserializer - Assert.AreEqual("1198344567", output.Reviews[1].Id); - } - - [Test] - public void Can_Deserialize_Boolean_From_Number() - { - string xmlpath = this.PathFor("boolean_from_number.xml"); - XDocument doc = XDocument.Load(xmlpath); - RestResponse response = new RestResponse { Content = doc.ToString() }; - XmlDeserializer d = new XmlDeserializer(); - BooleanTest output = d.Deserialize(response); - - Assert.True(output.Value); - } - - [Test] - public void Can_Deserialize_Boolean_From_String() - { - string xmlpath = this.PathFor("boolean_from_string.xml"); - XDocument doc = XDocument.Load(xmlpath); - RestResponse response = new RestResponse { Content = doc.ToString() }; - XmlDeserializer d = new XmlDeserializer(); - BooleanTest output = d.Deserialize(response); - - Assert.True(output.Value); - } - - [Test] - public void Can_Deserialize_Empty_Elements_With_Attributes_to_Nullable_Values() - { - string doc = CreateXmlWithAttributesAndNullValues(); - XmlDeserializer xml = new XmlDeserializer(); - NullableValues output = xml.Deserialize(new RestResponse { Content = doc }); - - Assert.Null(output.Id); - Assert.Null(output.StartDate); - Assert.Null(output.UniqueId); - } - - [Test] - public void Can_Deserialize_Mixture_Of_Empty_Elements_With_Attributes_And_Populated_Elements() - { - string doc = CreateXmlWithAttributesAndNullValuesAndPopulatedValues(); - XmlDeserializer xml = new XmlDeserializer(); - NullableValues output = xml.Deserialize(new RestResponse { Content = doc }); - - Assert.Null(output.Id); - Assert.Null(output.StartDate); - Assert.AreEqual(new Guid(GUID_STRING), output.UniqueId); - } - - [Test] - public void Can_Deserialize_DateTimeOffset() - { - CultureInfo culture = CultureInfo.InvariantCulture; - XDocument doc = new XDocument(culture); - DateTimeOffset dateTimeOffset = new DateTimeOffset(2013, 02, 08, 9, 18, 22, TimeSpan.FromHours(10)); - DateTimeOffset? nullableDateTimeOffsetWithValue = new DateTimeOffset(2013, 02, 08, 9, 18, 23, TimeSpan.FromHours(10)); - XElement root = new XElement("Dates"); - - root.Add(new XElement("DateTimeOffset", dateTimeOffset)); - root.Add(new XElement("NullableDateTimeOffsetWithNull", string.Empty)); - root.Add(new XElement("NullableDateTimeOffsetWithValue", nullableDateTimeOffsetWithValue)); - - doc.Add(root); - - //var xml = new XmlDeserializer { Culture = culture, }; - RestResponse response = new RestResponse { Content = doc.ToString() }; - XmlDeserializer d = new XmlDeserializer { Culture = culture }; - DateTimeTestStructure payload = d.Deserialize(response); - - Assert.AreEqual(dateTimeOffset, payload.DateTimeOffset); - Assert.Null(payload.NullableDateTimeOffsetWithNull); - Assert.True(payload.NullableDateTimeOffsetWithValue.HasValue); - Assert.AreEqual(nullableDateTimeOffsetWithValue, payload.NullableDateTimeOffsetWithValue); - } - - [Test] - public void Can_Deserialize_ElementNamedValue() - { - XDocument doc = new XDocument(); - XElement root = new XElement("ValueCollection"); - - string valueName = "First moon landing events"; - root.Add(new XElement("Value", valueName)); - - var xmlCollection = new XElement("Values"); - - var first = new XElement("Value"); - first.Add(new XAttribute("Timestamp", new DateTime(1969, 7, 20, 20, 18, 00, DateTimeKind.Utc))); - xmlCollection.Add(first); - - var second = new XElement("Value"); - second.Add(new XAttribute("Timestamp", new DateTime(1969, 7, 21, 2, 56, 15, DateTimeKind.Utc))); - xmlCollection.Add(second); - - root.Add(xmlCollection); - doc.Add(root); - - RestResponse response = new RestResponse { Content = doc.ToString() }; - XmlDeserializer d = new XmlDeserializer(); - ValueCollectionForXml valueCollection = d.Deserialize(response); - - Assert.AreEqual(valueName, valueCollection.Value); - Assert.AreEqual(2, valueCollection.Values.Count); - Assert.AreEqual(new DateTime(1969, 7, 20, 20, 18, 00, DateTimeKind.Utc), valueCollection.Values.First().Timestamp.ToUniversalTime()); - } - - [Test] - public void Can_Deserialize_AttributeNamedValue() - { - XDocument doc = new XDocument(); - XElement root = new XElement("ValueCollection"); - - var xmlCollection = new XElement("Values"); - - var first = new XElement("Value"); - first.Add(new XAttribute("Timestamp", new DateTime(1969, 7, 20, 20, 18, 00, DateTimeKind.Utc))); - first.Add(new XAttribute("Value", "Eagle landed")); - - xmlCollection.Add(first); - - var second = new XElement("Value"); - second.Add(new XAttribute("Timestamp", new DateTime(1969, 7, 21, 2, 56, 15, DateTimeKind.Utc))); - second.Add(new XAttribute("Value", "First step")); - xmlCollection.Add(second); - - root.Add(xmlCollection); - doc.Add(root); - - RestResponse response = new RestResponse { Content = doc.ToString() }; - XmlDeserializer d = new XmlDeserializer(); - ValueCollectionForXml valueCollection = d.Deserialize(response); - - Assert.AreEqual(2, valueCollection.Values.Count); - Assert.AreEqual("Eagle landed", valueCollection.Values.First().Value); - } - - private static string CreateUnderscoresXml() - { - XDocument doc = new XDocument(); - XElement root = new XElement("Person"); - - root.Add(new XElement("Name", "John Sheehan")); - root.Add(new XElement("Start_Date", new DateTime(2009, 9, 25, 0, 6, 1))); - root.Add(new XAttribute("Age", 28)); - root.Add(new XElement("Percent", 99.9999m)); - root.Add(new XElement("Big_Number", long.MaxValue)); - root.Add(new XAttribute("Is_Cool", false)); - root.Add(new XElement("Ignore", "dummy")); - root.Add(new XAttribute("Read_Only", "dummy")); - root.Add(new XElement("Unique_Id", new Guid(GUID_STRING))); - root.Add(new XElement("Url", "http://example.com")); - root.Add(new XElement("Url_Path", "/foo/bar")); - root.Add(new XElement("Best_Friend", - new XElement("Name", "The Fonz"), - new XAttribute("Since", 1952))); - - XElement friends = new XElement("Friends"); - - for (int i = 0; i < 10; i++) - { - friends.Add(new XElement("Friend", - new XElement("Name", "Friend" + i), - new XAttribute("Since", DateTime.Now.Year - i))); - } - - root.Add(friends); - - XElement foes = new XElement("Foes"); - - foes.Add(new XAttribute("Team", "Yankees")); - - for (int i = 0; i < 5; i++) - { - foes.Add(new XElement("Foe", new XElement("Nickname", "Foe" + i))); - } - - root.Add(foes); - doc.Add(root); - - return doc.ToString(); - } - - private static string CreateLowercaseUnderscoresXml() - { - XDocument doc = new XDocument(); - XElement root = new XElement("Person"); - - root.Add(new XElement("Name", "John Sheehan")); - root.Add(new XElement("start_date", new DateTime(2009, 9, 25, 0, 6, 1))); - root.Add(new XAttribute("Age", 28)); - root.Add(new XElement("Percent", 99.9999m)); - root.Add(new XElement("big_number", long.MaxValue)); - root.Add(new XAttribute("is_cool", false)); - root.Add(new XElement("Ignore", "dummy")); - root.Add(new XAttribute("read_only", "dummy")); - root.Add(new XElement("unique_id", new Guid(GUID_STRING))); - root.Add(new XElement("Url", "http://example.com")); - root.Add(new XElement("url_path", "/foo/bar")); - root.Add(new XElement("best_friend", - new XElement("name", "The Fonz"), - new XAttribute("Since", 1952))); - - XElement friends = new XElement("Friends"); - - for (int i = 0; i < 10; i++) - { - friends.Add(new XElement("Friend", - new XElement("Name", "Friend" + i), - new XAttribute("Since", DateTime.Now.Year - i))); - } - - root.Add(friends); - - XElement foes = new XElement("Foes"); - - foes.Add(new XAttribute("Team", "Yankees")); - - for (int i = 0; i < 5; i++) - { - foes.Add(new XElement("Foe", new XElement("Nickname", "Foe" + i))); - } - - root.Add(foes); - doc.Add(root); - - return doc.ToString(); - } - - private static string CreateDashesXml() - { - XDocument doc = new XDocument(); - XElement root = new XElement("Person"); - - root.Add(new XElement("Name", "John Sheehan")); - root.Add(new XElement("Start_Date", new DateTime(2009, 9, 25, 0, 6, 1))); - root.Add(new XAttribute("Age", 28)); - root.Add(new XElement("Percent", 99.9999m)); - root.Add(new XElement("Big-Number", long.MaxValue)); - root.Add(new XAttribute("Is-Cool", false)); - root.Add(new XElement("Ignore", "dummy")); - root.Add(new XAttribute("Read-Only", "dummy")); - root.Add(new XElement("Unique-Id", new Guid(GUID_STRING))); - root.Add(new XElement("Url", "http://example.com")); - root.Add(new XElement("Url-Path", "/foo/bar")); - root.Add(new XElement("Best-Friend", - new XElement("Name", "The Fonz"), - new XAttribute("Since", 1952))); - - XElement friends = new XElement("Friends"); - - for (int i = 0; i < 10; i++) - { - friends.Add(new XElement("Friend", - new XElement("Name", "Friend" + i), - new XAttribute("Since", DateTime.Now.Year - i))); - } - - root.Add(friends); - - XElement foes = new XElement("Foes"); - - foes.Add(new XAttribute("Team", "Yankees")); - - for (int i = 0; i < 5; i++) - { - foes.Add(new XElement("Foe", new XElement("Nickname", "Foe" + i))); - } - - root.Add(foes); - doc.Add(root); - - return doc.ToString(); - } - - private static string CreateLowerCasedRootElementWithDashesXml() - { - XDocument doc = new XDocument(); - XElement root = new XElement("incoming-invoices", - new XElement("incoming-invoice", new XElement("concept-id", 45))); - - doc.Add(root); - - return doc.ToString(); - } - - private static string CreateElementsXml() - { - XDocument doc = new XDocument(); - XElement root = new XElement("Person"); - - root.Add(new XElement("Name", "John Sheehan")); - root.Add(new XElement("StartDate", new DateTime(2009, 9, 25, 0, 6, 1))); - root.Add(new XElement("Age", 28)); - root.Add(new XElement("Percent", 99.9999m)); - root.Add(new XElement("BigNumber", long.MaxValue)); - root.Add(new XElement("IsCool", false)); - root.Add(new XElement("Ignore", "dummy")); - root.Add(new XElement("ReadOnly", "dummy")); - root.Add(new XElement("UniqueId", new Guid(GUID_STRING))); - root.Add(new XElement("EmptyGuid", "")); - root.Add(new XElement("Url", "http://example.com")); - root.Add(new XElement("UrlPath", "/foo/bar")); - root.Add(new XElement("Order", "third")); - root.Add(new XElement("Disposition", "so-so")); - root.Add(new XElement("BestFriend", - new XElement("Name", "The Fonz"), - new XElement("Since", 1952))); - - XElement friends = new XElement("Friends"); - - for (int i = 0; i < 10; i++) - { - friends.Add(new XElement("Friend", - new XElement("Name", "Friend" + i), - new XElement("Since", DateTime.Now.Year - i))); - } - - root.Add(friends); - doc.Add(root); - - return doc.ToString(); - } - - private static string CreateAttributesXml() - { - XDocument doc = new XDocument(); - XElement root = new XElement("Person"); - - root.Add(new XAttribute("Name", "John Sheehan")); - root.Add(new XAttribute("StartDate", new DateTime(2009, 9, 25, 0, 6, 1))); - root.Add(new XAttribute("Age", 28)); - root.Add(new XAttribute("Percent", 99.9999m)); - root.Add(new XAttribute("BigNumber", long.MaxValue)); - root.Add(new XAttribute("IsCool", false)); - root.Add(new XAttribute("Ignore", "dummy")); - root.Add(new XAttribute("ReadOnly", "dummy")); - root.Add(new XAttribute("UniqueId", new Guid(GUID_STRING))); - root.Add(new XAttribute("Url", "http://example.com")); - root.Add(new XAttribute("UrlPath", "/foo/bar")); - root.Add(new XElement("BestFriend", - new XAttribute("Name", "The Fonz"), - new XAttribute("Since", 1952))); - - doc.Add(root); - - return doc.ToString(); - } - - private static string CreateXmlWithNullValues() - { - XDocument doc = new XDocument(); - XElement root = new XElement("NullableValues"); - - root.Add(new XElement("Id", null), - new XElement("StartDate", null), - new XElement("UniqueId", null)); - - doc.Add(root); - - return doc.ToString(); - } - - private static string CreateXmlWithoutEmptyValues(CultureInfo culture) - { - XDocument doc = new XDocument(); - XElement root = new XElement("NullableValues"); - - root.Add(new XElement("Id", 123), - new XElement("StartDate", new DateTime(2010, 2, 21, 9, 35, 00).ToString(culture)), - new XElement("UniqueId", new Guid(GUID_STRING))); - - doc.Add(root); - - return doc.ToString(); - } - - private static string CreateXmlWithEmptyNestedList() - { - XDocument doc = new XDocument(); - XElement root = new XElement("EmptyListSample"); - - root.Add(new XElement("Images")); - doc.Add(root); - - return doc.ToString(); - } - - private static string CreateXmlWithEmptyInlineList() - { - XDocument doc = new XDocument(); - XElement root = new XElement("EmptyListSample"); - - doc.Add(root); - - return doc.ToString(); - } - - private static string CreateXmlWithAttributesAndNullValues() - { - XDocument doc = new XDocument(); - XElement root = new XElement("NullableValues"); - XElement idElement = new XElement("Id", null); - - idElement.SetAttributeValue("SomeAttribute", "SomeAttribute_Value"); - - root.Add(idElement, - new XElement("StartDate", null), - new XElement("UniqueId", null)); - - doc.Add(root); - - return doc.ToString(); - } - - private static string CreateXmlWithAttributesAndNullValuesAndPopulatedValues() - { - XDocument doc = new XDocument(); - XElement root = new XElement("NullableValues"); - XElement idElement = new XElement("Id", null); - - idElement.SetAttributeValue("SomeAttribute", "SomeAttribute_Value"); - - root.Add(idElement, - new XElement("StartDate", null), - new XElement("UniqueId", new Guid(GUID_STRING))); - - doc.Add(root); - - return doc.ToString(); - } - } -} diff --git a/RestSharp.sln b/RestSharp.sln index a242c2257..0f86b90e0 100644 --- a/RestSharp.sln +++ b/RestSharp.sln @@ -1,22 +1,45 @@  Microsoft Visual Studio Solution File, Format Version 12.00 -# Visual Studio 15 -VisualStudioVersion = 15.0.26730.16 +# Visual Studio Version 17 +VisualStudioVersion = 17.3.32811.315 MinimumVisualStudioVersion = 10.0.40219.1 -Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "Meta", "Meta", "{C5B02FAA-6A0A-4BF9-BBD4-82FD2DCBF669}" - ProjectSection(SolutionItems) = preProject - appveyor.yml = appveyor.yml - CONTRIBUTING.md = CONTRIBUTING.md - README.md = README.md - readme.txt = readme.txt - releasenotes.md = releasenotes.md - EndProjectSection +Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "RestSharp", "src\RestSharp\RestSharp.csproj", "{43A1D5D2-650D-40DD-A6C0-14F92689C70B}" EndProject -Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "RestSharp", "RestSharp\RestSharp.csproj", "{24BDBFB9-7849-400D-B3AB-E06AB7AEDBC5}" +Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "Tests", "Tests", "{9051DDA0-E563-45D5-9504-085EBAACF469}" EndProject -Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "RestSharp.Tests", "RestSharp.Tests\RestSharp.Tests.csproj", "{B5ED1585-8B00-474B-A82E-1C8AEB431646}" +Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "RestSharp.Tests", "test\RestSharp.Tests\RestSharp.Tests.csproj", "{B1C55C9B-3287-4EB2-8ADD-795DBC77013D}" EndProject -Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "RestSharp.IntegrationTests", "RestSharp.IntegrationTests\RestSharp.IntegrationTests.csproj", "{B7D1A40A-0E34-485E-9BBD-F0F34F61EC67}" +Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "RestSharp.Tests.Integrated", "test\RestSharp.Tests.Integrated\RestSharp.Tests.Integrated.csproj", "{AC3B3DDC-F011-4E19-8C9B-F748B19ED3C0}" +EndProject +Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "RestSharp.Serializers.NewtonsoftJson", "src\RestSharp.Serializers.NewtonsoftJson\RestSharp.Serializers.NewtonsoftJson.csproj", "{4205A187-9732-4DA8-B0BE-77A2C6B8C6A1}" +EndProject +Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "Serializers", "Serializers", "{8C7B43EB-2F93-483C-B433-E28F9386AD67}" +EndProject +Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "RestSharp.Tests.Shared", "test\RestSharp.Tests.Shared\RestSharp.Tests.Shared.csproj", "{73896669-F05C-41AC-9F6F-A11F549EDEDC}" +EndProject +Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "RestSharp.Tests.Serializers.Json", "test\RestSharp.Tests.Serializers.Json\RestSharp.Tests.Serializers.Json.csproj", "{8BF81225-2F85-4412-AD18-6579CBA1879B}" +EndProject +Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "Perf", "Perf", "{1C42C435-8826-4044-8775-A1DA40EF4866}" +EndProject +Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "RestSharp.Benchmarks", "benchmarks\RestSharp.Benchmarks\RestSharp.Benchmarks.csproj", "{997AEFE5-D7D4-4033-A31A-07F476D6FE5D}" +EndProject +Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "RestSharp.InteractiveTests", "test\RestSharp.InteractiveTests\RestSharp.InteractiveTests.csproj", "{6D7D1D60-4473-4C52-800C-9B892C6640A5}" +EndProject +Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "RestSharp.Tests.Serializers.Xml", "test\RestSharp.Tests.Serializers.Xml\RestSharp.Tests.Serializers.Xml.csproj", "{E6D94C12-9AD7-46E6-AB62-3676F25FDE51}" +EndProject +Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "RestSharp.Serializers.Xml", "src\RestSharp.Serializers.Xml\RestSharp.Serializers.Xml.csproj", "{4A35B1C5-520D-4267-BA70-2DCEAC0A5662}" +EndProject +Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "RestSharp.Serializers.CsvHelper", "src\RestSharp.Serializers.CsvHelper\RestSharp.Serializers.CsvHelper.csproj", "{2150E333-8FDC-42A3-9474-1A3956D46DE8}" +EndProject +Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "RestSharp.Tests.Serializers.Csv", "test\RestSharp.Tests.Serializers.Csv\RestSharp.Tests.Serializers.Csv.csproj", "{E6D94FFD-7811-40BE-ABC4-6D6AB41F0060}" +EndProject +Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "SourceGen", "SourceGen", "{55B8F371-B2BA-4DEE-AB98-5BAB8A21B1C2}" +EndProject +Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "SourceGenerator", "gen\SourceGenerator\SourceGenerator.csproj", "{FE778406-ADCF-45A1-B775-A054B55BFC50}" +EndProject +Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "RestSharp.Extensions.DependencyInjection", "src\RestSharp.Extensions.DependencyInjection\RestSharp.Extensions.DependencyInjection.csproj", "{92A6F3CA-100F-4D9D-9742-B62267D445B6}" +EndProject +Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "RestSharp.Tests.DependencyInjection", "test\RestSharp.Tests.DependencyInjection\RestSharp.Tests.DependencyInjection.csproj", "{602FF788-E926-4404-B3A2-D6B778A5FFB7}" EndProject Global GlobalSection(SolutionConfigurationPlatforms) = preSolution @@ -37,100 +60,475 @@ Global Release|x86 = Release|x86 EndGlobalSection GlobalSection(ProjectConfigurationPlatforms) = postSolution - {24BDBFB9-7849-400D-B3AB-E06AB7AEDBC5}.Debug.Appveyor|Any CPU.ActiveCfg = Debug|Any CPU - {24BDBFB9-7849-400D-B3AB-E06AB7AEDBC5}.Debug.Appveyor|Any CPU.Build.0 = Debug|Any CPU - {24BDBFB9-7849-400D-B3AB-E06AB7AEDBC5}.Debug.Appveyor|ARM.ActiveCfg = Debug|Any CPU - {24BDBFB9-7849-400D-B3AB-E06AB7AEDBC5}.Debug.Appveyor|ARM.Build.0 = Debug|Any CPU - {24BDBFB9-7849-400D-B3AB-E06AB7AEDBC5}.Debug.Appveyor|Mixed Platforms.ActiveCfg = Debug|Any CPU - {24BDBFB9-7849-400D-B3AB-E06AB7AEDBC5}.Debug.Appveyor|Mixed Platforms.Build.0 = Debug|Any CPU - {24BDBFB9-7849-400D-B3AB-E06AB7AEDBC5}.Debug.Appveyor|x64.ActiveCfg = Debug|Any CPU - {24BDBFB9-7849-400D-B3AB-E06AB7AEDBC5}.Debug.Appveyor|x64.Build.0 = Debug|Any CPU - {24BDBFB9-7849-400D-B3AB-E06AB7AEDBC5}.Debug.Appveyor|x86.ActiveCfg = Debug|Any CPU - {24BDBFB9-7849-400D-B3AB-E06AB7AEDBC5}.Debug.Appveyor|x86.Build.0 = Debug|Any CPU - {24BDBFB9-7849-400D-B3AB-E06AB7AEDBC5}.Debug|Any CPU.ActiveCfg = Debug|Any CPU - {24BDBFB9-7849-400D-B3AB-E06AB7AEDBC5}.Debug|Any CPU.Build.0 = Debug|Any CPU - {24BDBFB9-7849-400D-B3AB-E06AB7AEDBC5}.Debug|ARM.ActiveCfg = Debug|Any CPU - {24BDBFB9-7849-400D-B3AB-E06AB7AEDBC5}.Debug|ARM.Build.0 = Debug|Any CPU - {24BDBFB9-7849-400D-B3AB-E06AB7AEDBC5}.Debug|Mixed Platforms.ActiveCfg = Debug|Any CPU - {24BDBFB9-7849-400D-B3AB-E06AB7AEDBC5}.Debug|Mixed Platforms.Build.0 = Debug|Any CPU - {24BDBFB9-7849-400D-B3AB-E06AB7AEDBC5}.Debug|x64.ActiveCfg = Debug|Any CPU - {24BDBFB9-7849-400D-B3AB-E06AB7AEDBC5}.Debug|x64.Build.0 = Debug|Any CPU - {24BDBFB9-7849-400D-B3AB-E06AB7AEDBC5}.Debug|x86.ActiveCfg = Debug|Any CPU - {24BDBFB9-7849-400D-B3AB-E06AB7AEDBC5}.Debug|x86.Build.0 = Debug|Any CPU - {24BDBFB9-7849-400D-B3AB-E06AB7AEDBC5}.Release|Any CPU.ActiveCfg = Release|Any CPU - {24BDBFB9-7849-400D-B3AB-E06AB7AEDBC5}.Release|Any CPU.Build.0 = Release|Any CPU - {24BDBFB9-7849-400D-B3AB-E06AB7AEDBC5}.Release|ARM.ActiveCfg = Release|Any CPU - {24BDBFB9-7849-400D-B3AB-E06AB7AEDBC5}.Release|ARM.Build.0 = Release|Any CPU - {24BDBFB9-7849-400D-B3AB-E06AB7AEDBC5}.Release|Mixed Platforms.ActiveCfg = Release|Any CPU - {24BDBFB9-7849-400D-B3AB-E06AB7AEDBC5}.Release|Mixed Platforms.Build.0 = Release|Any CPU - {24BDBFB9-7849-400D-B3AB-E06AB7AEDBC5}.Release|x64.ActiveCfg = Release|Any CPU - {24BDBFB9-7849-400D-B3AB-E06AB7AEDBC5}.Release|x64.Build.0 = Release|Any CPU - {24BDBFB9-7849-400D-B3AB-E06AB7AEDBC5}.Release|x86.ActiveCfg = Release|Any CPU - {24BDBFB9-7849-400D-B3AB-E06AB7AEDBC5}.Release|x86.Build.0 = Release|Any CPU - {B5ED1585-8B00-474B-A82E-1C8AEB431646}.Debug.Appveyor|Any CPU.ActiveCfg = Debug|Any CPU - {B5ED1585-8B00-474B-A82E-1C8AEB431646}.Debug.Appveyor|Any CPU.Build.0 = Debug|Any CPU - {B5ED1585-8B00-474B-A82E-1C8AEB431646}.Debug.Appveyor|ARM.ActiveCfg = Debug|Any CPU - {B5ED1585-8B00-474B-A82E-1C8AEB431646}.Debug.Appveyor|ARM.Build.0 = Debug|Any CPU - {B5ED1585-8B00-474B-A82E-1C8AEB431646}.Debug.Appveyor|Mixed Platforms.ActiveCfg = Debug|Any CPU - {B5ED1585-8B00-474B-A82E-1C8AEB431646}.Debug.Appveyor|Mixed Platforms.Build.0 = Debug|Any CPU - {B5ED1585-8B00-474B-A82E-1C8AEB431646}.Debug.Appveyor|x64.ActiveCfg = Debug|Any CPU - {B5ED1585-8B00-474B-A82E-1C8AEB431646}.Debug.Appveyor|x64.Build.0 = Debug|Any CPU - {B5ED1585-8B00-474B-A82E-1C8AEB431646}.Debug.Appveyor|x86.ActiveCfg = Debug|Any CPU - {B5ED1585-8B00-474B-A82E-1C8AEB431646}.Debug.Appveyor|x86.Build.0 = Debug|Any CPU - {B5ED1585-8B00-474B-A82E-1C8AEB431646}.Debug|Any CPU.ActiveCfg = Debug|Any CPU - {B5ED1585-8B00-474B-A82E-1C8AEB431646}.Debug|Any CPU.Build.0 = Debug|Any CPU - {B5ED1585-8B00-474B-A82E-1C8AEB431646}.Debug|ARM.ActiveCfg = Debug|Any CPU - {B5ED1585-8B00-474B-A82E-1C8AEB431646}.Debug|ARM.Build.0 = Debug|Any CPU - {B5ED1585-8B00-474B-A82E-1C8AEB431646}.Debug|Mixed Platforms.ActiveCfg = Debug|Any CPU - {B5ED1585-8B00-474B-A82E-1C8AEB431646}.Debug|Mixed Platforms.Build.0 = Debug|Any CPU - {B5ED1585-8B00-474B-A82E-1C8AEB431646}.Debug|x64.ActiveCfg = Debug|Any CPU - {B5ED1585-8B00-474B-A82E-1C8AEB431646}.Debug|x64.Build.0 = Debug|Any CPU - {B5ED1585-8B00-474B-A82E-1C8AEB431646}.Debug|x86.ActiveCfg = Debug|Any CPU - {B5ED1585-8B00-474B-A82E-1C8AEB431646}.Debug|x86.Build.0 = Debug|Any CPU - {B5ED1585-8B00-474B-A82E-1C8AEB431646}.Release|Any CPU.ActiveCfg = Release|Any CPU - {B5ED1585-8B00-474B-A82E-1C8AEB431646}.Release|Any CPU.Build.0 = Release|Any CPU - {B5ED1585-8B00-474B-A82E-1C8AEB431646}.Release|ARM.ActiveCfg = Release|Any CPU - {B5ED1585-8B00-474B-A82E-1C8AEB431646}.Release|ARM.Build.0 = Release|Any CPU - {B5ED1585-8B00-474B-A82E-1C8AEB431646}.Release|Mixed Platforms.ActiveCfg = Release|Any CPU - {B5ED1585-8B00-474B-A82E-1C8AEB431646}.Release|Mixed Platforms.Build.0 = Release|Any CPU - {B5ED1585-8B00-474B-A82E-1C8AEB431646}.Release|x64.ActiveCfg = Release|Any CPU - {B5ED1585-8B00-474B-A82E-1C8AEB431646}.Release|x64.Build.0 = Release|Any CPU - {B5ED1585-8B00-474B-A82E-1C8AEB431646}.Release|x86.ActiveCfg = Release|Any CPU - {B5ED1585-8B00-474B-A82E-1C8AEB431646}.Release|x86.Build.0 = Release|Any CPU - {B7D1A40A-0E34-485E-9BBD-F0F34F61EC67}.Debug.Appveyor|Any CPU.ActiveCfg = Debug|Any CPU - {B7D1A40A-0E34-485E-9BBD-F0F34F61EC67}.Debug.Appveyor|Any CPU.Build.0 = Debug|Any CPU - {B7D1A40A-0E34-485E-9BBD-F0F34F61EC67}.Debug.Appveyor|ARM.ActiveCfg = Debug|Any CPU - {B7D1A40A-0E34-485E-9BBD-F0F34F61EC67}.Debug.Appveyor|ARM.Build.0 = Debug|Any CPU - {B7D1A40A-0E34-485E-9BBD-F0F34F61EC67}.Debug.Appveyor|Mixed Platforms.ActiveCfg = Debug|Any CPU - {B7D1A40A-0E34-485E-9BBD-F0F34F61EC67}.Debug.Appveyor|Mixed Platforms.Build.0 = Debug|Any CPU - {B7D1A40A-0E34-485E-9BBD-F0F34F61EC67}.Debug.Appveyor|x64.ActiveCfg = Debug|Any CPU - {B7D1A40A-0E34-485E-9BBD-F0F34F61EC67}.Debug.Appveyor|x64.Build.0 = Debug|Any CPU - {B7D1A40A-0E34-485E-9BBD-F0F34F61EC67}.Debug.Appveyor|x86.ActiveCfg = Debug|Any CPU - {B7D1A40A-0E34-485E-9BBD-F0F34F61EC67}.Debug.Appveyor|x86.Build.0 = Debug|Any CPU - {B7D1A40A-0E34-485E-9BBD-F0F34F61EC67}.Debug|Any CPU.ActiveCfg = Debug|Any CPU - {B7D1A40A-0E34-485E-9BBD-F0F34F61EC67}.Debug|Any CPU.Build.0 = Debug|Any CPU - {B7D1A40A-0E34-485E-9BBD-F0F34F61EC67}.Debug|ARM.ActiveCfg = Debug|Any CPU - {B7D1A40A-0E34-485E-9BBD-F0F34F61EC67}.Debug|ARM.Build.0 = Debug|Any CPU - {B7D1A40A-0E34-485E-9BBD-F0F34F61EC67}.Debug|Mixed Platforms.ActiveCfg = Debug|Any CPU - {B7D1A40A-0E34-485E-9BBD-F0F34F61EC67}.Debug|Mixed Platforms.Build.0 = Debug|Any CPU - {B7D1A40A-0E34-485E-9BBD-F0F34F61EC67}.Debug|x64.ActiveCfg = Debug|Any CPU - {B7D1A40A-0E34-485E-9BBD-F0F34F61EC67}.Debug|x64.Build.0 = Debug|Any CPU - {B7D1A40A-0E34-485E-9BBD-F0F34F61EC67}.Debug|x86.ActiveCfg = Debug|Any CPU - {B7D1A40A-0E34-485E-9BBD-F0F34F61EC67}.Debug|x86.Build.0 = Debug|Any CPU - {B7D1A40A-0E34-485E-9BBD-F0F34F61EC67}.Release|Any CPU.ActiveCfg = Release|Any CPU - {B7D1A40A-0E34-485E-9BBD-F0F34F61EC67}.Release|Any CPU.Build.0 = Release|Any CPU - {B7D1A40A-0E34-485E-9BBD-F0F34F61EC67}.Release|ARM.ActiveCfg = Release|Any CPU - {B7D1A40A-0E34-485E-9BBD-F0F34F61EC67}.Release|ARM.Build.0 = Release|Any CPU - {B7D1A40A-0E34-485E-9BBD-F0F34F61EC67}.Release|Mixed Platforms.ActiveCfg = Release|Any CPU - {B7D1A40A-0E34-485E-9BBD-F0F34F61EC67}.Release|Mixed Platforms.Build.0 = Release|Any CPU - {B7D1A40A-0E34-485E-9BBD-F0F34F61EC67}.Release|x64.ActiveCfg = Release|Any CPU - {B7D1A40A-0E34-485E-9BBD-F0F34F61EC67}.Release|x64.Build.0 = Release|Any CPU - {B7D1A40A-0E34-485E-9BBD-F0F34F61EC67}.Release|x86.ActiveCfg = Release|Any CPU - {B7D1A40A-0E34-485E-9BBD-F0F34F61EC67}.Release|x86.Build.0 = Release|Any CPU + {43A1D5D2-650D-40DD-A6C0-14F92689C70B}.Debug.Appveyor|Any CPU.ActiveCfg = Debug|Any CPU + {43A1D5D2-650D-40DD-A6C0-14F92689C70B}.Debug.Appveyor|Any CPU.Build.0 = Debug|Any CPU + {43A1D5D2-650D-40DD-A6C0-14F92689C70B}.Debug.Appveyor|ARM.ActiveCfg = Debug|Any CPU + {43A1D5D2-650D-40DD-A6C0-14F92689C70B}.Debug.Appveyor|ARM.Build.0 = Debug|Any CPU + {43A1D5D2-650D-40DD-A6C0-14F92689C70B}.Debug.Appveyor|Mixed Platforms.ActiveCfg = Debug|Any CPU + {43A1D5D2-650D-40DD-A6C0-14F92689C70B}.Debug.Appveyor|Mixed Platforms.Build.0 = Debug|Any CPU + {43A1D5D2-650D-40DD-A6C0-14F92689C70B}.Debug.Appveyor|x64.ActiveCfg = Debug|Any CPU + {43A1D5D2-650D-40DD-A6C0-14F92689C70B}.Debug.Appveyor|x64.Build.0 = Debug|Any CPU + {43A1D5D2-650D-40DD-A6C0-14F92689C70B}.Debug.Appveyor|x86.ActiveCfg = Debug|Any CPU + {43A1D5D2-650D-40DD-A6C0-14F92689C70B}.Debug.Appveyor|x86.Build.0 = Debug|Any CPU + {43A1D5D2-650D-40DD-A6C0-14F92689C70B}.Debug|Any CPU.ActiveCfg = Debug|Any CPU + {43A1D5D2-650D-40DD-A6C0-14F92689C70B}.Debug|Any CPU.Build.0 = Debug|Any CPU + {43A1D5D2-650D-40DD-A6C0-14F92689C70B}.Debug|ARM.ActiveCfg = Debug|Any CPU + {43A1D5D2-650D-40DD-A6C0-14F92689C70B}.Debug|ARM.Build.0 = Debug|Any CPU + {43A1D5D2-650D-40DD-A6C0-14F92689C70B}.Debug|Mixed Platforms.ActiveCfg = Debug|Any CPU + {43A1D5D2-650D-40DD-A6C0-14F92689C70B}.Debug|Mixed Platforms.Build.0 = Debug|Any CPU + {43A1D5D2-650D-40DD-A6C0-14F92689C70B}.Debug|x64.ActiveCfg = Debug|Any CPU + {43A1D5D2-650D-40DD-A6C0-14F92689C70B}.Debug|x64.Build.0 = Debug|Any CPU + {43A1D5D2-650D-40DD-A6C0-14F92689C70B}.Debug|x86.ActiveCfg = Debug|Any CPU + {43A1D5D2-650D-40DD-A6C0-14F92689C70B}.Debug|x86.Build.0 = Debug|Any CPU + {43A1D5D2-650D-40DD-A6C0-14F92689C70B}.Release|Any CPU.ActiveCfg = Release|Any CPU + {43A1D5D2-650D-40DD-A6C0-14F92689C70B}.Release|Any CPU.Build.0 = Release|Any CPU + {43A1D5D2-650D-40DD-A6C0-14F92689C70B}.Release|ARM.ActiveCfg = Release|Any CPU + {43A1D5D2-650D-40DD-A6C0-14F92689C70B}.Release|ARM.Build.0 = Release|Any CPU + {43A1D5D2-650D-40DD-A6C0-14F92689C70B}.Release|Mixed Platforms.ActiveCfg = Release|Any CPU + {43A1D5D2-650D-40DD-A6C0-14F92689C70B}.Release|Mixed Platforms.Build.0 = Release|Any CPU + {43A1D5D2-650D-40DD-A6C0-14F92689C70B}.Release|x64.ActiveCfg = Release|Any CPU + {43A1D5D2-650D-40DD-A6C0-14F92689C70B}.Release|x64.Build.0 = Release|Any CPU + {43A1D5D2-650D-40DD-A6C0-14F92689C70B}.Release|x86.ActiveCfg = Release|Any CPU + {43A1D5D2-650D-40DD-A6C0-14F92689C70B}.Release|x86.Build.0 = Release|Any CPU + {B1C55C9B-3287-4EB2-8ADD-795DBC77013D}.Debug.Appveyor|Any CPU.ActiveCfg = Debug|Any CPU + {B1C55C9B-3287-4EB2-8ADD-795DBC77013D}.Debug.Appveyor|Any CPU.Build.0 = Debug|Any CPU + {B1C55C9B-3287-4EB2-8ADD-795DBC77013D}.Debug.Appveyor|ARM.ActiveCfg = Debug|Any CPU + {B1C55C9B-3287-4EB2-8ADD-795DBC77013D}.Debug.Appveyor|ARM.Build.0 = Debug|Any CPU + {B1C55C9B-3287-4EB2-8ADD-795DBC77013D}.Debug.Appveyor|Mixed Platforms.ActiveCfg = Debug|Any CPU + {B1C55C9B-3287-4EB2-8ADD-795DBC77013D}.Debug.Appveyor|Mixed Platforms.Build.0 = Debug|Any CPU + {B1C55C9B-3287-4EB2-8ADD-795DBC77013D}.Debug.Appveyor|x64.ActiveCfg = Debug|Any CPU + {B1C55C9B-3287-4EB2-8ADD-795DBC77013D}.Debug.Appveyor|x64.Build.0 = Debug|Any CPU + {B1C55C9B-3287-4EB2-8ADD-795DBC77013D}.Debug.Appveyor|x86.ActiveCfg = Debug|Any CPU + {B1C55C9B-3287-4EB2-8ADD-795DBC77013D}.Debug.Appveyor|x86.Build.0 = Debug|Any CPU + {B1C55C9B-3287-4EB2-8ADD-795DBC77013D}.Debug|Any CPU.ActiveCfg = Debug|Any CPU + {B1C55C9B-3287-4EB2-8ADD-795DBC77013D}.Debug|Any CPU.Build.0 = Debug|Any CPU + {B1C55C9B-3287-4EB2-8ADD-795DBC77013D}.Debug|ARM.ActiveCfg = Debug|Any CPU + {B1C55C9B-3287-4EB2-8ADD-795DBC77013D}.Debug|ARM.Build.0 = Debug|Any CPU + {B1C55C9B-3287-4EB2-8ADD-795DBC77013D}.Debug|Mixed Platforms.ActiveCfg = Debug|Any CPU + {B1C55C9B-3287-4EB2-8ADD-795DBC77013D}.Debug|Mixed Platforms.Build.0 = Debug|Any CPU + {B1C55C9B-3287-4EB2-8ADD-795DBC77013D}.Debug|x64.ActiveCfg = Debug|Any CPU + {B1C55C9B-3287-4EB2-8ADD-795DBC77013D}.Debug|x64.Build.0 = Debug|Any CPU + {B1C55C9B-3287-4EB2-8ADD-795DBC77013D}.Debug|x86.ActiveCfg = Debug|Any CPU + {B1C55C9B-3287-4EB2-8ADD-795DBC77013D}.Debug|x86.Build.0 = Debug|Any CPU + {B1C55C9B-3287-4EB2-8ADD-795DBC77013D}.Release|Any CPU.ActiveCfg = Release|Any CPU + {B1C55C9B-3287-4EB2-8ADD-795DBC77013D}.Release|Any CPU.Build.0 = Release|Any CPU + {B1C55C9B-3287-4EB2-8ADD-795DBC77013D}.Release|ARM.ActiveCfg = Release|Any CPU + {B1C55C9B-3287-4EB2-8ADD-795DBC77013D}.Release|ARM.Build.0 = Release|Any CPU + {B1C55C9B-3287-4EB2-8ADD-795DBC77013D}.Release|Mixed Platforms.ActiveCfg = Release|Any CPU + {B1C55C9B-3287-4EB2-8ADD-795DBC77013D}.Release|Mixed Platforms.Build.0 = Release|Any CPU + {B1C55C9B-3287-4EB2-8ADD-795DBC77013D}.Release|x64.ActiveCfg = Release|Any CPU + {B1C55C9B-3287-4EB2-8ADD-795DBC77013D}.Release|x64.Build.0 = Release|Any CPU + {B1C55C9B-3287-4EB2-8ADD-795DBC77013D}.Release|x86.ActiveCfg = Release|Any CPU + {B1C55C9B-3287-4EB2-8ADD-795DBC77013D}.Release|x86.Build.0 = Release|Any CPU + {AC3B3DDC-F011-4E19-8C9B-F748B19ED3C0}.Debug.Appveyor|Any CPU.ActiveCfg = Debug|Any CPU + {AC3B3DDC-F011-4E19-8C9B-F748B19ED3C0}.Debug.Appveyor|Any CPU.Build.0 = Debug|Any CPU + {AC3B3DDC-F011-4E19-8C9B-F748B19ED3C0}.Debug.Appveyor|ARM.ActiveCfg = Debug|Any CPU + {AC3B3DDC-F011-4E19-8C9B-F748B19ED3C0}.Debug.Appveyor|ARM.Build.0 = Debug|Any CPU + {AC3B3DDC-F011-4E19-8C9B-F748B19ED3C0}.Debug.Appveyor|Mixed Platforms.ActiveCfg = Debug|Any CPU + {AC3B3DDC-F011-4E19-8C9B-F748B19ED3C0}.Debug.Appveyor|Mixed Platforms.Build.0 = Debug|Any CPU + {AC3B3DDC-F011-4E19-8C9B-F748B19ED3C0}.Debug.Appveyor|x64.ActiveCfg = Debug|Any CPU + {AC3B3DDC-F011-4E19-8C9B-F748B19ED3C0}.Debug.Appveyor|x64.Build.0 = Debug|Any CPU + {AC3B3DDC-F011-4E19-8C9B-F748B19ED3C0}.Debug.Appveyor|x86.ActiveCfg = Debug|Any CPU + {AC3B3DDC-F011-4E19-8C9B-F748B19ED3C0}.Debug.Appveyor|x86.Build.0 = Debug|Any CPU + {AC3B3DDC-F011-4E19-8C9B-F748B19ED3C0}.Debug|Any CPU.ActiveCfg = Debug|Any CPU + {AC3B3DDC-F011-4E19-8C9B-F748B19ED3C0}.Debug|Any CPU.Build.0 = Debug|Any CPU + {AC3B3DDC-F011-4E19-8C9B-F748B19ED3C0}.Debug|ARM.ActiveCfg = Debug|Any CPU + {AC3B3DDC-F011-4E19-8C9B-F748B19ED3C0}.Debug|ARM.Build.0 = Debug|Any CPU + {AC3B3DDC-F011-4E19-8C9B-F748B19ED3C0}.Debug|Mixed Platforms.ActiveCfg = Debug|Any CPU + {AC3B3DDC-F011-4E19-8C9B-F748B19ED3C0}.Debug|Mixed Platforms.Build.0 = Debug|Any CPU + {AC3B3DDC-F011-4E19-8C9B-F748B19ED3C0}.Debug|x64.ActiveCfg = Debug|Any CPU + {AC3B3DDC-F011-4E19-8C9B-F748B19ED3C0}.Debug|x64.Build.0 = Debug|Any CPU + {AC3B3DDC-F011-4E19-8C9B-F748B19ED3C0}.Debug|x86.ActiveCfg = Debug|Any CPU + {AC3B3DDC-F011-4E19-8C9B-F748B19ED3C0}.Debug|x86.Build.0 = Debug|Any CPU + {AC3B3DDC-F011-4E19-8C9B-F748B19ED3C0}.Release|Any CPU.ActiveCfg = Release|Any CPU + {AC3B3DDC-F011-4E19-8C9B-F748B19ED3C0}.Release|Any CPU.Build.0 = Release|Any CPU + {AC3B3DDC-F011-4E19-8C9B-F748B19ED3C0}.Release|ARM.ActiveCfg = Release|Any CPU + {AC3B3DDC-F011-4E19-8C9B-F748B19ED3C0}.Release|ARM.Build.0 = Release|Any CPU + {AC3B3DDC-F011-4E19-8C9B-F748B19ED3C0}.Release|Mixed Platforms.ActiveCfg = Release|Any CPU + {AC3B3DDC-F011-4E19-8C9B-F748B19ED3C0}.Release|Mixed Platforms.Build.0 = Release|Any CPU + {AC3B3DDC-F011-4E19-8C9B-F748B19ED3C0}.Release|x64.ActiveCfg = Release|Any CPU + {AC3B3DDC-F011-4E19-8C9B-F748B19ED3C0}.Release|x64.Build.0 = Release|Any CPU + {AC3B3DDC-F011-4E19-8C9B-F748B19ED3C0}.Release|x86.ActiveCfg = Release|Any CPU + {AC3B3DDC-F011-4E19-8C9B-F748B19ED3C0}.Release|x86.Build.0 = Release|Any CPU + {4205A187-9732-4DA8-B0BE-77A2C6B8C6A1}.Debug.Appveyor|Any CPU.ActiveCfg = Debug|Any CPU + {4205A187-9732-4DA8-B0BE-77A2C6B8C6A1}.Debug.Appveyor|Any CPU.Build.0 = Debug|Any CPU + {4205A187-9732-4DA8-B0BE-77A2C6B8C6A1}.Debug.Appveyor|ARM.ActiveCfg = Debug|Any CPU + {4205A187-9732-4DA8-B0BE-77A2C6B8C6A1}.Debug.Appveyor|ARM.Build.0 = Debug|Any CPU + {4205A187-9732-4DA8-B0BE-77A2C6B8C6A1}.Debug.Appveyor|Mixed Platforms.ActiveCfg = Debug|Any CPU + {4205A187-9732-4DA8-B0BE-77A2C6B8C6A1}.Debug.Appveyor|Mixed Platforms.Build.0 = Debug|Any CPU + {4205A187-9732-4DA8-B0BE-77A2C6B8C6A1}.Debug.Appveyor|x64.ActiveCfg = Debug|Any CPU + {4205A187-9732-4DA8-B0BE-77A2C6B8C6A1}.Debug.Appveyor|x64.Build.0 = Debug|Any CPU + {4205A187-9732-4DA8-B0BE-77A2C6B8C6A1}.Debug.Appveyor|x86.ActiveCfg = Debug|Any CPU + {4205A187-9732-4DA8-B0BE-77A2C6B8C6A1}.Debug.Appveyor|x86.Build.0 = Debug|Any CPU + {4205A187-9732-4DA8-B0BE-77A2C6B8C6A1}.Debug|Any CPU.ActiveCfg = Debug|Any CPU + {4205A187-9732-4DA8-B0BE-77A2C6B8C6A1}.Debug|Any CPU.Build.0 = Debug|Any CPU + {4205A187-9732-4DA8-B0BE-77A2C6B8C6A1}.Debug|ARM.ActiveCfg = Debug|Any CPU + {4205A187-9732-4DA8-B0BE-77A2C6B8C6A1}.Debug|ARM.Build.0 = Debug|Any CPU + {4205A187-9732-4DA8-B0BE-77A2C6B8C6A1}.Debug|Mixed Platforms.ActiveCfg = Debug|Any CPU + {4205A187-9732-4DA8-B0BE-77A2C6B8C6A1}.Debug|Mixed Platforms.Build.0 = Debug|Any CPU + {4205A187-9732-4DA8-B0BE-77A2C6B8C6A1}.Debug|x64.ActiveCfg = Debug|Any CPU + {4205A187-9732-4DA8-B0BE-77A2C6B8C6A1}.Debug|x64.Build.0 = Debug|Any CPU + {4205A187-9732-4DA8-B0BE-77A2C6B8C6A1}.Debug|x86.ActiveCfg = Debug|Any CPU + {4205A187-9732-4DA8-B0BE-77A2C6B8C6A1}.Debug|x86.Build.0 = Debug|Any CPU + {4205A187-9732-4DA8-B0BE-77A2C6B8C6A1}.Release|Any CPU.ActiveCfg = Release|Any CPU + {4205A187-9732-4DA8-B0BE-77A2C6B8C6A1}.Release|Any CPU.Build.0 = Release|Any CPU + {4205A187-9732-4DA8-B0BE-77A2C6B8C6A1}.Release|ARM.ActiveCfg = Release|Any CPU + {4205A187-9732-4DA8-B0BE-77A2C6B8C6A1}.Release|ARM.Build.0 = Release|Any CPU + {4205A187-9732-4DA8-B0BE-77A2C6B8C6A1}.Release|Mixed Platforms.ActiveCfg = Release|Any CPU + {4205A187-9732-4DA8-B0BE-77A2C6B8C6A1}.Release|Mixed Platforms.Build.0 = Release|Any CPU + {4205A187-9732-4DA8-B0BE-77A2C6B8C6A1}.Release|x64.ActiveCfg = Release|Any CPU + {4205A187-9732-4DA8-B0BE-77A2C6B8C6A1}.Release|x64.Build.0 = Release|Any CPU + {4205A187-9732-4DA8-B0BE-77A2C6B8C6A1}.Release|x86.ActiveCfg = Release|Any CPU + {4205A187-9732-4DA8-B0BE-77A2C6B8C6A1}.Release|x86.Build.0 = Release|Any CPU + {73896669-F05C-41AC-9F6F-A11F549EDEDC}.Debug.Appveyor|Any CPU.ActiveCfg = Debug|Any CPU + {73896669-F05C-41AC-9F6F-A11F549EDEDC}.Debug.Appveyor|Any CPU.Build.0 = Debug|Any CPU + {73896669-F05C-41AC-9F6F-A11F549EDEDC}.Debug.Appveyor|ARM.ActiveCfg = Debug|Any CPU + {73896669-F05C-41AC-9F6F-A11F549EDEDC}.Debug.Appveyor|ARM.Build.0 = Debug|Any CPU + {73896669-F05C-41AC-9F6F-A11F549EDEDC}.Debug.Appveyor|Mixed Platforms.ActiveCfg = Debug|Any CPU + {73896669-F05C-41AC-9F6F-A11F549EDEDC}.Debug.Appveyor|Mixed Platforms.Build.0 = Debug|Any CPU + {73896669-F05C-41AC-9F6F-A11F549EDEDC}.Debug.Appveyor|x64.ActiveCfg = Debug|Any CPU + {73896669-F05C-41AC-9F6F-A11F549EDEDC}.Debug.Appveyor|x64.Build.0 = Debug|Any CPU + {73896669-F05C-41AC-9F6F-A11F549EDEDC}.Debug.Appveyor|x86.ActiveCfg = Debug|Any CPU + {73896669-F05C-41AC-9F6F-A11F549EDEDC}.Debug.Appveyor|x86.Build.0 = Debug|Any CPU + {73896669-F05C-41AC-9F6F-A11F549EDEDC}.Debug|Any CPU.ActiveCfg = Debug|Any CPU + {73896669-F05C-41AC-9F6F-A11F549EDEDC}.Debug|Any CPU.Build.0 = Debug|Any CPU + {73896669-F05C-41AC-9F6F-A11F549EDEDC}.Debug|ARM.ActiveCfg = Debug|Any CPU + {73896669-F05C-41AC-9F6F-A11F549EDEDC}.Debug|ARM.Build.0 = Debug|Any CPU + {73896669-F05C-41AC-9F6F-A11F549EDEDC}.Debug|Mixed Platforms.ActiveCfg = Debug|Any CPU + {73896669-F05C-41AC-9F6F-A11F549EDEDC}.Debug|Mixed Platforms.Build.0 = Debug|Any CPU + {73896669-F05C-41AC-9F6F-A11F549EDEDC}.Debug|x64.ActiveCfg = Debug|Any CPU + {73896669-F05C-41AC-9F6F-A11F549EDEDC}.Debug|x64.Build.0 = Debug|Any CPU + {73896669-F05C-41AC-9F6F-A11F549EDEDC}.Debug|x86.ActiveCfg = Debug|Any CPU + {73896669-F05C-41AC-9F6F-A11F549EDEDC}.Debug|x86.Build.0 = Debug|Any CPU + {73896669-F05C-41AC-9F6F-A11F549EDEDC}.Release|Any CPU.ActiveCfg = Release|Any CPU + {73896669-F05C-41AC-9F6F-A11F549EDEDC}.Release|Any CPU.Build.0 = Release|Any CPU + {73896669-F05C-41AC-9F6F-A11F549EDEDC}.Release|ARM.ActiveCfg = Release|Any CPU + {73896669-F05C-41AC-9F6F-A11F549EDEDC}.Release|ARM.Build.0 = Release|Any CPU + {73896669-F05C-41AC-9F6F-A11F549EDEDC}.Release|Mixed Platforms.ActiveCfg = Release|Any CPU + {73896669-F05C-41AC-9F6F-A11F549EDEDC}.Release|Mixed Platforms.Build.0 = Release|Any CPU + {73896669-F05C-41AC-9F6F-A11F549EDEDC}.Release|x64.ActiveCfg = Release|Any CPU + {73896669-F05C-41AC-9F6F-A11F549EDEDC}.Release|x64.Build.0 = Release|Any CPU + {73896669-F05C-41AC-9F6F-A11F549EDEDC}.Release|x86.ActiveCfg = Release|Any CPU + {73896669-F05C-41AC-9F6F-A11F549EDEDC}.Release|x86.Build.0 = Release|Any CPU + {8BF81225-2F85-4412-AD18-6579CBA1879B}.Debug.Appveyor|Any CPU.ActiveCfg = Debug|Any CPU + {8BF81225-2F85-4412-AD18-6579CBA1879B}.Debug.Appveyor|Any CPU.Build.0 = Debug|Any CPU + {8BF81225-2F85-4412-AD18-6579CBA1879B}.Debug.Appveyor|ARM.ActiveCfg = Debug|Any CPU + {8BF81225-2F85-4412-AD18-6579CBA1879B}.Debug.Appveyor|ARM.Build.0 = Debug|Any CPU + {8BF81225-2F85-4412-AD18-6579CBA1879B}.Debug.Appveyor|Mixed Platforms.ActiveCfg = Debug|Any CPU + {8BF81225-2F85-4412-AD18-6579CBA1879B}.Debug.Appveyor|Mixed Platforms.Build.0 = Debug|Any CPU + {8BF81225-2F85-4412-AD18-6579CBA1879B}.Debug.Appveyor|x64.ActiveCfg = Debug|Any CPU + {8BF81225-2F85-4412-AD18-6579CBA1879B}.Debug.Appveyor|x64.Build.0 = Debug|Any CPU + {8BF81225-2F85-4412-AD18-6579CBA1879B}.Debug.Appveyor|x86.ActiveCfg = Debug|Any CPU + {8BF81225-2F85-4412-AD18-6579CBA1879B}.Debug.Appveyor|x86.Build.0 = Debug|Any CPU + {8BF81225-2F85-4412-AD18-6579CBA1879B}.Debug|Any CPU.ActiveCfg = Debug|Any CPU + {8BF81225-2F85-4412-AD18-6579CBA1879B}.Debug|Any CPU.Build.0 = Debug|Any CPU + {8BF81225-2F85-4412-AD18-6579CBA1879B}.Debug|ARM.ActiveCfg = Debug|Any CPU + {8BF81225-2F85-4412-AD18-6579CBA1879B}.Debug|ARM.Build.0 = Debug|Any CPU + {8BF81225-2F85-4412-AD18-6579CBA1879B}.Debug|Mixed Platforms.ActiveCfg = Debug|Any CPU + {8BF81225-2F85-4412-AD18-6579CBA1879B}.Debug|Mixed Platforms.Build.0 = Debug|Any CPU + {8BF81225-2F85-4412-AD18-6579CBA1879B}.Debug|x64.ActiveCfg = Debug|Any CPU + {8BF81225-2F85-4412-AD18-6579CBA1879B}.Debug|x64.Build.0 = Debug|Any CPU + {8BF81225-2F85-4412-AD18-6579CBA1879B}.Debug|x86.ActiveCfg = Debug|Any CPU + {8BF81225-2F85-4412-AD18-6579CBA1879B}.Debug|x86.Build.0 = Debug|Any CPU + {8BF81225-2F85-4412-AD18-6579CBA1879B}.Release|Any CPU.ActiveCfg = Release|Any CPU + {8BF81225-2F85-4412-AD18-6579CBA1879B}.Release|Any CPU.Build.0 = Release|Any CPU + {8BF81225-2F85-4412-AD18-6579CBA1879B}.Release|ARM.ActiveCfg = Release|Any CPU + {8BF81225-2F85-4412-AD18-6579CBA1879B}.Release|ARM.Build.0 = Release|Any CPU + {8BF81225-2F85-4412-AD18-6579CBA1879B}.Release|Mixed Platforms.ActiveCfg = Release|Any CPU + {8BF81225-2F85-4412-AD18-6579CBA1879B}.Release|Mixed Platforms.Build.0 = Release|Any CPU + {8BF81225-2F85-4412-AD18-6579CBA1879B}.Release|x64.ActiveCfg = Release|Any CPU + {8BF81225-2F85-4412-AD18-6579CBA1879B}.Release|x64.Build.0 = Release|Any CPU + {8BF81225-2F85-4412-AD18-6579CBA1879B}.Release|x86.ActiveCfg = Release|Any CPU + {8BF81225-2F85-4412-AD18-6579CBA1879B}.Release|x86.Build.0 = Release|Any CPU + {997AEFE5-D7D4-4033-A31A-07F476D6FE5D}.Debug.Appveyor|Any CPU.ActiveCfg = Debug|Any CPU + {997AEFE5-D7D4-4033-A31A-07F476D6FE5D}.Debug.Appveyor|Any CPU.Build.0 = Debug|Any CPU + {997AEFE5-D7D4-4033-A31A-07F476D6FE5D}.Debug.Appveyor|ARM.ActiveCfg = Debug|Any CPU + {997AEFE5-D7D4-4033-A31A-07F476D6FE5D}.Debug.Appveyor|ARM.Build.0 = Debug|Any CPU + {997AEFE5-D7D4-4033-A31A-07F476D6FE5D}.Debug.Appveyor|Mixed Platforms.ActiveCfg = Debug|Any CPU + {997AEFE5-D7D4-4033-A31A-07F476D6FE5D}.Debug.Appveyor|Mixed Platforms.Build.0 = Debug|Any CPU + {997AEFE5-D7D4-4033-A31A-07F476D6FE5D}.Debug.Appveyor|x64.ActiveCfg = Debug|Any CPU + {997AEFE5-D7D4-4033-A31A-07F476D6FE5D}.Debug.Appveyor|x64.Build.0 = Debug|Any CPU + {997AEFE5-D7D4-4033-A31A-07F476D6FE5D}.Debug.Appveyor|x86.ActiveCfg = Debug|Any CPU + {997AEFE5-D7D4-4033-A31A-07F476D6FE5D}.Debug.Appveyor|x86.Build.0 = Debug|Any CPU + {997AEFE5-D7D4-4033-A31A-07F476D6FE5D}.Debug|Any CPU.ActiveCfg = Debug|Any CPU + {997AEFE5-D7D4-4033-A31A-07F476D6FE5D}.Debug|Any CPU.Build.0 = Debug|Any CPU + {997AEFE5-D7D4-4033-A31A-07F476D6FE5D}.Debug|ARM.ActiveCfg = Debug|Any CPU + {997AEFE5-D7D4-4033-A31A-07F476D6FE5D}.Debug|ARM.Build.0 = Debug|Any CPU + {997AEFE5-D7D4-4033-A31A-07F476D6FE5D}.Debug|Mixed Platforms.ActiveCfg = Debug|Any CPU + {997AEFE5-D7D4-4033-A31A-07F476D6FE5D}.Debug|Mixed Platforms.Build.0 = Debug|Any CPU + {997AEFE5-D7D4-4033-A31A-07F476D6FE5D}.Debug|x64.ActiveCfg = Debug|Any CPU + {997AEFE5-D7D4-4033-A31A-07F476D6FE5D}.Debug|x64.Build.0 = Debug|Any CPU + {997AEFE5-D7D4-4033-A31A-07F476D6FE5D}.Debug|x86.ActiveCfg = Debug|Any CPU + {997AEFE5-D7D4-4033-A31A-07F476D6FE5D}.Debug|x86.Build.0 = Debug|Any CPU + {997AEFE5-D7D4-4033-A31A-07F476D6FE5D}.Release|Any CPU.ActiveCfg = Release|Any CPU + {997AEFE5-D7D4-4033-A31A-07F476D6FE5D}.Release|Any CPU.Build.0 = Release|Any CPU + {997AEFE5-D7D4-4033-A31A-07F476D6FE5D}.Release|ARM.ActiveCfg = Release|Any CPU + {997AEFE5-D7D4-4033-A31A-07F476D6FE5D}.Release|ARM.Build.0 = Release|Any CPU + {997AEFE5-D7D4-4033-A31A-07F476D6FE5D}.Release|Mixed Platforms.ActiveCfg = Release|Any CPU + {997AEFE5-D7D4-4033-A31A-07F476D6FE5D}.Release|Mixed Platforms.Build.0 = Release|Any CPU + {997AEFE5-D7D4-4033-A31A-07F476D6FE5D}.Release|x64.ActiveCfg = Release|Any CPU + {997AEFE5-D7D4-4033-A31A-07F476D6FE5D}.Release|x64.Build.0 = Release|Any CPU + {997AEFE5-D7D4-4033-A31A-07F476D6FE5D}.Release|x86.ActiveCfg = Release|Any CPU + {997AEFE5-D7D4-4033-A31A-07F476D6FE5D}.Release|x86.Build.0 = Release|Any CPU + {6D7D1D60-4473-4C52-800C-9B892C6640A5}.Debug.Appveyor|Any CPU.ActiveCfg = Debug|Any CPU + {6D7D1D60-4473-4C52-800C-9B892C6640A5}.Debug.Appveyor|Any CPU.Build.0 = Debug|Any CPU + {6D7D1D60-4473-4C52-800C-9B892C6640A5}.Debug.Appveyor|ARM.ActiveCfg = Debug|Any CPU + {6D7D1D60-4473-4C52-800C-9B892C6640A5}.Debug.Appveyor|ARM.Build.0 = Debug|Any CPU + {6D7D1D60-4473-4C52-800C-9B892C6640A5}.Debug.Appveyor|Mixed Platforms.ActiveCfg = Debug|Any CPU + {6D7D1D60-4473-4C52-800C-9B892C6640A5}.Debug.Appveyor|Mixed Platforms.Build.0 = Debug|Any CPU + {6D7D1D60-4473-4C52-800C-9B892C6640A5}.Debug.Appveyor|x64.ActiveCfg = Debug|Any CPU + {6D7D1D60-4473-4C52-800C-9B892C6640A5}.Debug.Appveyor|x64.Build.0 = Debug|Any CPU + {6D7D1D60-4473-4C52-800C-9B892C6640A5}.Debug.Appveyor|x86.ActiveCfg = Debug|Any CPU + {6D7D1D60-4473-4C52-800C-9B892C6640A5}.Debug.Appveyor|x86.Build.0 = Debug|Any CPU + {6D7D1D60-4473-4C52-800C-9B892C6640A5}.Debug|Any CPU.ActiveCfg = Debug|Any CPU + {6D7D1D60-4473-4C52-800C-9B892C6640A5}.Debug|Any CPU.Build.0 = Debug|Any CPU + {6D7D1D60-4473-4C52-800C-9B892C6640A5}.Debug|ARM.ActiveCfg = Debug|Any CPU + {6D7D1D60-4473-4C52-800C-9B892C6640A5}.Debug|ARM.Build.0 = Debug|Any CPU + {6D7D1D60-4473-4C52-800C-9B892C6640A5}.Debug|Mixed Platforms.ActiveCfg = Debug|Any CPU + {6D7D1D60-4473-4C52-800C-9B892C6640A5}.Debug|Mixed Platforms.Build.0 = Debug|Any CPU + {6D7D1D60-4473-4C52-800C-9B892C6640A5}.Debug|x64.ActiveCfg = Debug|Any CPU + {6D7D1D60-4473-4C52-800C-9B892C6640A5}.Debug|x64.Build.0 = Debug|Any CPU + {6D7D1D60-4473-4C52-800C-9B892C6640A5}.Debug|x86.ActiveCfg = Debug|Any CPU + {6D7D1D60-4473-4C52-800C-9B892C6640A5}.Debug|x86.Build.0 = Debug|Any CPU + {6D7D1D60-4473-4C52-800C-9B892C6640A5}.Release|Any CPU.ActiveCfg = Release|Any CPU + {6D7D1D60-4473-4C52-800C-9B892C6640A5}.Release|Any CPU.Build.0 = Release|Any CPU + {6D7D1D60-4473-4C52-800C-9B892C6640A5}.Release|ARM.ActiveCfg = Release|Any CPU + {6D7D1D60-4473-4C52-800C-9B892C6640A5}.Release|ARM.Build.0 = Release|Any CPU + {6D7D1D60-4473-4C52-800C-9B892C6640A5}.Release|Mixed Platforms.ActiveCfg = Release|Any CPU + {6D7D1D60-4473-4C52-800C-9B892C6640A5}.Release|Mixed Platforms.Build.0 = Release|Any CPU + {6D7D1D60-4473-4C52-800C-9B892C6640A5}.Release|x64.ActiveCfg = Release|Any CPU + {6D7D1D60-4473-4C52-800C-9B892C6640A5}.Release|x64.Build.0 = Release|Any CPU + {6D7D1D60-4473-4C52-800C-9B892C6640A5}.Release|x86.ActiveCfg = Release|Any CPU + {6D7D1D60-4473-4C52-800C-9B892C6640A5}.Release|x86.Build.0 = Release|Any CPU + {E6D94C12-9AD7-46E6-AB62-3676F25FDE51}.Debug.Appveyor|Any CPU.ActiveCfg = Debug|Any CPU + {E6D94C12-9AD7-46E6-AB62-3676F25FDE51}.Debug.Appveyor|Any CPU.Build.0 = Debug|Any CPU + {E6D94C12-9AD7-46E6-AB62-3676F25FDE51}.Debug.Appveyor|ARM.ActiveCfg = Debug|Any CPU + {E6D94C12-9AD7-46E6-AB62-3676F25FDE51}.Debug.Appveyor|ARM.Build.0 = Debug|Any CPU + {E6D94C12-9AD7-46E6-AB62-3676F25FDE51}.Debug.Appveyor|Mixed Platforms.ActiveCfg = Debug|Any CPU + {E6D94C12-9AD7-46E6-AB62-3676F25FDE51}.Debug.Appveyor|Mixed Platforms.Build.0 = Debug|Any CPU + {E6D94C12-9AD7-46E6-AB62-3676F25FDE51}.Debug.Appveyor|x64.ActiveCfg = Debug|Any CPU + {E6D94C12-9AD7-46E6-AB62-3676F25FDE51}.Debug.Appveyor|x64.Build.0 = Debug|Any CPU + {E6D94C12-9AD7-46E6-AB62-3676F25FDE51}.Debug.Appveyor|x86.ActiveCfg = Debug|Any CPU + {E6D94C12-9AD7-46E6-AB62-3676F25FDE51}.Debug.Appveyor|x86.Build.0 = Debug|Any CPU + {E6D94C12-9AD7-46E6-AB62-3676F25FDE51}.Debug|Any CPU.ActiveCfg = Debug|Any CPU + {E6D94C12-9AD7-46E6-AB62-3676F25FDE51}.Debug|Any CPU.Build.0 = Debug|Any CPU + {E6D94C12-9AD7-46E6-AB62-3676F25FDE51}.Debug|ARM.ActiveCfg = Debug|Any CPU + {E6D94C12-9AD7-46E6-AB62-3676F25FDE51}.Debug|ARM.Build.0 = Debug|Any CPU + {E6D94C12-9AD7-46E6-AB62-3676F25FDE51}.Debug|Mixed Platforms.ActiveCfg = Debug|Any CPU + {E6D94C12-9AD7-46E6-AB62-3676F25FDE51}.Debug|Mixed Platforms.Build.0 = Debug|Any CPU + {E6D94C12-9AD7-46E6-AB62-3676F25FDE51}.Debug|x64.ActiveCfg = Debug|Any CPU + {E6D94C12-9AD7-46E6-AB62-3676F25FDE51}.Debug|x64.Build.0 = Debug|Any CPU + {E6D94C12-9AD7-46E6-AB62-3676F25FDE51}.Debug|x86.ActiveCfg = Debug|Any CPU + {E6D94C12-9AD7-46E6-AB62-3676F25FDE51}.Debug|x86.Build.0 = Debug|Any CPU + {E6D94C12-9AD7-46E6-AB62-3676F25FDE51}.Release|Any CPU.ActiveCfg = Release|Any CPU + {E6D94C12-9AD7-46E6-AB62-3676F25FDE51}.Release|Any CPU.Build.0 = Release|Any CPU + {E6D94C12-9AD7-46E6-AB62-3676F25FDE51}.Release|ARM.ActiveCfg = Release|Any CPU + {E6D94C12-9AD7-46E6-AB62-3676F25FDE51}.Release|ARM.Build.0 = Release|Any CPU + {E6D94C12-9AD7-46E6-AB62-3676F25FDE51}.Release|Mixed Platforms.ActiveCfg = Release|Any CPU + {E6D94C12-9AD7-46E6-AB62-3676F25FDE51}.Release|Mixed Platforms.Build.0 = Release|Any CPU + {E6D94C12-9AD7-46E6-AB62-3676F25FDE51}.Release|x64.ActiveCfg = Release|Any CPU + {E6D94C12-9AD7-46E6-AB62-3676F25FDE51}.Release|x64.Build.0 = Release|Any CPU + {E6D94C12-9AD7-46E6-AB62-3676F25FDE51}.Release|x86.ActiveCfg = Release|Any CPU + {E6D94C12-9AD7-46E6-AB62-3676F25FDE51}.Release|x86.Build.0 = Release|Any CPU + {4A35B1C5-520D-4267-BA70-2DCEAC0A5662}.Debug.Appveyor|Any CPU.ActiveCfg = Debug|Any CPU + {4A35B1C5-520D-4267-BA70-2DCEAC0A5662}.Debug.Appveyor|Any CPU.Build.0 = Debug|Any CPU + {4A35B1C5-520D-4267-BA70-2DCEAC0A5662}.Debug.Appveyor|ARM.ActiveCfg = Debug|Any CPU + {4A35B1C5-520D-4267-BA70-2DCEAC0A5662}.Debug.Appveyor|ARM.Build.0 = Debug|Any CPU + {4A35B1C5-520D-4267-BA70-2DCEAC0A5662}.Debug.Appveyor|Mixed Platforms.ActiveCfg = Debug|Any CPU + {4A35B1C5-520D-4267-BA70-2DCEAC0A5662}.Debug.Appveyor|Mixed Platforms.Build.0 = Debug|Any CPU + {4A35B1C5-520D-4267-BA70-2DCEAC0A5662}.Debug.Appveyor|x64.ActiveCfg = Debug|Any CPU + {4A35B1C5-520D-4267-BA70-2DCEAC0A5662}.Debug.Appveyor|x64.Build.0 = Debug|Any CPU + {4A35B1C5-520D-4267-BA70-2DCEAC0A5662}.Debug.Appveyor|x86.ActiveCfg = Debug|Any CPU + {4A35B1C5-520D-4267-BA70-2DCEAC0A5662}.Debug.Appveyor|x86.Build.0 = Debug|Any CPU + {4A35B1C5-520D-4267-BA70-2DCEAC0A5662}.Debug|Any CPU.ActiveCfg = Debug|Any CPU + {4A35B1C5-520D-4267-BA70-2DCEAC0A5662}.Debug|Any CPU.Build.0 = Debug|Any CPU + {4A35B1C5-520D-4267-BA70-2DCEAC0A5662}.Debug|ARM.ActiveCfg = Debug|Any CPU + {4A35B1C5-520D-4267-BA70-2DCEAC0A5662}.Debug|ARM.Build.0 = Debug|Any CPU + {4A35B1C5-520D-4267-BA70-2DCEAC0A5662}.Debug|Mixed Platforms.ActiveCfg = Debug|Any CPU + {4A35B1C5-520D-4267-BA70-2DCEAC0A5662}.Debug|Mixed Platforms.Build.0 = Debug|Any CPU + {4A35B1C5-520D-4267-BA70-2DCEAC0A5662}.Debug|x64.ActiveCfg = Debug|Any CPU + {4A35B1C5-520D-4267-BA70-2DCEAC0A5662}.Debug|x64.Build.0 = Debug|Any CPU + {4A35B1C5-520D-4267-BA70-2DCEAC0A5662}.Debug|x86.ActiveCfg = Debug|Any CPU + {4A35B1C5-520D-4267-BA70-2DCEAC0A5662}.Debug|x86.Build.0 = Debug|Any CPU + {4A35B1C5-520D-4267-BA70-2DCEAC0A5662}.Release|Any CPU.ActiveCfg = Release|Any CPU + {4A35B1C5-520D-4267-BA70-2DCEAC0A5662}.Release|Any CPU.Build.0 = Release|Any CPU + {4A35B1C5-520D-4267-BA70-2DCEAC0A5662}.Release|ARM.ActiveCfg = Release|Any CPU + {4A35B1C5-520D-4267-BA70-2DCEAC0A5662}.Release|ARM.Build.0 = Release|Any CPU + {4A35B1C5-520D-4267-BA70-2DCEAC0A5662}.Release|Mixed Platforms.ActiveCfg = Release|Any CPU + {4A35B1C5-520D-4267-BA70-2DCEAC0A5662}.Release|Mixed Platforms.Build.0 = Release|Any CPU + {4A35B1C5-520D-4267-BA70-2DCEAC0A5662}.Release|x64.ActiveCfg = Release|Any CPU + {4A35B1C5-520D-4267-BA70-2DCEAC0A5662}.Release|x64.Build.0 = Release|Any CPU + {4A35B1C5-520D-4267-BA70-2DCEAC0A5662}.Release|x86.ActiveCfg = Release|Any CPU + {4A35B1C5-520D-4267-BA70-2DCEAC0A5662}.Release|x86.Build.0 = Release|Any CPU + {2150E333-8FDC-42A3-9474-1A3956D46DE8}.Debug.Appveyor|Any CPU.ActiveCfg = Debug|Any CPU + {2150E333-8FDC-42A3-9474-1A3956D46DE8}.Debug.Appveyor|Any CPU.Build.0 = Debug|Any CPU + {2150E333-8FDC-42A3-9474-1A3956D46DE8}.Debug.Appveyor|ARM.ActiveCfg = Debug|Any CPU + {2150E333-8FDC-42A3-9474-1A3956D46DE8}.Debug.Appveyor|ARM.Build.0 = Debug|Any CPU + {2150E333-8FDC-42A3-9474-1A3956D46DE8}.Debug.Appveyor|Mixed Platforms.ActiveCfg = Debug|Any CPU + {2150E333-8FDC-42A3-9474-1A3956D46DE8}.Debug.Appveyor|Mixed Platforms.Build.0 = Debug|Any CPU + {2150E333-8FDC-42A3-9474-1A3956D46DE8}.Debug.Appveyor|x64.ActiveCfg = Debug|Any CPU + {2150E333-8FDC-42A3-9474-1A3956D46DE8}.Debug.Appveyor|x64.Build.0 = Debug|Any CPU + {2150E333-8FDC-42A3-9474-1A3956D46DE8}.Debug.Appveyor|x86.ActiveCfg = Debug|Any CPU + {2150E333-8FDC-42A3-9474-1A3956D46DE8}.Debug.Appveyor|x86.Build.0 = Debug|Any CPU + {2150E333-8FDC-42A3-9474-1A3956D46DE8}.Debug|Any CPU.ActiveCfg = Debug|Any CPU + {2150E333-8FDC-42A3-9474-1A3956D46DE8}.Debug|Any CPU.Build.0 = Debug|Any CPU + {2150E333-8FDC-42A3-9474-1A3956D46DE8}.Debug|ARM.ActiveCfg = Debug|Any CPU + {2150E333-8FDC-42A3-9474-1A3956D46DE8}.Debug|ARM.Build.0 = Debug|Any CPU + {2150E333-8FDC-42A3-9474-1A3956D46DE8}.Debug|Mixed Platforms.ActiveCfg = Debug|Any CPU + {2150E333-8FDC-42A3-9474-1A3956D46DE8}.Debug|Mixed Platforms.Build.0 = Debug|Any CPU + {2150E333-8FDC-42A3-9474-1A3956D46DE8}.Debug|x64.ActiveCfg = Debug|Any CPU + {2150E333-8FDC-42A3-9474-1A3956D46DE8}.Debug|x64.Build.0 = Debug|Any CPU + {2150E333-8FDC-42A3-9474-1A3956D46DE8}.Debug|x86.ActiveCfg = Debug|Any CPU + {2150E333-8FDC-42A3-9474-1A3956D46DE8}.Debug|x86.Build.0 = Debug|Any CPU + {2150E333-8FDC-42A3-9474-1A3956D46DE8}.Release|Any CPU.ActiveCfg = Release|Any CPU + {2150E333-8FDC-42A3-9474-1A3956D46DE8}.Release|Any CPU.Build.0 = Release|Any CPU + {2150E333-8FDC-42A3-9474-1A3956D46DE8}.Release|ARM.ActiveCfg = Release|Any CPU + {2150E333-8FDC-42A3-9474-1A3956D46DE8}.Release|ARM.Build.0 = Release|Any CPU + {2150E333-8FDC-42A3-9474-1A3956D46DE8}.Release|Mixed Platforms.ActiveCfg = Release|Any CPU + {2150E333-8FDC-42A3-9474-1A3956D46DE8}.Release|Mixed Platforms.Build.0 = Release|Any CPU + {2150E333-8FDC-42A3-9474-1A3956D46DE8}.Release|x64.ActiveCfg = Release|Any CPU + {2150E333-8FDC-42A3-9474-1A3956D46DE8}.Release|x64.Build.0 = Release|Any CPU + {2150E333-8FDC-42A3-9474-1A3956D46DE8}.Release|x86.ActiveCfg = Release|Any CPU + {2150E333-8FDC-42A3-9474-1A3956D46DE8}.Release|x86.Build.0 = Release|Any CPU + {E6D94FFD-7811-40BE-ABC4-6D6AB41F0060}.Debug.Appveyor|Any CPU.ActiveCfg = Debug|Any CPU + {E6D94FFD-7811-40BE-ABC4-6D6AB41F0060}.Debug.Appveyor|Any CPU.Build.0 = Debug|Any CPU + {E6D94FFD-7811-40BE-ABC4-6D6AB41F0060}.Debug.Appveyor|ARM.ActiveCfg = Debug|Any CPU + {E6D94FFD-7811-40BE-ABC4-6D6AB41F0060}.Debug.Appveyor|ARM.Build.0 = Debug|Any CPU + {E6D94FFD-7811-40BE-ABC4-6D6AB41F0060}.Debug.Appveyor|Mixed Platforms.ActiveCfg = Debug|Any CPU + {E6D94FFD-7811-40BE-ABC4-6D6AB41F0060}.Debug.Appveyor|Mixed Platforms.Build.0 = Debug|Any CPU + {E6D94FFD-7811-40BE-ABC4-6D6AB41F0060}.Debug.Appveyor|x64.ActiveCfg = Debug|Any CPU + {E6D94FFD-7811-40BE-ABC4-6D6AB41F0060}.Debug.Appveyor|x64.Build.0 = Debug|Any CPU + {E6D94FFD-7811-40BE-ABC4-6D6AB41F0060}.Debug.Appveyor|x86.ActiveCfg = Debug|Any CPU + {E6D94FFD-7811-40BE-ABC4-6D6AB41F0060}.Debug.Appveyor|x86.Build.0 = Debug|Any CPU + {E6D94FFD-7811-40BE-ABC4-6D6AB41F0060}.Debug|Any CPU.ActiveCfg = Debug|Any CPU + {E6D94FFD-7811-40BE-ABC4-6D6AB41F0060}.Debug|Any CPU.Build.0 = Debug|Any CPU + {E6D94FFD-7811-40BE-ABC4-6D6AB41F0060}.Debug|ARM.ActiveCfg = Debug|Any CPU + {E6D94FFD-7811-40BE-ABC4-6D6AB41F0060}.Debug|ARM.Build.0 = Debug|Any CPU + {E6D94FFD-7811-40BE-ABC4-6D6AB41F0060}.Debug|Mixed Platforms.ActiveCfg = Debug|Any CPU + {E6D94FFD-7811-40BE-ABC4-6D6AB41F0060}.Debug|Mixed Platforms.Build.0 = Debug|Any CPU + {E6D94FFD-7811-40BE-ABC4-6D6AB41F0060}.Debug|x64.ActiveCfg = Debug|Any CPU + {E6D94FFD-7811-40BE-ABC4-6D6AB41F0060}.Debug|x64.Build.0 = Debug|Any CPU + {E6D94FFD-7811-40BE-ABC4-6D6AB41F0060}.Debug|x86.ActiveCfg = Debug|Any CPU + {E6D94FFD-7811-40BE-ABC4-6D6AB41F0060}.Debug|x86.Build.0 = Debug|Any CPU + {E6D94FFD-7811-40BE-ABC4-6D6AB41F0060}.Release|Any CPU.ActiveCfg = Release|Any CPU + {E6D94FFD-7811-40BE-ABC4-6D6AB41F0060}.Release|Any CPU.Build.0 = Release|Any CPU + {E6D94FFD-7811-40BE-ABC4-6D6AB41F0060}.Release|ARM.ActiveCfg = Release|Any CPU + {E6D94FFD-7811-40BE-ABC4-6D6AB41F0060}.Release|ARM.Build.0 = Release|Any CPU + {E6D94FFD-7811-40BE-ABC4-6D6AB41F0060}.Release|Mixed Platforms.ActiveCfg = Release|Any CPU + {E6D94FFD-7811-40BE-ABC4-6D6AB41F0060}.Release|Mixed Platforms.Build.0 = Release|Any CPU + {E6D94FFD-7811-40BE-ABC4-6D6AB41F0060}.Release|x64.ActiveCfg = Release|Any CPU + {E6D94FFD-7811-40BE-ABC4-6D6AB41F0060}.Release|x64.Build.0 = Release|Any CPU + {E6D94FFD-7811-40BE-ABC4-6D6AB41F0060}.Release|x86.ActiveCfg = Release|Any CPU + {E6D94FFD-7811-40BE-ABC4-6D6AB41F0060}.Release|x86.Build.0 = Release|Any CPU + {FE778406-ADCF-45A1-B775-A054B55BFC50}.Debug.Appveyor|Any CPU.ActiveCfg = Debug|Any CPU + {FE778406-ADCF-45A1-B775-A054B55BFC50}.Debug.Appveyor|Any CPU.Build.0 = Debug|Any CPU + {FE778406-ADCF-45A1-B775-A054B55BFC50}.Debug.Appveyor|ARM.ActiveCfg = Debug|Any CPU + {FE778406-ADCF-45A1-B775-A054B55BFC50}.Debug.Appveyor|ARM.Build.0 = Debug|Any CPU + {FE778406-ADCF-45A1-B775-A054B55BFC50}.Debug.Appveyor|Mixed Platforms.ActiveCfg = Debug|Any CPU + {FE778406-ADCF-45A1-B775-A054B55BFC50}.Debug.Appveyor|Mixed Platforms.Build.0 = Debug|Any CPU + {FE778406-ADCF-45A1-B775-A054B55BFC50}.Debug.Appveyor|x64.ActiveCfg = Debug|Any CPU + {FE778406-ADCF-45A1-B775-A054B55BFC50}.Debug.Appveyor|x64.Build.0 = Debug|Any CPU + {FE778406-ADCF-45A1-B775-A054B55BFC50}.Debug.Appveyor|x86.ActiveCfg = Debug|Any CPU + {FE778406-ADCF-45A1-B775-A054B55BFC50}.Debug.Appveyor|x86.Build.0 = Debug|Any CPU + {FE778406-ADCF-45A1-B775-A054B55BFC50}.Debug|Any CPU.ActiveCfg = Debug|Any CPU + {FE778406-ADCF-45A1-B775-A054B55BFC50}.Debug|Any CPU.Build.0 = Debug|Any CPU + {FE778406-ADCF-45A1-B775-A054B55BFC50}.Debug|ARM.ActiveCfg = Debug|Any CPU + {FE778406-ADCF-45A1-B775-A054B55BFC50}.Debug|ARM.Build.0 = Debug|Any CPU + {FE778406-ADCF-45A1-B775-A054B55BFC50}.Debug|Mixed Platforms.ActiveCfg = Debug|Any CPU + {FE778406-ADCF-45A1-B775-A054B55BFC50}.Debug|Mixed Platforms.Build.0 = Debug|Any CPU + {FE778406-ADCF-45A1-B775-A054B55BFC50}.Debug|x64.ActiveCfg = Debug|Any CPU + {FE778406-ADCF-45A1-B775-A054B55BFC50}.Debug|x64.Build.0 = Debug|Any CPU + {FE778406-ADCF-45A1-B775-A054B55BFC50}.Debug|x86.ActiveCfg = Debug|Any CPU + {FE778406-ADCF-45A1-B775-A054B55BFC50}.Debug|x86.Build.0 = Debug|Any CPU + {FE778406-ADCF-45A1-B775-A054B55BFC50}.Release|Any CPU.ActiveCfg = Release|Any CPU + {FE778406-ADCF-45A1-B775-A054B55BFC50}.Release|Any CPU.Build.0 = Release|Any CPU + {FE778406-ADCF-45A1-B775-A054B55BFC50}.Release|ARM.ActiveCfg = Release|Any CPU + {FE778406-ADCF-45A1-B775-A054B55BFC50}.Release|ARM.Build.0 = Release|Any CPU + {FE778406-ADCF-45A1-B775-A054B55BFC50}.Release|Mixed Platforms.ActiveCfg = Release|Any CPU + {FE778406-ADCF-45A1-B775-A054B55BFC50}.Release|Mixed Platforms.Build.0 = Release|Any CPU + {FE778406-ADCF-45A1-B775-A054B55BFC50}.Release|x64.ActiveCfg = Release|Any CPU + {FE778406-ADCF-45A1-B775-A054B55BFC50}.Release|x64.Build.0 = Release|Any CPU + {FE778406-ADCF-45A1-B775-A054B55BFC50}.Release|x86.ActiveCfg = Release|Any CPU + {FE778406-ADCF-45A1-B775-A054B55BFC50}.Release|x86.Build.0 = Release|Any CPU + {92A6F3CA-100F-4D9D-9742-B62267D445B6}.Debug.Appveyor|Any CPU.ActiveCfg = Debug|Any CPU + {92A6F3CA-100F-4D9D-9742-B62267D445B6}.Debug.Appveyor|Any CPU.Build.0 = Debug|Any CPU + {92A6F3CA-100F-4D9D-9742-B62267D445B6}.Debug.Appveyor|ARM.ActiveCfg = Debug|Any CPU + {92A6F3CA-100F-4D9D-9742-B62267D445B6}.Debug.Appveyor|ARM.Build.0 = Debug|Any CPU + {92A6F3CA-100F-4D9D-9742-B62267D445B6}.Debug.Appveyor|Mixed Platforms.ActiveCfg = Debug|Any CPU + {92A6F3CA-100F-4D9D-9742-B62267D445B6}.Debug.Appveyor|Mixed Platforms.Build.0 = Debug|Any CPU + {92A6F3CA-100F-4D9D-9742-B62267D445B6}.Debug.Appveyor|x64.ActiveCfg = Debug|Any CPU + {92A6F3CA-100F-4D9D-9742-B62267D445B6}.Debug.Appveyor|x64.Build.0 = Debug|Any CPU + {92A6F3CA-100F-4D9D-9742-B62267D445B6}.Debug.Appveyor|x86.ActiveCfg = Debug|Any CPU + {92A6F3CA-100F-4D9D-9742-B62267D445B6}.Debug.Appveyor|x86.Build.0 = Debug|Any CPU + {92A6F3CA-100F-4D9D-9742-B62267D445B6}.Debug|Any CPU.ActiveCfg = Debug|Any CPU + {92A6F3CA-100F-4D9D-9742-B62267D445B6}.Debug|Any CPU.Build.0 = Debug|Any CPU + {92A6F3CA-100F-4D9D-9742-B62267D445B6}.Debug|ARM.ActiveCfg = Debug|Any CPU + {92A6F3CA-100F-4D9D-9742-B62267D445B6}.Debug|ARM.Build.0 = Debug|Any CPU + {92A6F3CA-100F-4D9D-9742-B62267D445B6}.Debug|Mixed Platforms.ActiveCfg = Debug|Any CPU + {92A6F3CA-100F-4D9D-9742-B62267D445B6}.Debug|Mixed Platforms.Build.0 = Debug|Any CPU + {92A6F3CA-100F-4D9D-9742-B62267D445B6}.Debug|x64.ActiveCfg = Debug|Any CPU + {92A6F3CA-100F-4D9D-9742-B62267D445B6}.Debug|x64.Build.0 = Debug|Any CPU + {92A6F3CA-100F-4D9D-9742-B62267D445B6}.Debug|x86.ActiveCfg = Debug|Any CPU + {92A6F3CA-100F-4D9D-9742-B62267D445B6}.Debug|x86.Build.0 = Debug|Any CPU + {92A6F3CA-100F-4D9D-9742-B62267D445B6}.Release|Any CPU.ActiveCfg = Release|Any CPU + {92A6F3CA-100F-4D9D-9742-B62267D445B6}.Release|Any CPU.Build.0 = Release|Any CPU + {92A6F3CA-100F-4D9D-9742-B62267D445B6}.Release|ARM.ActiveCfg = Release|Any CPU + {92A6F3CA-100F-4D9D-9742-B62267D445B6}.Release|ARM.Build.0 = Release|Any CPU + {92A6F3CA-100F-4D9D-9742-B62267D445B6}.Release|Mixed Platforms.ActiveCfg = Release|Any CPU + {92A6F3CA-100F-4D9D-9742-B62267D445B6}.Release|Mixed Platforms.Build.0 = Release|Any CPU + {92A6F3CA-100F-4D9D-9742-B62267D445B6}.Release|x64.ActiveCfg = Release|Any CPU + {92A6F3CA-100F-4D9D-9742-B62267D445B6}.Release|x64.Build.0 = Release|Any CPU + {92A6F3CA-100F-4D9D-9742-B62267D445B6}.Release|x86.ActiveCfg = Release|Any CPU + {92A6F3CA-100F-4D9D-9742-B62267D445B6}.Release|x86.Build.0 = Release|Any CPU + {602FF788-E926-4404-B3A2-D6B778A5FFB7}.Debug.Appveyor|Any CPU.ActiveCfg = Debug|Any CPU + {602FF788-E926-4404-B3A2-D6B778A5FFB7}.Debug.Appveyor|Any CPU.Build.0 = Debug|Any CPU + {602FF788-E926-4404-B3A2-D6B778A5FFB7}.Debug.Appveyor|ARM.ActiveCfg = Debug|Any CPU + {602FF788-E926-4404-B3A2-D6B778A5FFB7}.Debug.Appveyor|ARM.Build.0 = Debug|Any CPU + {602FF788-E926-4404-B3A2-D6B778A5FFB7}.Debug.Appveyor|Mixed Platforms.ActiveCfg = Debug|Any CPU + {602FF788-E926-4404-B3A2-D6B778A5FFB7}.Debug.Appveyor|Mixed Platforms.Build.0 = Debug|Any CPU + {602FF788-E926-4404-B3A2-D6B778A5FFB7}.Debug.Appveyor|x64.ActiveCfg = Debug|Any CPU + {602FF788-E926-4404-B3A2-D6B778A5FFB7}.Debug.Appveyor|x64.Build.0 = Debug|Any CPU + {602FF788-E926-4404-B3A2-D6B778A5FFB7}.Debug.Appveyor|x86.ActiveCfg = Debug|Any CPU + {602FF788-E926-4404-B3A2-D6B778A5FFB7}.Debug.Appveyor|x86.Build.0 = Debug|Any CPU + {602FF788-E926-4404-B3A2-D6B778A5FFB7}.Debug|Any CPU.ActiveCfg = Debug|Any CPU + {602FF788-E926-4404-B3A2-D6B778A5FFB7}.Debug|Any CPU.Build.0 = Debug|Any CPU + {602FF788-E926-4404-B3A2-D6B778A5FFB7}.Debug|ARM.ActiveCfg = Debug|Any CPU + {602FF788-E926-4404-B3A2-D6B778A5FFB7}.Debug|ARM.Build.0 = Debug|Any CPU + {602FF788-E926-4404-B3A2-D6B778A5FFB7}.Debug|Mixed Platforms.ActiveCfg = Debug|Any CPU + {602FF788-E926-4404-B3A2-D6B778A5FFB7}.Debug|Mixed Platforms.Build.0 = Debug|Any CPU + {602FF788-E926-4404-B3A2-D6B778A5FFB7}.Debug|x64.ActiveCfg = Debug|Any CPU + {602FF788-E926-4404-B3A2-D6B778A5FFB7}.Debug|x64.Build.0 = Debug|Any CPU + {602FF788-E926-4404-B3A2-D6B778A5FFB7}.Debug|x86.ActiveCfg = Debug|Any CPU + {602FF788-E926-4404-B3A2-D6B778A5FFB7}.Debug|x86.Build.0 = Debug|Any CPU + {602FF788-E926-4404-B3A2-D6B778A5FFB7}.Release|Any CPU.ActiveCfg = Release|Any CPU + {602FF788-E926-4404-B3A2-D6B778A5FFB7}.Release|Any CPU.Build.0 = Release|Any CPU + {602FF788-E926-4404-B3A2-D6B778A5FFB7}.Release|ARM.ActiveCfg = Release|Any CPU + {602FF788-E926-4404-B3A2-D6B778A5FFB7}.Release|ARM.Build.0 = Release|Any CPU + {602FF788-E926-4404-B3A2-D6B778A5FFB7}.Release|Mixed Platforms.ActiveCfg = Release|Any CPU + {602FF788-E926-4404-B3A2-D6B778A5FFB7}.Release|Mixed Platforms.Build.0 = Release|Any CPU + {602FF788-E926-4404-B3A2-D6B778A5FFB7}.Release|x64.ActiveCfg = Release|Any CPU + {602FF788-E926-4404-B3A2-D6B778A5FFB7}.Release|x64.Build.0 = Release|Any CPU + {602FF788-E926-4404-B3A2-D6B778A5FFB7}.Release|x86.ActiveCfg = Release|Any CPU + {602FF788-E926-4404-B3A2-D6B778A5FFB7}.Release|x86.Build.0 = Release|Any CPU EndGlobalSection GlobalSection(SolutionProperties) = preSolution HideSolutionNode = FALSE EndGlobalSection + GlobalSection(NestedProjects) = preSolution + {B1C55C9B-3287-4EB2-8ADD-795DBC77013D} = {9051DDA0-E563-45D5-9504-085EBAACF469} + {AC3B3DDC-F011-4E19-8C9B-F748B19ED3C0} = {9051DDA0-E563-45D5-9504-085EBAACF469} + {4205A187-9732-4DA8-B0BE-77A2C6B8C6A1} = {8C7B43EB-2F93-483C-B433-E28F9386AD67} + {73896669-F05C-41AC-9F6F-A11F549EDEDC} = {9051DDA0-E563-45D5-9504-085EBAACF469} + {8BF81225-2F85-4412-AD18-6579CBA1879B} = {9051DDA0-E563-45D5-9504-085EBAACF469} + {997AEFE5-D7D4-4033-A31A-07F476D6FE5D} = {1C42C435-8826-4044-8775-A1DA40EF4866} + {6D7D1D60-4473-4C52-800C-9B892C6640A5} = {9051DDA0-E563-45D5-9504-085EBAACF469} + {E6D94C12-9AD7-46E6-AB62-3676F25FDE51} = {9051DDA0-E563-45D5-9504-085EBAACF469} + {4A35B1C5-520D-4267-BA70-2DCEAC0A5662} = {8C7B43EB-2F93-483C-B433-E28F9386AD67} + {2150E333-8FDC-42A3-9474-1A3956D46DE8} = {8C7B43EB-2F93-483C-B433-E28F9386AD67} + {E6D94FFD-7811-40BE-ABC4-6D6AB41F0060} = {9051DDA0-E563-45D5-9504-085EBAACF469} + {FE778406-ADCF-45A1-B775-A054B55BFC50} = {55B8F371-B2BA-4DEE-AB98-5BAB8A21B1C2} + {602FF788-E926-4404-B3A2-D6B778A5FFB7} = {9051DDA0-E563-45D5-9504-085EBAACF469} + EndGlobalSection GlobalSection(ExtensibilityGlobals) = postSolution SolutionGuid = {77FF357B-03FA-4FA5-A68F-BFBE5800FEBA} EndGlobalSection diff --git a/RestSharp.sln.DotSettings b/RestSharp.sln.DotSettings new file mode 100644 index 000000000..d0bb9d525 --- /dev/null +++ b/RestSharp.sln.DotSettings @@ -0,0 +1,113 @@ + + False + SUGGESTION + SUGGESTION + SUGGESTION + <?xml version="1.0" encoding="utf-16"?><Profile name="Apptrium Code Format"><JsReformatCode>True</JsReformatCode><CSCodeStyleAttributes ArrangeTypeAccessModifier="True" ArrangeTypeMemberAccessModifier="True" SortModifiers="True" RemoveRedundantParentheses="True" AddMissingParentheses="True" ArrangeBraces="True" ArrangeAttributes="True" ArrangeArgumentsStyle="True" ArrangeCodeBodyStyle="True" ArrangeVarStyle="True" /><CSOptimizeUsings><OptimizeUsings>True</OptimizeUsings><EmbraceInRegion>False</EmbraceInRegion><RegionName></RegionName></CSOptimizeUsings><CSReformatCode>True</CSReformatCode><XAMLCollapseEmptyTags>False</XAMLCollapseEmptyTags><CSReorderTypeMembers>True</CSReorderTypeMembers><CSArrangeQualifiers>True</CSArrangeQualifiers><CSShortenReferences>True</CSShortenReferences><IDEA_SETTINGS>&lt;profile version="1.0"&gt; + &lt;option name="myName" value="Apptrium Code Format" /&gt; + &lt;inspection_tool class="AccessStaticViaInstance" enabled="false" level="WARNING" enabled_by_default="false" /&gt; + &lt;inspection_tool class="CharsetObjectCanBeUsed" enabled="false" level="WARNING" enabled_by_default="false" /&gt; + &lt;inspection_tool class="DuplicateThrows" enabled="false" level="WARNING" enabled_by_default="false" /&gt; + &lt;inspection_tool class="ES6ShorthandObjectProperty" enabled="false" level="INFORMATION" enabled_by_default="false" /&gt; + &lt;inspection_tool class="JSArrowFunctionBracesCanBeRemoved" enabled="false" level="INFORMATION" enabled_by_default="false" /&gt; + &lt;inspection_tool class="JSPrimitiveTypeWrapperUsage" enabled="false" level="WARNING" enabled_by_default="false" /&gt; + &lt;inspection_tool class="JSRemoveUnnecessaryParentheses" enabled="false" level="INFORMATION" enabled_by_default="false" /&gt; + &lt;inspection_tool class="JSUnnecessarySemicolon" enabled="false" level="WARNING" enabled_by_default="false" /&gt; + &lt;inspection_tool class="RedundantArrayCreation" enabled="false" level="WARNING" enabled_by_default="false" /&gt; + &lt;inspection_tool class="RedundantCast" enabled="false" level="WARNING" enabled_by_default="false" /&gt; + &lt;inspection_tool class="RedundantTypeArguments" enabled="false" level="WARNING" enabled_by_default="false" /&gt; + &lt;inspection_tool class="TypescriptExplicitMemberType" enabled="false" level="INFORMATION" enabled_by_default="false" /&gt; + &lt;inspection_tool class="UnnecessaryContinueJS" enabled="false" level="WARNING" enabled_by_default="false" /&gt; + &lt;inspection_tool class="UnnecessaryLabelJS" enabled="false" level="WARNING" enabled_by_default="false" /&gt; + &lt;inspection_tool class="UnnecessaryLabelOnBreakStatementJS" enabled="false" level="WARNING" enabled_by_default="false" /&gt; + &lt;inspection_tool class="UnnecessaryLabelOnContinueStatementJS" enabled="false" level="WARNING" enabled_by_default="false" /&gt; + &lt;inspection_tool class="UnnecessaryReturnJS" enabled="false" level="WARNING" enabled_by_default="false" /&gt; + &lt;inspection_tool class="UnterminatedStatementJS" enabled="false" level="WARNING" enabled_by_default="false" /&gt; +&lt;/profile&gt;</IDEA_SETTINGS><CSMakeAutoPropertyGetOnly>True</CSMakeAutoPropertyGetOnly><CSMakeFieldReadonly>True</CSMakeFieldReadonly><CSUseAutoProperty>True</CSUseAutoProperty><RemoveCodeRedundancies>True</RemoveCodeRedundancies><VBReformatCode>True</VBReformatCode><CssReformatCode>True</CssReformatCode><HtmlReformatCode>True</HtmlReformatCode></Profile> + RequiredForMultiline + RequiredForMultiline + RequiredForMultiline + ExpressionBody + Join + ExpressionBody + ExpressionBody + False + 1 + 0 + 0 + 1 + 0 + 1 + TOGETHER_SAME_LINE + True + True + False + True + 1 + 1 + False + 6 + NEVER + ALWAYS + IF_OWNER_IS_SINGLE_LINE + ALWAYS + IF_OWNER_IS_SINGLE_LINE + True + True + True + True + True + True + True + CHOP_IF_LONG + WRAP_IF_LONG + 150 + CHOP_ALWAYS + CHOP_IF_LONG + False + FDIC + <Policy Inspect="True" Prefix="" Suffix="" Style="AaBb_AaBb" /> + <Policy><Descriptor Staticness="Instance" AccessRightKinds="Protected, ProtectedInternal, Internal, Public, PrivateProtected" Description="Instance fields (not private)"><ElementKinds><Kind Name="FIELD" /><Kind Name="READONLY_FIELD" /></ElementKinds></Descriptor><Policy Inspect="True" Prefix="" Suffix="" Style="AaBb_AaBb" /></Policy> + <Policy><Descriptor Staticness="Static" AccessRightKinds="Protected, ProtectedInternal, Internal, Public, PrivateProtected" Description="Static fields (not private)"><ElementKinds><Kind Name="FIELD" /></ElementKinds></Descriptor><Policy Inspect="True" Prefix="" Suffix="" Style="AaBb_AaBb" /></Policy> + True + True + True + True + True + True + True + True + True + True + True + True + True + True + True + True + True + True + True + True + True + True + True + True + True + Copyright (c) .NET Foundation and Contributors + +Licensed under the Apache License, Version 2.0 (the "License"); +you may not use this file except in compliance with the License. +You may obtain a copy of the License at + +http://www.apache.org/licenses/LICENSE-2.0 + +Unless required by applicable law or agreed to in writing, software +distributed under the License is distributed on an "AS IS" BASIS, +WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +See the License for the specific language governing permissions and +limitations under the License. + + True + True + \ No newline at end of file diff --git a/RestSharp.slnx b/RestSharp.slnx new file mode 100644 index 000000000..d06f32574 --- /dev/null +++ b/RestSharp.slnx @@ -0,0 +1,65 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/RestSharp/AssemblyInfo.cs b/RestSharp/AssemblyInfo.cs deleted file mode 100644 index 7c83de8c0..000000000 --- a/RestSharp/AssemblyInfo.cs +++ /dev/null @@ -1,4 +0,0 @@ -using System.Runtime.CompilerServices; - -[assembly: InternalsVisibleTo("RestSharp.IntegrationTests, PublicKey=0024000004800000940000000602000000240000525341310004000001000100fda57af14a288d46e3efea89617037585c4de57159cd536ca6dff792ea1d6addc665f2fccb4285413d9d44db5a1be87cb82686db200d16325ed9c42c89cd4824d8cc447f7cee2ac000924c3bceeb1b7fcb5cc1a3901785964d48ce14172001084134f4dcd9973c3776713b595443b1064bb53e2eeb924969244d354e46495e9d"), - InternalsVisibleTo("RestSharp.Tests, PublicKey=0024000004800000940000000602000000240000525341310004000001000100fda57af14a288d46e3efea89617037585c4de57159cd536ca6dff792ea1d6addc665f2fccb4285413d9d44db5a1be87cb82686db200d16325ed9c42c89cd4824d8cc447f7cee2ac000924c3bceeb1b7fcb5cc1a3901785964d48ce14172001084134f4dcd9973c3776713b595443b1064bb53e2eeb924969244d354e46495e9d")] diff --git a/RestSharp/Authenticators/HttpBasicAuthenticator.cs b/RestSharp/Authenticators/HttpBasicAuthenticator.cs deleted file mode 100644 index 3ab22462e..000000000 --- a/RestSharp/Authenticators/HttpBasicAuthenticator.cs +++ /dev/null @@ -1,50 +0,0 @@ -#region License - -// Copyright 2010 John Sheehan -// -// Licensed under the Apache License, Version 2.0 (the "License"); -// you may not use this file except in compliance with the License. -// You may obtain a copy of the License at -// -// http://www.apache.org/licenses/LICENSE-2.0 -// -// Unless required by applicable law or agreed to in writing, software -// distributed under the License is distributed on an "AS IS" BASIS, -// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -// See the License for the specific language governing permissions and -// limitations under the License. - -#endregion - -using System; -using System.Linq; -using System.Text; - -namespace RestSharp.Authenticators -{ - public class HttpBasicAuthenticator : IAuthenticator - { - private readonly string authHeader; - - public HttpBasicAuthenticator(string username, string password) - { - var token = Convert.ToBase64String(Encoding.UTF8.GetBytes(string.Format("{0}:{1}", username, password))); - - authHeader = string.Format("Basic {0}", token); - } - - public void Authenticate(IRestClient client, IRestRequest request) - { - // NetworkCredentials always makes two trips, even if with PreAuthenticate, - // it is also unsafe for many partial trust scenarios - // request.Credentials = Credentials; - // thanks TweetSharp! - - // request.Credentials = new NetworkCredential(_username, _password); - - // only add the Authorization parameter if it hasn't been added by a previous Execute - if (!request.Parameters.Any(p => p.Name.Equals("Authorization", StringComparison.OrdinalIgnoreCase))) - request.AddParameter("Authorization", authHeader, ParameterType.HttpHeader); - } - } -} \ No newline at end of file diff --git a/RestSharp/Authenticators/JwtAuthenticator.cs b/RestSharp/Authenticators/JwtAuthenticator.cs deleted file mode 100644 index d8eaec5a6..000000000 --- a/RestSharp/Authenticators/JwtAuthenticator.cs +++ /dev/null @@ -1,49 +0,0 @@ -#region License - -// Author: Roman Kravchik -// Based on HttpBasicAuthenticator class by John Sheehan -// -// Licensed under the Apache License, Version 2.0 (the "License"); -// you may not use this file except in compliance with the License. -// You may obtain a copy of the License at -// -// http://www.apache.org/licenses/LICENSE-2.0 -// -// Unless required by applicable law or agreed to in writing, software -// distributed under the License is distributed on an "AS IS" BASIS, -// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -// See the License for the specific language governing permissions and -// limitations under the License. - -#endregion - -using System; -using System.Linq; - -namespace RestSharp.Authenticators -{ - /// - /// JSON WEB TOKEN (JWT) Authenticator class. - /// https://tools.ietf.org/html/draft-ietf-oauth-json-web-token - /// - public class JwtAuthenticator : IAuthenticator - { - private readonly string authHeader; - - public JwtAuthenticator(string accessToken) - { - if (accessToken == null) - throw new ArgumentNullException("accessToken"); - - authHeader = string.Format("Bearer {0}", accessToken); - } - - public void Authenticate(IRestClient client, IRestRequest request) - { - // only add the Authorization parameter if it hasn't been added by a previous Execute - if (!request.Parameters.Any(p => p.Type.Equals(ParameterType.HttpHeader) && - p.Name.Equals("Authorization", StringComparison.OrdinalIgnoreCase))) - request.AddParameter("Authorization", authHeader, ParameterType.HttpHeader); - } - } -} \ No newline at end of file diff --git a/RestSharp/Authenticators/NtlmAuthenticator.cs b/RestSharp/Authenticators/NtlmAuthenticator.cs deleted file mode 100644 index 8fb673165..000000000 --- a/RestSharp/Authenticators/NtlmAuthenticator.cs +++ /dev/null @@ -1,63 +0,0 @@ -#region License - -// Copyright 2010 John Sheehan -// -// Licensed under the Apache License, Version 2.0 (the "License"); -// you may not use this file except in compliance with the License. -// You may obtain a copy of the License at -// -// http://www.apache.org/licenses/LICENSE-2.0 -// -// Unless required by applicable law or agreed to in writing, software -// distributed under the License is distributed on an "AS IS" BASIS, -// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -// See the License for the specific language governing permissions and -// limitations under the License. - -#endregion - -using System; -using System.Net; - -namespace RestSharp.Authenticators -{ - /// - /// Tries to Authenticate with the credentials of the currently logged in user, or impersonate a user - /// - public class NtlmAuthenticator : IAuthenticator - { - private readonly ICredentials credentials; - - /// - /// Authenticate with the credentials of the currently logged in user - /// - public NtlmAuthenticator() - : this(CredentialCache.DefaultCredentials) - { - } - - /// - /// Authenticate by impersonation - /// - /// - /// - public NtlmAuthenticator(string username, string password) - : this(new NetworkCredential(username, password)) - { - } - - /// - /// Authenticate by impersonation, using an existing ICredentials instance - /// - /// - public NtlmAuthenticator(ICredentials credentials) - { - this.credentials = credentials ?? throw new ArgumentNullException("credentials"); - } - - public void Authenticate(IRestClient client, IRestRequest request) - { - request.Credentials = credentials; - } - } -} \ No newline at end of file diff --git a/RestSharp/Authenticators/OAuth/Extensions/CollectionExtensions.cs b/RestSharp/Authenticators/OAuth/Extensions/CollectionExtensions.cs deleted file mode 100644 index 5d82845df..000000000 --- a/RestSharp/Authenticators/OAuth/Extensions/CollectionExtensions.cs +++ /dev/null @@ -1,109 +0,0 @@ -using System; -using System.Collections.Generic; -using System.Collections.Specialized; -using System.Linq; -using System.Text; - -namespace RestSharp.Authenticators.OAuth.Extensions -{ - internal static class CollectionExtensions - { - public static IEnumerable AsEnumerable(this T item) - { - return new[] { item }; - } - - public static IEnumerable And(this T item, T other) - { - return new[] { item, other }; - } - - public static IEnumerable And(this IEnumerable items, T item) - { - foreach (T i in items) - { - yield return i; - } - - yield return item; - } - - public static TK TryWithKey(this IDictionary dictionary, T key) - { - return dictionary.ContainsKey(key) - ? dictionary[key] - : default(TK); - } - - public static IEnumerable ToEnumerable(this object[] items) where T : class - { - return items.Select(item => item as T); - } - - public static void ForEach(this IEnumerable items, Action action) - { - foreach (T item in items) - { - action(item); - } - } - - public static void AddRange(this IDictionary collection, NameValueCollection range) - { - foreach (string key in range.AllKeys) - { - collection.Add(key, range[key]); - } - } - - public static string ToQueryString(this NameValueCollection collection) - { - StringBuilder sb = new StringBuilder(); - - if (collection.Count > 0) - { - sb.Append("?"); - } - - int count = 0; - - foreach (string key in collection.AllKeys) - { - sb.AppendFormat("{0}={1}", key, collection[key].UrlEncode()); - count++; - - if (count >= collection.Count) - { - continue; - } - - sb.Append("&"); - } - - return sb.ToString(); - } - - public static string Concatenate(this WebParameterCollection collection, string separator, string spacer) - { - StringBuilder sb = new StringBuilder(); - int total = collection.Count; - int count = 0; - - foreach (WebPair item in collection) - { - sb.Append(item.Name); - sb.Append(separator); - sb.Append(item.Value); - - count++; - - if (count < total) - { - sb.Append(spacer); - } - } - - return sb.ToString(); - } - } -} diff --git a/RestSharp/Authenticators/OAuth/Extensions/OAuthExtensions.cs b/RestSharp/Authenticators/OAuth/Extensions/OAuthExtensions.cs deleted file mode 100644 index 0cebc5a0c..000000000 --- a/RestSharp/Authenticators/OAuth/Extensions/OAuthExtensions.cs +++ /dev/null @@ -1,46 +0,0 @@ -using System; -using System.Security.Cryptography; -using System.Text; - -namespace RestSharp.Authenticators.OAuth.Extensions -{ - internal static class OAuthExtensions - { - public static string ToRequestValue(this OAuthSignatureMethod signatureMethod) - { - string value = signatureMethod.ToString() - .ToUpper(); - int shaIndex = value.IndexOf("SHA"); - - return shaIndex > -1 - ? value.Insert(shaIndex, "-") - : value; - } - - public static OAuthSignatureMethod FromRequestValue(this string signatureMethod) - { - switch (signatureMethod) - { - case "HMAC-SHA1": - return OAuthSignatureMethod.HmacSha1; - - case "HMAC-SHA256": - return OAuthSignatureMethod.HmacSha256; - - case "RSA-SHA1": - return OAuthSignatureMethod.RsaSha1; - - default: - return OAuthSignatureMethod.PlainText; - } - } - - public static string HashWith(this string input, HashAlgorithm algorithm) - { - byte[] data = Encoding.UTF8.GetBytes(input); - byte[] hash = algorithm.ComputeHash(data); - - return Convert.ToBase64String(hash); - } - } -} diff --git a/RestSharp/Authenticators/OAuth/Extensions/StringExtensions.cs b/RestSharp/Authenticators/OAuth/Extensions/StringExtensions.cs deleted file mode 100644 index ba367a77e..000000000 --- a/RestSharp/Authenticators/OAuth/Extensions/StringExtensions.cs +++ /dev/null @@ -1,94 +0,0 @@ -using System; -using System.Collections.Generic; -using System.Globalization; -using System.Linq; -using System.Text; - -namespace RestSharp.Authenticators.OAuth.Extensions -{ - internal static class StringExtensions - { - public static bool IsNullOrBlank(this string value) - { - return string.IsNullOrEmpty(value) || - !string.IsNullOrEmpty(value) && value.Trim() == string.Empty; - } - - public static bool EqualsIgnoreCase(this string left, string right) - { - return string.Compare(left, right, StringComparison.OrdinalIgnoreCase) == 0; - } - - public static bool EqualsAny(this string input, params string[] args) - { - return args.Aggregate(false, (current, arg) => current | input.Equals(arg)); - } - - public static string FormatWith(this string format, params object[] args) - { - return string.Format(format, args); - } - - public static string FormatWithInvariantCulture(this string format, params object[] args) - { - return string.Format(CultureInfo.InvariantCulture, format, args); - } - - public static string Then(this string input, string value) - { - return string.Concat(input, value); - } - - public static string UrlEncode(this string value) - { - // [DC] This is more correct than HttpUtility; it escapes spaces as %20, not + - return Uri.EscapeDataString(value); - } - - public static string UrlDecode(this string value) - { - return Uri.UnescapeDataString(value); - } - - public static Uri AsUri(this string value) - { - return new Uri(value); - } - - public static string ToBase64String(this byte[] input) - { - return Convert.ToBase64String(input); - } - - public static byte[] GetBytes(this string input) - { - return Encoding.UTF8.GetBytes(input); - } - - public static string PercentEncode(this string s) - { - var bytes = s.GetBytes(); - var sb = new StringBuilder(); - - foreach (var b in bytes) - sb.Append(string.Format("%{0:X2}", b)); - - return sb.ToString(); - } - - public static IDictionary ParseQueryString(this string query) - { - // [DC]: This method does not URL decode, and cannot handle decoded input - if (query.StartsWith("?")) - query = query.Substring(1); - - if (query.Equals(string.Empty)) - return new Dictionary(); - - var parts = query.Split('&'); - - return parts.Select(part => part.Split('=')) - .ToDictionary(pair => pair[0], pair => pair[1]); - } - } -} \ No newline at end of file diff --git a/RestSharp/Authenticators/OAuth/Extensions/TimeExtensions.cs b/RestSharp/Authenticators/OAuth/Extensions/TimeExtensions.cs deleted file mode 100644 index 3adff676d..000000000 --- a/RestSharp/Authenticators/OAuth/Extensions/TimeExtensions.cs +++ /dev/null @@ -1,29 +0,0 @@ -using System; - -namespace RestSharp.Authenticators.OAuth.Extensions -{ - internal static class TimeExtensions - { - public static DateTime FromNow(this TimeSpan value) - { - return new DateTime((DateTime.Now + value).Ticks); - } - - public static DateTime FromUnixTime(this long seconds) - { - DateTime time = new DateTime(1970, 1, 1); - - time = time.AddSeconds(seconds); - - return time.ToLocalTime(); - } - - public static long ToUnixTime(this DateTime dateTime) - { - TimeSpan timeSpan = (dateTime - new DateTime(1970, 1, 1)); - long timestamp = (long) timeSpan.TotalSeconds; - - return timestamp; - } - } -} diff --git a/RestSharp/Authenticators/OAuth/HttpPostParameter.cs b/RestSharp/Authenticators/OAuth/HttpPostParameter.cs deleted file mode 100644 index d44f51f94..000000000 --- a/RestSharp/Authenticators/OAuth/HttpPostParameter.cs +++ /dev/null @@ -1,46 +0,0 @@ -using System.IO; - -namespace RestSharp.Authenticators.OAuth -{ - internal class HttpPostParameter : WebParameter - { - public HttpPostParameter(string name, string value) - : base(name, value) { } - - public virtual HttpPostParameterType Type { get; private set; } - - public virtual string FileName { get; private set; } - - public virtual string FilePath { get; private set; } - - public virtual Stream FileStream { get; set; } - - public virtual string ContentType { get; private set; } - - public static HttpPostParameter CreateFile(string name, string fileName, string filePath, string contentType) - { - HttpPostParameter parameter = new HttpPostParameter(name, string.Empty) - { - Type = HttpPostParameterType.File, - FileName = fileName, - FilePath = filePath, - ContentType = contentType, - }; - - return parameter; - } - - public static HttpPostParameter CreateFile(string name, string fileName, Stream fileStream, string contentType) - { - HttpPostParameter parameter = new HttpPostParameter(name, string.Empty) - { - Type = HttpPostParameterType.File, - FileName = fileName, - FileStream = fileStream, - ContentType = contentType, - }; - - return parameter; - } - } -} diff --git a/RestSharp/Authenticators/OAuth/HttpPostParameterType.cs b/RestSharp/Authenticators/OAuth/HttpPostParameterType.cs deleted file mode 100644 index d57afb87c..000000000 --- a/RestSharp/Authenticators/OAuth/HttpPostParameterType.cs +++ /dev/null @@ -1,11 +0,0 @@ -using System.Runtime.Serialization; - -namespace RestSharp.Authenticators.OAuth -{ - [DataContract] - internal enum HttpPostParameterType - { - Field, - File - } -} diff --git a/RestSharp/Authenticators/OAuth/OAuthParameterHandling.cs b/RestSharp/Authenticators/OAuth/OAuthParameterHandling.cs deleted file mode 100644 index 1b65699ae..000000000 --- a/RestSharp/Authenticators/OAuth/OAuthParameterHandling.cs +++ /dev/null @@ -1,11 +0,0 @@ -using System.Runtime.Serialization; - -namespace RestSharp.Authenticators.OAuth -{ - [DataContract] - public enum OAuthParameterHandling - { - HttpAuthorizationHeader, - UrlOrPostParameters - } -} diff --git a/RestSharp/Authenticators/OAuth/OAuthSignatureMethod.cs b/RestSharp/Authenticators/OAuth/OAuthSignatureMethod.cs deleted file mode 100644 index 325ec3272..000000000 --- a/RestSharp/Authenticators/OAuth/OAuthSignatureMethod.cs +++ /dev/null @@ -1,13 +0,0 @@ -using System.Runtime.Serialization; - -namespace RestSharp.Authenticators.OAuth -{ - [DataContract] - public enum OAuthSignatureMethod - { - HmacSha1, - HmacSha256, - PlainText, - RsaSha1 - } -} diff --git a/RestSharp/Authenticators/OAuth/OAuthSignatureTreatment.cs b/RestSharp/Authenticators/OAuth/OAuthSignatureTreatment.cs deleted file mode 100644 index 185e7a714..000000000 --- a/RestSharp/Authenticators/OAuth/OAuthSignatureTreatment.cs +++ /dev/null @@ -1,11 +0,0 @@ -using System.Runtime.Serialization; - -namespace RestSharp.Authenticators.OAuth -{ - [DataContract] - public enum OAuthSignatureTreatment - { - Escaped, - Unescaped - } -} diff --git a/RestSharp/Authenticators/OAuth/OAuthTools.cs b/RestSharp/Authenticators/OAuth/OAuthTools.cs deleted file mode 100644 index 1d09fa9d7..000000000 --- a/RestSharp/Authenticators/OAuth/OAuthTools.cs +++ /dev/null @@ -1,360 +0,0 @@ -using System; -using System.Linq; -using System.Runtime.Serialization; -using System.Security.Cryptography; -using System.Text; -using RestSharp.Authenticators.OAuth.Extensions; - -namespace RestSharp.Authenticators.OAuth -{ - [DataContract] - internal static class OAuthTools - { - private const string ALPHA_NUMERIC = UPPER + LOWER + DIGIT; - - private const string DIGIT = "1234567890"; - - private const string LOWER = "abcdefghijklmnopqrstuvwxyz"; - - private const string UNRESERVED = ALPHA_NUMERIC + "-._~"; - - private const string UPPER = "ABCDEFGHIJKLMNOPQRSTUVWXYZ"; - - private static readonly Random random; - - private static readonly object randomLock = new object(); - - private static readonly RandomNumberGenerator rng = RandomNumberGenerator.Create(); - - /// - /// All text parameters are UTF-8 encoded (per section 5.1). - /// - /// - private static readonly Encoding encoding = Encoding.UTF8; - - /// - /// The set of characters that are unreserved in RFC 2396 but are NOT unreserved in RFC 3986. - /// - /// - private static readonly string[] uriRfc3986CharsToEscape = {"!", "*", "'", "(", ")"}; - - private static readonly string[] uriRfc3968EscapedHex = {"%21", "%2A", "%27", "%28", "%29"}; - - static OAuthTools() - { - var bytes = new byte[4]; - - rng.GetBytes(bytes); - random = new Random(BitConverter.ToInt32(bytes, 0)); - } - - /// - /// Generates a random 16-byte lowercase alphanumeric string. - /// - /// - /// - public static string GetNonce() - { - const string chars = LOWER + DIGIT; - - var nonce = new char[16]; - - lock (randomLock) - { - for (var i = 0; i < nonce.Length; i++) - nonce[i] = chars[random.Next(0, chars.Length)]; - } - - return new string(nonce); - } - - /// - /// Generates a timestamp based on the current elapsed seconds since '01/01/1970 0000 GMT" - /// - /// - /// - public static string GetTimestamp() - { - return GetTimestamp(DateTime.UtcNow); - } - - /// - /// Generates a timestamp based on the elapsed seconds of a given time since '01/01/1970 0000 GMT" - /// - /// - /// A specified point in time. - /// - public static string GetTimestamp(DateTime dateTime) - { - var timestamp = dateTime.ToUnixTime(); - - return timestamp.ToString(); - } - - /// - /// URL encodes a string based on section 5.1 of the OAuth spec. - /// Namely, percent encoding with [RFC3986], avoiding unreserved characters, - /// upper-casing hexadecimal characters, and UTF-8 encoding for text value pairs. - /// - /// The value to escape. - /// The escaped value. - /// - /// The method is supposed to take on - /// RFC 3986 behavior if certain elements are present in a .config file. Even if this - /// actually worked (which in my experiments it doesn't), we can't rely on every - /// host actually having this configuration element present. - /// - /// - /// - public static string UrlEncodeRelaxed(string value) - { - // Start with RFC 2396 escaping by calling the .NET method to do the work. - // This MAY sometimes exhibit RFC 3986 behavior (according to the documentation). - // If it does, the escaping we do that follows it will be a no-op since the - // characters we search for to replace can't possibly exist in the string. - var escaped = new StringBuilder(Uri.EscapeDataString(value)); - - // Upgrade the escaping to RFC 3986, if necessary. - for (var i = 0; i < uriRfc3986CharsToEscape.Length; i++) - { - var t = uriRfc3986CharsToEscape[i]; - - escaped.Replace(t, uriRfc3968EscapedHex[i]); - } - - // Return the fully-RFC3986-escaped string. - return escaped.ToString(); - } - - /// - /// URL encodes a string based on section 5.1 of the OAuth spec. - /// Namely, percent encoding with [RFC3986], avoiding unreserved characters, - /// upper-casing hexadecimal characters, and UTF-8 encoding for text value pairs. - /// - /// - /// - public static string UrlEncodeStrict(string value) - { - // From oauth spec above: - - // Characters not in the unreserved character set ([RFC3986] - // (Berners-Lee, T., "Uniform Resource Identifiers (URI): - // Generic Syntax," .) section 2.3) MUST be encoded. - // ... - // unreserved = ALPHA, DIGIT, '-', '.', '_', '~' - var result = ""; - - value.ForEach(c => - { - result += UNRESERVED.Contains(c) - ? c.ToString() - : c.ToString() - .PercentEncode(); - }); - - return result; - } - - /// - /// Sorts a collection of key-value pairs by name, and then value if equal, - /// concatenating them into a single string. This string should be encoded - /// prior to, or after normalization is run. - /// - /// - /// - /// - public static string NormalizeRequestParameters(WebParameterCollection parameters) - { - var copy = SortParametersExcludingSignature(parameters); - var concatenated = copy.Concatenate("=", "&"); - - return concatenated; - } - - /// - /// Sorts a by name, and then value if equal. - /// - /// A collection of parameters to sort - /// A sorted parameter collection - public static WebParameterCollection SortParametersExcludingSignature(WebParameterCollection parameters) - { - var copy = new WebParameterCollection(parameters); - var exclusions = copy.Where(n => n.Name.EqualsIgnoreCase("oauth_signature")); - - copy.RemoveAll(exclusions); - copy.ForEach(p => - { - p.Name = UrlEncodeStrict(p.Name); - p.Value = UrlEncodeStrict(p.Value); - }); - copy.Sort((x, y) => string.CompareOrdinal(x.Name, y.Name) != 0 - ? string.CompareOrdinal(x.Name, y.Name) - : string.CompareOrdinal(x.Value, y.Value)); - - return copy; - } - - /// - /// Creates a request URL suitable for making OAuth requests. - /// Resulting URLs must exclude port 80 or port 443 when accompanied by HTTP and HTTPS, respectively. - /// Resulting URLs must be lower case. - /// - /// - /// The original request URL - /// - public static string ConstructRequestUrl(Uri url) - { - if (url == null) - throw new ArgumentNullException("url"); - - var sb = new StringBuilder(); - var requestUrl = "{0}://{1}".FormatWith(url.Scheme, url.Host); - var qualified = ":{0}".FormatWith(url.Port); - var basic = url.Scheme == "http" && url.Port == 80; - var secure = url.Scheme == "https" && url.Port == 443; - - sb.Append(requestUrl); - sb.Append(!basic && !secure - ? qualified - : ""); - sb.Append(url.AbsolutePath); - - return sb.ToString(); //.ToLower(); - } - - /// - /// Creates a request elements concatentation value to send with a request. - /// This is also known as the signature base. - /// - /// - /// - /// The request's HTTP method type - /// The request URL - /// The request's parameters - /// A signature base string - public static string ConcatenateRequestElements(string method, string url, WebParameterCollection parameters) - { - var sb = new StringBuilder(); - - // Separating &'s are not URL encoded - var requestMethod = method.ToUpper().Then("&"); - var requestUrl = UrlEncodeRelaxed(ConstructRequestUrl(url.AsUri())).Then("&"); - var requestParameters = UrlEncodeRelaxed(NormalizeRequestParameters(parameters)); - - sb.Append(requestMethod); - sb.Append(requestUrl); - sb.Append(requestParameters); - - return sb.ToString(); - } - - /// - /// Creates a signature value given a signature base and the consumer secret. - /// This method is used when the token secret is currently unknown. - /// - /// - /// The hashing method - /// The signature base - /// The consumer key - /// - public static string GetSignature(OAuthSignatureMethod signatureMethod, string signatureBase, - string consumerSecret) - { - return GetSignature(signatureMethod, OAuthSignatureTreatment.Escaped, signatureBase, consumerSecret, null); - } - - /// - /// Creates a signature value given a signature base and the consumer secret. - /// This method is used when the token secret is currently unknown. - /// - /// - /// The hashing method - /// The treatment to use on a signature value - /// The signature base - /// The consumer key - /// - public static string GetSignature(OAuthSignatureMethod signatureMethod, - OAuthSignatureTreatment signatureTreatment, - string signatureBase, string consumerSecret) - { - return GetSignature(signatureMethod, signatureTreatment, signatureBase, consumerSecret, null); - } - - /// - /// Creates a signature value given a signature base and the consumer secret and a known token secret. - /// - /// - /// The hashing method - /// The signature base - /// The consumer secret - /// The token secret - /// - public static string GetSignature(OAuthSignatureMethod signatureMethod, string signatureBase, - string consumerSecret, - string tokenSecret) - { - return GetSignature(signatureMethod, OAuthSignatureTreatment.Escaped, consumerSecret, tokenSecret); - } - - /// - /// Creates a signature value given a signature base and the consumer secret and a known token secret. - /// - /// - /// The hashing method - /// The treatment to use on a signature value - /// The signature base - /// The consumer secret - /// The token secret - /// - public static string GetSignature(OAuthSignatureMethod signatureMethod, - OAuthSignatureTreatment signatureTreatment, - string signatureBase, string consumerSecret, string tokenSecret) - { - if (tokenSecret.IsNullOrBlank()) - tokenSecret = string.Empty; - - consumerSecret = UrlEncodeRelaxed(consumerSecret); - tokenSecret = UrlEncodeRelaxed(tokenSecret); - - string signature; - - switch (signatureMethod) - { - case OAuthSignatureMethod.HmacSha1: - { - var crypto = new HMACSHA1(); - var key = "{0}&{1}".FormatWith(consumerSecret, tokenSecret); - - crypto.Key = encoding.GetBytes(key); - signature = signatureBase.HashWith(crypto); - break; - } - - case OAuthSignatureMethod.HmacSha256: - { - var crypto = new HMACSHA256(); - var key = "{0}&{1}".FormatWith(consumerSecret, tokenSecret); - - crypto.Key = encoding.GetBytes(key); - signature = signatureBase.HashWith(crypto); - break; - } - - case OAuthSignatureMethod.PlainText: - { - signature = "{0}&{1}".FormatWith(consumerSecret, tokenSecret); - - break; - } - - default: - throw new NotImplementedException("Only HMAC-SHA1 and HMAC-SHA256 are currently supported."); - } - - var result = signatureTreatment == OAuthSignatureTreatment.Escaped - ? UrlEncodeRelaxed(signature) - : signature; - - return result; - } - } -} \ No newline at end of file diff --git a/RestSharp/Authenticators/OAuth/OAuthType.cs b/RestSharp/Authenticators/OAuth/OAuthType.cs deleted file mode 100644 index e5b7961c2..000000000 --- a/RestSharp/Authenticators/OAuth/OAuthType.cs +++ /dev/null @@ -1,13 +0,0 @@ -using System.Runtime.Serialization; - -namespace RestSharp.Authenticators.OAuth -{ - [DataContract] - public enum OAuthType - { - RequestToken, - AccessToken, - ProtectedResource, - ClientAuthentication - } -} diff --git a/RestSharp/Authenticators/OAuth/OAuthWebQueryInfo.cs b/RestSharp/Authenticators/OAuth/OAuthWebQueryInfo.cs deleted file mode 100644 index 70a223836..000000000 --- a/RestSharp/Authenticators/OAuth/OAuthWebQueryInfo.cs +++ /dev/null @@ -1,44 +0,0 @@ -using System.Runtime.Serialization; - -namespace RestSharp.Authenticators.OAuth -{ - [DataContract] - public class OAuthWebQueryInfo - { - public virtual string ConsumerKey { get; set; } - - public virtual string Token { get; set; } - - public virtual string Nonce { get; set; } - - public virtual string Timestamp { get; set; } - - public virtual string SignatureMethod { get; set; } - - public virtual string Signature { get; set; } - - public virtual string Version { get; set; } - - public virtual string Callback { get; set; } - - public virtual string Verifier { get; set; } - - public virtual string ClientMode { get; set; } - - public virtual string ClientUsername { get; set; } - - public virtual string ClientPassword { get; set; } - - public virtual string UserAgent { get; set; } - - public virtual string WebMethod { get; set; } - - public virtual OAuthParameterHandling ParameterHandling { get; set; } - - public virtual OAuthSignatureTreatment SignatureTreatment { get; set; } - - internal virtual string ConsumerSecret { get; set; } - - internal virtual string TokenSecret { get; set; } - } -} diff --git a/RestSharp/Authenticators/OAuth/OAuthWorkflow.cs b/RestSharp/Authenticators/OAuth/OAuthWorkflow.cs deleted file mode 100644 index 7e6cf43a5..000000000 --- a/RestSharp/Authenticators/OAuth/OAuthWorkflow.cs +++ /dev/null @@ -1,359 +0,0 @@ -using System; -using System.Collections.Generic; -using System.Web; -using RestSharp.Authenticators.OAuth.Extensions; - -namespace RestSharp.Authenticators.OAuth -{ - /// - /// A class to encapsulate OAuth authentication flow. - /// - /// - internal class OAuthWorkflow - { - public virtual string Version { get; set; } - - public virtual string ConsumerKey { get; set; } - - public virtual string ConsumerSecret { get; set; } - - public virtual string Token { get; set; } - - public virtual string TokenSecret { get; set; } - - public virtual string CallbackUrl { get; set; } - - public virtual string Verifier { get; set; } - - public virtual string SessionHandle { get; set; } - - public virtual OAuthSignatureMethod SignatureMethod { get; set; } - - public virtual OAuthSignatureTreatment SignatureTreatment { get; set; } - - public virtual OAuthParameterHandling ParameterHandling { get; set; } - - public virtual string ClientUsername { get; set; } - - public virtual string ClientPassword { get; set; } - - /// - public virtual string RequestTokenUrl { get; set; } - - /// - public virtual string AccessTokenUrl { get; set; } - - /// - public virtual string AuthorizationUrl { get; set; } - - /// - /// Generates a instance to pass to an - /// for the purpose of requesting an - /// unauthorized request token. - /// - /// The HTTP method for the intended request - /// - /// - public OAuthWebQueryInfo BuildRequestTokenInfo(string method) - { - return BuildRequestTokenInfo(method, null); - } - - /// - /// Generates a instance to pass to an - /// for the purpose of requesting an - /// unauthorized request token. - /// - /// The HTTP method for the intended request - /// Any existing, non-OAuth query parameters desired in the request - /// - /// - public virtual OAuthWebQueryInfo BuildRequestTokenInfo(string method, WebParameterCollection parameters) - { - ValidateTokenRequestState(); - - if (parameters == null) - parameters = new WebParameterCollection(); - - var timestamp = OAuthTools.GetTimestamp(); - var nonce = OAuthTools.GetNonce(); - - AddAuthParameters(parameters, timestamp, nonce); - - var signatureBase = OAuthTools.ConcatenateRequestElements(method, RequestTokenUrl, parameters); - var signature = OAuthTools.GetSignature(SignatureMethod, SignatureTreatment, signatureBase, ConsumerSecret); - - var info = new OAuthWebQueryInfo - { - WebMethod = method, - ParameterHandling = ParameterHandling, - ConsumerKey = ConsumerKey, - SignatureMethod = SignatureMethod.ToRequestValue(), - SignatureTreatment = SignatureTreatment, - Signature = signature, - Timestamp = timestamp, - Nonce = nonce, - Version = Version ?? "1.0", - Callback = OAuthTools.UrlEncodeRelaxed(CallbackUrl ?? ""), - TokenSecret = TokenSecret, - ConsumerSecret = ConsumerSecret - }; - - return info; - } - - /// - /// Generates a instance to pass to an - /// for the purpose of exchanging a request token - /// for an access token authorized by the user at the Service Provider site. - /// - /// The HTTP method for the intended request - /// - public virtual OAuthWebQueryInfo BuildAccessTokenInfo(string method) - { - return BuildAccessTokenInfo(method, null); - } - - /// - /// Generates a instance to pass to an - /// for the purpose of exchanging a request token - /// for an access token authorized by the user at the Service Provider site. - /// - /// The HTTP method for the intended request - /// - /// Any existing, non-OAuth query parameters desired in the request - public virtual OAuthWebQueryInfo BuildAccessTokenInfo(string method, WebParameterCollection parameters) - { - ValidateAccessRequestState(); - - if (parameters == null) - parameters = new WebParameterCollection(); - - var uri = new Uri(AccessTokenUrl); - var timestamp = OAuthTools.GetTimestamp(); - var nonce = OAuthTools.GetNonce(); - - AddAuthParameters(parameters, timestamp, nonce); - - var signatureBase = OAuthTools.ConcatenateRequestElements(method, uri.ToString(), parameters); - var signature = OAuthTools.GetSignature(SignatureMethod, SignatureTreatment, signatureBase, - ConsumerSecret, TokenSecret); - - var info = new OAuthWebQueryInfo - { - WebMethod = method, - ParameterHandling = ParameterHandling, - ConsumerKey = ConsumerKey, - Token = Token, - SignatureMethod = SignatureMethod.ToRequestValue(), - SignatureTreatment = SignatureTreatment, - Signature = signature, - Timestamp = timestamp, - Nonce = nonce, - Version = Version ?? "1.0", - Verifier = Verifier, - Callback = CallbackUrl, - TokenSecret = TokenSecret, - ConsumerSecret = ConsumerSecret - }; - - return info; - } - - /// - /// Generates a instance to pass to an - /// for the purpose of exchanging user credentials - /// for an access token authorized by the user at the Service Provider site. - /// - /// The HTTP method for the intended request - /// - /// Any existing, non-OAuth query parameters desired in the request - public virtual OAuthWebQueryInfo BuildClientAuthAccessTokenInfo(string method, - WebParameterCollection parameters) - { - ValidateClientAuthAccessRequestState(); - - if (parameters == null) - parameters = new WebParameterCollection(); - - var uri = new Uri(AccessTokenUrl); - var timestamp = OAuthTools.GetTimestamp(); - var nonce = OAuthTools.GetNonce(); - - AddXAuthParameters(parameters, timestamp, nonce); - - var signatureBase = OAuthTools.ConcatenateRequestElements(method, uri.ToString(), parameters); - var signature = OAuthTools.GetSignature(SignatureMethod, SignatureTreatment, signatureBase, - ConsumerSecret); - - var info = new OAuthWebQueryInfo - { - WebMethod = method, - ParameterHandling = ParameterHandling, - ClientMode = "client_auth", - ClientUsername = ClientUsername, - ClientPassword = ClientPassword, - ConsumerKey = ConsumerKey, - SignatureMethod = SignatureMethod.ToRequestValue(), - SignatureTreatment = SignatureTreatment, - Signature = signature, - Timestamp = timestamp, - Nonce = nonce, - Version = Version ?? "1.0", - TokenSecret = TokenSecret, - ConsumerSecret = ConsumerSecret - }; - - return info; - } - - public virtual OAuthWebQueryInfo BuildProtectedResourceInfo(string method, WebParameterCollection parameters, - string url) - { - ValidateProtectedResourceState(); - - if (parameters == null) - parameters = new WebParameterCollection(); - - // Include url parameters in query pool - var uri = new Uri(url); - var urlParameters = System.Web.HttpUtility.ParseQueryString(uri.Query); - - foreach (var parameter in urlParameters.AllKeys) - switch (method.ToUpperInvariant()) - { - case "POST": - parameters.Add(new HttpPostParameter(parameter, urlParameters[parameter])); - break; - - default: - parameters.Add(parameter, urlParameters[parameter]); - break; - } - - var timestamp = OAuthTools.GetTimestamp(); - var nonce = OAuthTools.GetNonce(); - - AddAuthParameters(parameters, timestamp, nonce); - - var signatureBase = OAuthTools.ConcatenateRequestElements(method, url, parameters); - var signature = OAuthTools.GetSignature(SignatureMethod, SignatureTreatment, signatureBase, - ConsumerSecret, TokenSecret); - - var info = new OAuthWebQueryInfo - { - WebMethod = method, - ParameterHandling = ParameterHandling, - ConsumerKey = ConsumerKey, - Token = Token, - SignatureMethod = SignatureMethod.ToRequestValue(), - SignatureTreatment = SignatureTreatment, - Signature = signature, - Timestamp = timestamp, - Nonce = nonce, - Version = Version ?? "1.0", - Callback = CallbackUrl, - ConsumerSecret = ConsumerSecret, - TokenSecret = TokenSecret - }; - - return info; - } - - private void ValidateTokenRequestState() - { - if (RequestTokenUrl.IsNullOrBlank()) - throw new ArgumentException("You must specify a request token URL"); - - if (ConsumerKey.IsNullOrBlank()) - throw new ArgumentException("You must specify a consumer key"); - - if (ConsumerSecret.IsNullOrBlank()) - throw new ArgumentException("You must specify a consumer secret"); - } - - private void ValidateAccessRequestState() - { - if (AccessTokenUrl.IsNullOrBlank()) - throw new ArgumentException("You must specify an access token URL"); - - if (ConsumerKey.IsNullOrBlank()) - throw new ArgumentException("You must specify a consumer key"); - - if (ConsumerSecret.IsNullOrBlank()) - throw new ArgumentException("You must specify a consumer secret"); - - if (Token.IsNullOrBlank()) - throw new ArgumentException("You must specify a token"); - } - - private void ValidateClientAuthAccessRequestState() - { - if (AccessTokenUrl.IsNullOrBlank()) - throw new ArgumentException("You must specify an access token URL"); - - if (ConsumerKey.IsNullOrBlank()) - throw new ArgumentException("You must specify a consumer key"); - - if (ConsumerSecret.IsNullOrBlank()) - throw new ArgumentException("You must specify a consumer secret"); - - if (ClientUsername.IsNullOrBlank() || ClientPassword.IsNullOrBlank()) - throw new ArgumentException("You must specify user credentials"); - } - - private void ValidateProtectedResourceState() - { - if (ConsumerKey.IsNullOrBlank()) - throw new ArgumentException("You must specify a consumer key"); - - if (ConsumerSecret.IsNullOrBlank()) - throw new ArgumentException("You must specify a consumer secret"); - } - - private void AddAuthParameters(ICollection parameters, string timestamp, string nonce) - { - var authParameters = new WebParameterCollection - { - new WebPair("oauth_consumer_key", ConsumerKey), - new WebPair("oauth_nonce", nonce), - new WebPair("oauth_signature_method", SignatureMethod.ToRequestValue()), - new WebPair("oauth_timestamp", timestamp), - new WebPair("oauth_version", Version ?? "1.0") - }; - - if (!Token.IsNullOrBlank()) - authParameters.Add(new WebPair("oauth_token", Token)); - - if (!CallbackUrl.IsNullOrBlank()) - authParameters.Add(new WebPair("oauth_callback", CallbackUrl)); - - if (!Verifier.IsNullOrBlank()) - authParameters.Add(new WebPair("oauth_verifier", Verifier)); - - if (!SessionHandle.IsNullOrBlank()) - authParameters.Add(new WebPair("oauth_session_handle", SessionHandle)); - - foreach (var authParameter in authParameters) - parameters.Add(authParameter); - } - - private void AddXAuthParameters(ICollection parameters, string timestamp, string nonce) - { - var authParameters = new WebParameterCollection - { - new WebPair("x_auth_username", ClientUsername), - new WebPair("x_auth_password", ClientPassword), - new WebPair("x_auth_mode", "client_auth"), - new WebPair("oauth_consumer_key", ConsumerKey), - new WebPair("oauth_signature_method", SignatureMethod.ToRequestValue()), - new WebPair("oauth_timestamp", timestamp), - new WebPair("oauth_nonce", nonce), - new WebPair("oauth_version", Version ?? "1.0") - }; - - foreach (var authParameter in authParameters) - parameters.Add(authParameter); - } - } -} \ No newline at end of file diff --git a/RestSharp/Authenticators/OAuth/WebPair.cs b/RestSharp/Authenticators/OAuth/WebPair.cs deleted file mode 100644 index dca364737..000000000 --- a/RestSharp/Authenticators/OAuth/WebPair.cs +++ /dev/null @@ -1,15 +0,0 @@ -namespace RestSharp.Authenticators.OAuth -{ - internal class WebPair - { - public WebPair(string name, string value) - { - Name = name; - Value = value; - } - - public string Value { get; set; } - - public string Name { get; set; } - } -} \ No newline at end of file diff --git a/RestSharp/Authenticators/OAuth/WebPairCollection.cs b/RestSharp/Authenticators/OAuth/WebPairCollection.cs deleted file mode 100644 index 391854fcf..000000000 --- a/RestSharp/Authenticators/OAuth/WebPairCollection.cs +++ /dev/null @@ -1,101 +0,0 @@ -using System; -using System.Collections; -using System.Collections.Generic; -using System.Collections.Specialized; -using System.Linq; - -namespace RestSharp.Authenticators.OAuth -{ - internal class WebPairCollection : IList - { - private List parameters; - - public WebPairCollection(IEnumerable parameters) => this.parameters = new List(parameters); - - public WebPairCollection(NameValueCollection collection) - : this() => AddCollection(collection); - - public WebPairCollection(IDictionary collection) - : this() => AddCollection(collection); - - public WebPairCollection() => parameters = new List(0); - - public WebPairCollection(int capacity) => parameters = new List(capacity); - - public virtual WebPair this[string name] => this.SingleOrDefault(p => p.Name.Equals(name)); - - public virtual IEnumerable Names => parameters.Select(p => p.Name); - - public virtual IEnumerable Values => parameters.Select(p => p.Value); - - public virtual IEnumerator GetEnumerator() => parameters.GetEnumerator(); - - IEnumerator IEnumerable.GetEnumerator() => GetEnumerator(); - - public virtual void Add(WebPair parameter) => parameters.Add(parameter); - - public virtual void Clear() => parameters.Clear(); - - public virtual bool Contains(WebPair parameter) => parameters.Contains(parameter); - - public virtual void CopyTo(WebPair[] parametersArray, int arrayIndex) => - parameters.CopyTo(parametersArray, arrayIndex); - - public virtual bool Remove(WebPair parameter) => parameters.Remove(parameter); - - public virtual int Count => parameters.Count; - - public virtual bool IsReadOnly => false; - - public virtual int IndexOf(WebPair parameter) => parameters.IndexOf(parameter); - - public virtual void Insert(int index, WebPair parameter) => parameters.Insert(index, parameter); - - public virtual void RemoveAt(int index) => parameters.RemoveAt(index); - - public virtual WebPair this[int index] - { - get => parameters[index]; - set => parameters[index] = value; - } - - public virtual void AddRange(NameValueCollection collection) => AddCollection(collection); - - private void AddCollection(NameValueCollection collection) => - parameters.AddRange(collection.AllKeys.Select(key => new WebPair(key, collection[key]))); - - public void AddCollection(IDictionary collection) => - parameters.AddRange(collection.Keys.Select(key => new WebPair(key, collection[key]))); - - private void AddCollection(IEnumerable collection) => - parameters.AddRange(collection.Select(parameter => new WebPair(parameter.Name, parameter.Value))); - - public virtual void AddRange(WebPairCollection collection) => AddCollection(collection); - - public virtual void AddRange(IEnumerable collection) => AddCollection(collection); - - public virtual void Sort(Comparison comparison) - { - var sorted = new List(parameters); - - sorted.Sort(comparison); - - parameters = sorted; - } - - public virtual bool RemoveAll(IEnumerable parametersToRemove) - { - var array = parametersToRemove.ToArray(); - var success = array.Aggregate(true, (current, parameter) => current & parameters.Remove(parameter)); - - return success && array.Length > 0; - } - - public virtual void Add(string name, string value) - { - var pair = new WebPair(name, value); - - parameters.Add(pair); - } - } -} \ No newline at end of file diff --git a/RestSharp/Authenticators/OAuth/WebParameter.cs b/RestSharp/Authenticators/OAuth/WebParameter.cs deleted file mode 100644 index f63a47316..000000000 --- a/RestSharp/Authenticators/OAuth/WebParameter.cs +++ /dev/null @@ -1,11 +0,0 @@ -using System.Runtime.Serialization; - -namespace RestSharp.Authenticators.OAuth -{ - [DataContract] - internal class WebParameter : WebPair - { - public WebParameter(string name, string value) - : base(name, value) { } - } -} diff --git a/RestSharp/Authenticators/OAuth/WebParameterCollection.cs b/RestSharp/Authenticators/OAuth/WebParameterCollection.cs deleted file mode 100644 index ada5efe67..000000000 --- a/RestSharp/Authenticators/OAuth/WebParameterCollection.cs +++ /dev/null @@ -1,28 +0,0 @@ -using System.Collections.Generic; -using System.Collections.Specialized; - -namespace RestSharp.Authenticators.OAuth -{ - internal class WebParameterCollection : WebPairCollection - { - public WebParameterCollection(IEnumerable parameters) - : base(parameters) { } - - public WebParameterCollection(NameValueCollection collection) - : base(collection) { } - - public WebParameterCollection() { } - - public WebParameterCollection(int capacity) : base(capacity) { } - - public WebParameterCollection(IDictionary collection) - : base(collection) { } - - public override void Add(string name, string value) - { - WebParameter parameter = new WebParameter(name, value); - - base.Add(parameter); - } - } -} diff --git a/RestSharp/Authenticators/OAuth1Authenticator.cs b/RestSharp/Authenticators/OAuth1Authenticator.cs deleted file mode 100644 index 4d682aafd..000000000 --- a/RestSharp/Authenticators/OAuth1Authenticator.cs +++ /dev/null @@ -1,324 +0,0 @@ -#region License - -// Copyright 2010 John Sheehan -// -// Licensed under the Apache License, Version 2.0 (the "License"); -// you may not use this file except in compliance with the License. -// You may obtain a copy of the License at -// -// http://www.apache.org/licenses/LICENSE-2.0 -// -// Unless required by applicable law or agreed to in writing, software -// distributed under the License is distributed on an "AS IS" BASIS, -// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -// See the License for the specific language governing permissions and -// limitations under the License. - -#endregion - -using System; -using System.Linq; -using System.Text; -using System.Web; -using RestSharp.Authenticators.OAuth; -using RestSharp.Authenticators.OAuth.Extensions; - -namespace RestSharp.Authenticators -{ - /// - public class OAuth1Authenticator : IAuthenticator - { - public virtual string Realm { get; set; } - - public virtual OAuthParameterHandling ParameterHandling { get; set; } - - public virtual OAuthSignatureMethod SignatureMethod { get; set; } - - public virtual OAuthSignatureTreatment SignatureTreatment { get; set; } - - internal virtual OAuthType Type { get; set; } - - internal virtual string ConsumerKey { get; set; } - - internal virtual string ConsumerSecret { get; set; } - - internal virtual string Token { get; set; } - - internal virtual string TokenSecret { get; set; } - - internal virtual string Verifier { get; set; } - - internal virtual string Version { get; set; } - - internal virtual string CallbackUrl { get; set; } - - internal virtual string SessionHandle { get; set; } - - internal virtual string ClientUsername { get; set; } - - internal virtual string ClientPassword { get; set; } - - public void Authenticate(IRestClient client, IRestRequest request) - { - var workflow = new OAuthWorkflow - { - ConsumerKey = ConsumerKey, - ConsumerSecret = ConsumerSecret, - ParameterHandling = ParameterHandling, - SignatureMethod = SignatureMethod, - SignatureTreatment = SignatureTreatment, - Verifier = Verifier, - Version = Version, - CallbackUrl = CallbackUrl, - SessionHandle = SessionHandle, - Token = Token, - TokenSecret = TokenSecret, - ClientUsername = ClientUsername, - ClientPassword = ClientPassword - }; - - AddOAuthData(client, request, workflow); - } - - public static OAuth1Authenticator ForRequestToken(string consumerKey, string consumerSecret, - OAuthSignatureMethod signatureMethod = OAuthSignatureMethod.HmacSha1) - { - var authenticator = new OAuth1Authenticator - { - ParameterHandling = OAuthParameterHandling.HttpAuthorizationHeader, - SignatureMethod = signatureMethod, - SignatureTreatment = OAuthSignatureTreatment.Escaped, - ConsumerKey = consumerKey, - ConsumerSecret = consumerSecret, - Type = OAuthType.RequestToken - }; - - return authenticator; - } - - public static OAuth1Authenticator ForRequestToken(string consumerKey, string consumerSecret, string callbackUrl) - { - var authenticator = ForRequestToken(consumerKey, consumerSecret); - - authenticator.CallbackUrl = callbackUrl; - - return authenticator; - } - - public static OAuth1Authenticator ForAccessToken(string consumerKey, string consumerSecret, string token, - string tokenSecret, OAuthSignatureMethod signatureMethod = OAuthSignatureMethod.HmacSha1) - { - var authenticator = new OAuth1Authenticator - { - ParameterHandling = OAuthParameterHandling.HttpAuthorizationHeader, - SignatureMethod = signatureMethod, - SignatureTreatment = OAuthSignatureTreatment.Escaped, - ConsumerKey = consumerKey, - ConsumerSecret = consumerSecret, - Token = token, - TokenSecret = tokenSecret, - Type = OAuthType.AccessToken - }; - - return authenticator; - } - - public static OAuth1Authenticator ForAccessToken(string consumerKey, string consumerSecret, string token, - string tokenSecret, string verifier) - { - var authenticator = ForAccessToken(consumerKey, consumerSecret, token, tokenSecret); - - authenticator.Verifier = verifier; - - return authenticator; - } - - public static OAuth1Authenticator ForAccessTokenRefresh(string consumerKey, string consumerSecret, string token, - string tokenSecret, string sessionHandle) - { - var authenticator = ForAccessToken(consumerKey, consumerSecret, token, tokenSecret); - - authenticator.SessionHandle = sessionHandle; - - return authenticator; - } - - public static OAuth1Authenticator ForAccessTokenRefresh(string consumerKey, string consumerSecret, string token, - string tokenSecret, string verifier, string sessionHandle) - { - var authenticator = ForAccessToken(consumerKey, consumerSecret, token, tokenSecret); - - authenticator.SessionHandle = sessionHandle; - authenticator.Verifier = verifier; - - return authenticator; - } - - public static OAuth1Authenticator ForClientAuthentication(string consumerKey, string consumerSecret, - string username, string password, OAuthSignatureMethod signatureMethod = OAuthSignatureMethod.HmacSha1) - { - var authenticator = new OAuth1Authenticator - { - ParameterHandling = OAuthParameterHandling.HttpAuthorizationHeader, - SignatureMethod = signatureMethod, - SignatureTreatment = OAuthSignatureTreatment.Escaped, - ConsumerKey = consumerKey, - ConsumerSecret = consumerSecret, - ClientUsername = username, - ClientPassword = password, - Type = OAuthType.ClientAuthentication - }; - - return authenticator; - } - - public static OAuth1Authenticator ForProtectedResource(string consumerKey, string consumerSecret, - string accessToken, string accessTokenSecret, - OAuthSignatureMethod signatureMethod = OAuthSignatureMethod.HmacSha1) - { - var authenticator = new OAuth1Authenticator - { - Type = OAuthType.ProtectedResource, - ParameterHandling = OAuthParameterHandling.HttpAuthorizationHeader, - SignatureMethod = signatureMethod, - SignatureTreatment = OAuthSignatureTreatment.Escaped, - ConsumerKey = consumerKey, - ConsumerSecret = consumerSecret, - Token = accessToken, - TokenSecret = accessTokenSecret - }; - - return authenticator; - } - - private void AddOAuthData(IRestClient client, IRestRequest request, OAuthWorkflow workflow) - { - var url = client.BuildUri(request) - .ToString(); - var queryStringStart = url.IndexOf('?'); - - if (queryStringStart != -1) - url = url.Substring(0, queryStringStart); - - OAuthWebQueryInfo oauth; - var method = request.Method.ToString() - .ToUpperInvariant(); - var parameters = new WebParameterCollection(); - - // include all GET and POST parameters before generating the signature - // according to the RFC 5849 - The OAuth 1.0 Protocol - // http://tools.ietf.org/html/rfc5849#section-3.4.1 - // if this change causes trouble we need to introduce a flag indicating the specific OAuth implementation level, - // or implement a seperate class for each OAuth version - if (!request.AlwaysMultipartFormData && !request.Files.Any()) - { - parameters.AddRange( - client.DefaultParameters - .Where(p => p.Type == ParameterType.GetOrPost || p.Type == ParameterType.QueryString) - .Select(p => new WebPair(p.Name, p.Value.ToString()))); - - parameters.AddRange( - request.Parameters - .Where(p => p.Type == ParameterType.GetOrPost || p.Type == ParameterType.QueryString) - .Select(p => new WebPair(p.Name, p.Value.ToString()))); - } - else - { - // if we are sending a multipart request, only the "oauth_" parameters should be included in the signature - - parameters.AddRange( - client.DefaultParameters - .Where(p => (p.Type == ParameterType.GetOrPost || p.Type == ParameterType.QueryString) - && p.Name.StartsWith("oauth_")) - .Select(p => new WebPair(p.Name, p.Value.ToString()))); - - parameters.AddRange( - request.Parameters - .Where(p => (p.Type == ParameterType.GetOrPost || p.Type == ParameterType.QueryString) - && p.Name.StartsWith("oauth_")) - .Select(p => new WebPair(p.Name, p.Value.ToString()))); - } - - switch (Type) - { - case OAuthType.RequestToken: - workflow.RequestTokenUrl = url; - oauth = workflow.BuildRequestTokenInfo(method, parameters); - break; - - case OAuthType.AccessToken: - workflow.AccessTokenUrl = url; - oauth = workflow.BuildAccessTokenInfo(method, parameters); - break; - - case OAuthType.ClientAuthentication: - workflow.AccessTokenUrl = url; - oauth = workflow.BuildClientAuthAccessTokenInfo(method, parameters); - break; - - case OAuthType.ProtectedResource: - oauth = workflow.BuildProtectedResourceInfo(method, parameters, url); - break; - - default: - throw new ArgumentOutOfRangeException(); - } - - switch (ParameterHandling) - { - case OAuthParameterHandling.HttpAuthorizationHeader: - parameters.Add("oauth_signature", oauth.Signature); - request.AddHeader("Authorization", GetAuthorizationHeader(parameters)); - break; - - case OAuthParameterHandling.UrlOrPostParameters: - parameters.Add("oauth_signature", oauth.Signature); - request.Parameters.AddRange( - parameters.Where(p => !p.Name.IsNullOrBlank() && - (p.Name.StartsWith("oauth_") || p.Name.StartsWith("x_auth_"))) - .Select(p => new Parameter - { - Name = p.Name, - Value = HttpUtility.UrlDecode(p.Value), - Type = ParameterType.GetOrPost - })); - break; - - default: - throw new ArgumentOutOfRangeException(); - } - } - - private string GetAuthorizationHeader(WebPairCollection parameters) - { - var sb = new StringBuilder("OAuth "); - - if (!Realm.IsNullOrBlank()) - sb.Append("realm=\"{0}\",".FormatWith(OAuthTools.UrlEncodeRelaxed(Realm))); - - parameters.Sort((l, r) => l.Name.CompareTo(r.Name)); - - var parameterCount = 0; - var oathParameters = - parameters.Where(p => !p.Name.IsNullOrBlank() && - !p.Value.IsNullOrBlank() && - (p.Name.StartsWith("oauth_") || p.Name.StartsWith("x_auth_"))) - .ToList(); - - foreach (var parameter in oathParameters) - { - parameterCount++; - - var format = parameterCount < oathParameters.Count - ? "{0}=\"{1}\"," - : "{0}=\"{1}\""; - - sb.Append(format.FormatWith(parameter.Name, parameter.Value)); - } - - var authorization = sb.ToString(); - - return authorization; - } - } -} \ No newline at end of file diff --git a/RestSharp/Authenticators/OAuth2Authenticator.cs b/RestSharp/Authenticators/OAuth2Authenticator.cs deleted file mode 100644 index 712fa67e5..000000000 --- a/RestSharp/Authenticators/OAuth2Authenticator.cs +++ /dev/null @@ -1,132 +0,0 @@ -#region License - -// Copyright 2010 John Sheehan -// -// Licensed under the Apache License, Version 2.0 (the "License"); -// you may not use this file except in compliance with the License. -// You may obtain a copy of the License at -// -// http://www.apache.org/licenses/LICENSE-2.0 -// -// Unless required by applicable law or agreed to in writing, software -// distributed under the License is distributed on an "AS IS" BASIS, -// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -// See the License for the specific language governing permissions and -// limitations under the License. - -#endregion - -using System; -using System.Linq; - -namespace RestSharp.Authenticators -{ - /// - /// Base class for OAuth 2 Authenticators. - /// - /// - /// Since there are many ways to authenticate in OAuth2, - /// this is used as a base class to differentiate between - /// other authenticators. - /// Any other OAuth2 authenticators must derive from this - /// abstract class. - /// - public abstract class OAuth2Authenticator : IAuthenticator - { - /// - /// Access token to be used when authenticating. - /// - private readonly string accessToken; - - /// - /// Initializes a new instance of the class. - /// - /// - /// The access token. - /// - protected OAuth2Authenticator(string accessToken) - { - this.accessToken = accessToken; - } - - /// - /// Gets the access token. - /// - public string AccessToken => accessToken; - - public abstract void Authenticate(IRestClient client, IRestRequest request); - } - - /// - /// The OAuth 2 authenticator using URI query parameter. - /// - /// - /// Based on http://tools.ietf.org/html/draft-ietf-oauth-v2-10#section-5.1.2 - /// - public class OAuth2UriQueryParameterAuthenticator : OAuth2Authenticator - { - /// - /// Initializes a new instance of the class. - /// - /// - /// The access token. - /// - public OAuth2UriQueryParameterAuthenticator(string accessToken) - : base(accessToken) - { - } - - public override void Authenticate(IRestClient client, IRestRequest request) - { - request.AddParameter("oauth_token", AccessToken, ParameterType.GetOrPost); - } - } - - /// - /// The OAuth 2 authenticator using the authorization request header field. - /// - /// - /// Based on http://tools.ietf.org/html/draft-ietf-oauth-v2-10#section-5.1.1 - /// - public class OAuth2AuthorizationRequestHeaderAuthenticator : OAuth2Authenticator - { - /// - /// Stores the Authorization header value as "[tokenType] accessToken". used for performance. - /// - private readonly string authorizationValue; - - /// - /// Initializes a new instance of the class. - /// - /// - /// The access token. - /// - public OAuth2AuthorizationRequestHeaderAuthenticator(string accessToken) - : this(accessToken, "OAuth") - { - } - - /// - /// Initializes a new instance of the class. - /// - /// - /// The access token. - /// - /// - /// The token type. - /// - public OAuth2AuthorizationRequestHeaderAuthenticator(string accessToken, string tokenType) - : base(accessToken) - { - // Conatenate during constructor so that it is only done once. can improve performance. - authorizationValue = tokenType + " " + accessToken; - } - - public override void Authenticate(IRestClient client, IRestRequest request) - { - // only add the Authorization parameter if it hasn't been added. - if (!request.Parameters.Any(p => p.Name.Equals("Authorization", StringComparison.OrdinalIgnoreCase))) - request.AddParameter("Authorization", authorizationValue, ParameterType.HttpHeader); - } - } -} \ No newline at end of file diff --git a/RestSharp/Authenticators/SimpleAuthenticator.cs b/RestSharp/Authenticators/SimpleAuthenticator.cs deleted file mode 100644 index c91bdf9b7..000000000 --- a/RestSharp/Authenticators/SimpleAuthenticator.cs +++ /dev/null @@ -1,44 +0,0 @@ -#region License - -// Copyright 2010 John Sheehan -// -// Licensed under the Apache License, Version 2.0 (the "License"); -// you may not use this file except in compliance with the License. -// You may obtain a copy of the License at -// -// http://www.apache.org/licenses/LICENSE-2.0 -// -// Unless required by applicable law or agreed to in writing, software -// distributed under the License is distributed on an "AS IS" BASIS, -// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -// See the License for the specific language governing permissions and -// limitations under the License. - -#endregion - -namespace RestSharp.Authenticators -{ - public class SimpleAuthenticator : IAuthenticator - { - private readonly string password; - - private readonly string passwordKey; - - private readonly string username; - private readonly string usernameKey; - - public SimpleAuthenticator(string usernameKey, string username, string passwordKey, string password) - { - this.usernameKey = usernameKey; - this.username = username; - this.passwordKey = passwordKey; - this.password = password; - } - - public void Authenticate(IRestClient client, IRestRequest request) - { - request.AddParameter(usernameKey, username); - request.AddParameter(passwordKey, password); - } - } -} \ No newline at end of file diff --git a/RestSharp/DefaultProxy.cs b/RestSharp/DefaultProxy.cs deleted file mode 100644 index 28a03cda3..000000000 --- a/RestSharp/DefaultProxy.cs +++ /dev/null @@ -1,14 +0,0 @@ -using System; -using System.Net; - -namespace RestSharp -{ - public class DefaultProxy : IWebProxy - { - public Uri GetProxy(Uri destination) => null; - - public bool IsBypassed(Uri host) => true; - - public ICredentials Credentials { get; set; } - } -} \ No newline at end of file diff --git a/RestSharp/Deserializers/DeserializeAsAttribute.cs b/RestSharp/Deserializers/DeserializeAsAttribute.cs deleted file mode 100644 index 6141e8637..000000000 --- a/RestSharp/Deserializers/DeserializeAsAttribute.cs +++ /dev/null @@ -1,39 +0,0 @@ -#region License - -// Copyright 2010 John Sheehan -// -// Licensed under the Apache License, Version 2.0 (the "License"); -// you may not use this file except in compliance with the License. -// You may obtain a copy of the License at -// -// http://www.apache.org/licenses/LICENSE-2.0 -// -// Unless required by applicable law or agreed to in writing, software -// distributed under the License is distributed on an "AS IS" BASIS, -// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -// See the License for the specific language governing permissions and -// limitations under the License. - -#endregion - -using System; - -namespace RestSharp.Deserializers -{ - /// - /// Allows control how class and property names and values are deserialized by XmlAttributeDeserializer - /// - [AttributeUsage(AttributeTargets.Property | AttributeTargets.Class, Inherited = false)] - public sealed class DeserializeAsAttribute : Attribute - { - /// - /// The name to use for the serialized element - /// - public string Name { get; set; } - - /// - /// Sets if the property to Deserialize is an Attribute or Element (Default: false) - /// - public bool Attribute { get; set; } - } -} diff --git a/RestSharp/Deserializers/JsonDeserializer.cs b/RestSharp/Deserializers/JsonDeserializer.cs deleted file mode 100644 index 96e412afa..000000000 --- a/RestSharp/Deserializers/JsonDeserializer.cs +++ /dev/null @@ -1,331 +0,0 @@ -using System; -using System.Collections; -using System.Collections.Generic; -using System.Globalization; -using System.Linq; -using System.Reflection; -using RestSharp.Extensions; -using SimpleJson; - -namespace RestSharp.Deserializers -{ - using System.Xml; - - public class JsonDeserializer : IDeserializer - { - public string RootElement { get; set; } - - public string Namespace { get; set; } - - public string DateFormat { get; set; } - - public CultureInfo Culture { get; set; } - - public JsonDeserializer() - { - Culture = CultureInfo.InvariantCulture; - } - - public T Deserialize(IRestResponse response) - { - object json = FindRoot(response.Content); - - return (T) ConvertValue(typeof(T).GetTypeInfo(), json); - } - - private object FindRoot(string content) - { - object json = SimpleJson.SimpleJson.DeserializeObject(content); - - if (!RootElement.HasValue()) return json; - - if (!(json is IDictionary dictionary)) return json; - - return dictionary.TryGetValue(RootElement, out var result) ? result : json; - } - - private object Map(object target, IDictionary data) - { - var objType = target.GetType().GetTypeInfo(); - var props = objType.GetProperties() - .Where(p => p.CanWrite) - .ToList(); - - foreach (var prop in props) - { - string name; - var type = prop.PropertyType.GetTypeInfo(); - var attributes = prop.GetCustomAttributes(typeof(DeserializeAsAttribute), false); - - if (attributes.Any()) - { - var attribute = (DeserializeAsAttribute) attributes.First(); - name = attribute.Name; - } - else - { - name = prop.Name; - } - - object value = null; - if (!data.TryGetValue(name, out value)) - { - string[] parts = name.Split('.'); - IDictionary currentData = data; - - for (int i = 0; i < parts.Length; ++i) - { - string actualName = parts[i].GetNameVariants(this.Culture) - .FirstOrDefault(currentData.ContainsKey); - - if (actualName == null) - { - break; - } - - if (i == parts.Length - 1) - { - value = currentData[actualName]; - } - else - { - currentData = (IDictionary) currentData[actualName]; - } - } - } - - if (value != null) - { - prop.SetValue(target, ConvertValue(type, value), null); - } - } - - return target; - } - - private IDictionary BuildDictionary(Type type, object parent) - { - IDictionary dict = (IDictionary) Activator.CreateInstance(type); - Type keyType = type.GetTypeInfo().GetGenericArguments()[0]; - Type valueType = type.GetTypeInfo().GetGenericArguments()[1]; - - foreach (KeyValuePair child in (IDictionary) parent) - { - object key = keyType != typeof(string) - ? Convert.ChangeType(child.Key, keyType, CultureInfo.InvariantCulture) - : child.Key; - - object item; - - if (valueType.GetTypeInfo().IsGenericType && - valueType.GetTypeInfo().GetGenericTypeDefinition() == typeof(List<>)) - { - item = BuildList(valueType, child.Value); - } - else - { - item = ConvertValue(valueType.GetTypeInfo(), child.Value); - } - - dict.Add(key, item); - } - - return dict; - } - - private IList BuildList(Type type, object parent) - { - IList list = (IList) Activator.CreateInstance(type); - Type listType = type.GetTypeInfo().GetInterfaces() - .First - (x => x.GetTypeInfo().IsGenericType && x.GetGenericTypeDefinition() == typeof(IList<>)); - Type itemType = listType.GetTypeInfo().GetGenericArguments()[0]; - - if (parent is IList list1) - { - foreach (object element in list1) - { - if (itemType.GetTypeInfo().IsPrimitive) - { - object item = ConvertValue(itemType.GetTypeInfo(), element); - - list.Add(item); - } - else if (itemType == typeof(string)) - { - if (element == null) - { - list.Add(null); - continue; - } - - list.Add(element.ToString()); - } - else - { - if (element == null) - { - list.Add(null); - continue; - } - - object item = ConvertValue(itemType.GetTypeInfo(), element); - - list.Add(item); - } - } - } - else - { - list.Add(ConvertValue(itemType.GetTypeInfo(), parent)); - } - - return list; - } - - private object ConvertValue(TypeInfo typeInfo, object value) - { - string stringValue = Convert.ToString(value, Culture); - - // check for nullable and extract underlying type - if (typeInfo.IsGenericType && typeInfo.GetGenericTypeDefinition() == typeof(Nullable<>)) - { - // Since the type is nullable and no value is provided return null - if (string.IsNullOrEmpty(stringValue)) - { - return null; - } - - typeInfo = typeInfo.GetGenericArguments()[0].GetTypeInfo(); - } - - if (typeInfo.AsType() == typeof(object)) - { - if (value == null) - { - return null; - } - typeInfo = value.GetType().GetTypeInfo(); - } - - var type = typeInfo.AsType(); - if (typeInfo.IsPrimitive) - { - return value.ChangeType(type, Culture); - } - - if (typeInfo.IsEnum) - { - return type.FindEnumValue(stringValue, Culture); - } - - if (type == typeof(Uri)) - { - return new Uri(stringValue, UriKind.RelativeOrAbsolute); - } - - if (type == typeof(string)) - { - return stringValue; - } - - if (type == typeof(DateTime) || type == typeof(DateTimeOffset)) - { - DateTime dt; - - if (DateFormat.HasValue()) - { - dt = DateTime.ParseExact(stringValue, DateFormat, Culture, - DateTimeStyles.AssumeUniversal | DateTimeStyles.AdjustToUniversal); - } - else - { - // try parsing instead - dt = stringValue.ParseJsonDate(this.Culture); - } - - if (type == typeof(DateTime)) - { - return dt; - } - - if (type == typeof(DateTimeOffset)) - { - return (DateTimeOffset) dt; - } - } - else if (type == typeof(decimal)) - { - if (value is double d) - { - return (decimal) d; - } - - return stringValue.Contains("e") - ? decimal.Parse(stringValue, NumberStyles.Float, Culture) - : decimal.Parse(stringValue, Culture); - } - else if (type == typeof(Guid)) - { - return string.IsNullOrEmpty(stringValue) - ? Guid.Empty - : new Guid(stringValue); - } - else if (type == typeof(TimeSpan)) - { - // This should handle ISO 8601 durations - return TimeSpan.TryParse(stringValue, out var timeSpan) ? timeSpan : XmlConvert.ToTimeSpan(stringValue); - } - else if (type.GetTypeInfo().IsGenericType) - { - Type genericTypeDef = type.GetGenericTypeDefinition(); - - if (genericTypeDef == typeof(IEnumerable<>)) - { - Type itemType = typeInfo.GetGenericArguments()[0]; - Type listType = typeof(List<>).MakeGenericType(itemType); - return BuildList(listType, value); - } - - if (genericTypeDef == typeof(List<>)) - { - return BuildList(type, value); - } - - if (genericTypeDef == typeof(Dictionary<,>)) - { - return BuildDictionary(type, value); - } - - // nested property classes - return CreateAndMap(type, value); - } - else if (type.IsSubclassOfRawGeneric(typeof(List<>))) - { - // handles classes that derive from List - return BuildList(type, value); - } - else if (type == typeof(JsonObject)) - { - // simplify JsonObject into a Dictionary - return BuildDictionary(typeof(Dictionary), value); - } - else - { - // nested property classes - return CreateAndMap(type, value); - } - - return null; - } - - private object CreateAndMap(Type type, object element) - { - object instance = Activator.CreateInstance(type); - - Map(instance, (IDictionary) element); - - return instance; - } - } -} \ No newline at end of file diff --git a/RestSharp/Deserializers/XmlAttributeDeserializer.cs b/RestSharp/Deserializers/XmlAttributeDeserializer.cs deleted file mode 100644 index 7b6305d61..000000000 --- a/RestSharp/Deserializers/XmlAttributeDeserializer.cs +++ /dev/null @@ -1,47 +0,0 @@ -#region License - -// Copyright 2010 John Sheehan -// -// Licensed under the Apache License, Version 2.0 (the "License"); -// you may not use this file except in compliance with the License. -// You may obtain a copy of the License at -// -// http://www.apache.org/licenses/LICENSE-2.0 -// -// Unless required by applicable law or agreed to in writing, software -// distributed under the License is distributed on an "AS IS" BASIS, -// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -// See the License for the specific language governing permissions and -// limitations under the License. - -#endregion - -using System.Reflection; -using System.Xml.Linq; -using RestSharp.Extensions; - -namespace RestSharp.Deserializers -{ - public class XmlAttributeDeserializer : XmlDeserializer - { - protected override object GetValueFromXml(XElement root, XName name, PropertyInfo prop) - { - bool isAttribute = false; - - //Check for the DeserializeAs attribute on the property - DeserializeAsAttribute options = prop.GetAttribute(); - - if (options != null) - { - name = options.Name ?? name; - isAttribute = options.Attribute; - } - - if (!isAttribute) return base.GetValueFromXml(root, name, prop); - - XAttribute attributeVal = GetAttributeByName(root, name); - - return attributeVal != null ? attributeVal.Value : base.GetValueFromXml(root, name, prop); - } - } -} diff --git a/RestSharp/Deserializers/XmlDeserializer.cs b/RestSharp/Deserializers/XmlDeserializer.cs deleted file mode 100644 index 4fb206824..000000000 --- a/RestSharp/Deserializers/XmlDeserializer.cs +++ /dev/null @@ -1,457 +0,0 @@ -#region License - -// Copyright 2010 John Sheehan -// -// Licensed under the Apache License, Version 2.0 (the "License"); -// you may not use this file except in compliance with the License. -// You may obtain a copy of the License at -// -// http://www.apache.org/licenses/LICENSE-2.0 -// -// Unless required by applicable law or agreed to in writing, software -// distributed under the License is distributed on an "AS IS" BASIS, -// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -// See the License for the specific language governing permissions and -// limitations under the License. - -#endregion - -using System; -using System.Collections; -using System.Collections.Generic; -using System.Globalization; -using System.Linq; -using System.Reflection; -using System.Xml; -using System.Xml.Linq; -using RestSharp.Extensions; -#if !SILVERLIGHT && !WINDOWS_PHONE -using System.ComponentModel; - -#endif - -namespace RestSharp.Deserializers -{ - public class XmlDeserializer : IDeserializer - { - public XmlDeserializer() - { - Culture = CultureInfo.InvariantCulture; - } - - public CultureInfo Culture { get; set; } - public string RootElement { get; set; } - - public string Namespace { get; set; } - - public string DateFormat { get; set; } - - public virtual T Deserialize(IRestResponse response) - { - if (string.IsNullOrEmpty(response.Content)) - return default(T); - - var doc = XDocument.Parse(response.Content); - var root = doc.Root; - - if (RootElement.HasValue() && doc.Root != null) - root = doc.Root.DescendantsAndSelf(RootElement.AsNamespaced(Namespace)).SingleOrDefault(); - - // autodetect xml namespace - if (!Namespace.HasValue()) - RemoveNamespace(doc); - - var x = Activator.CreateInstance(); - var objType = x.GetType(); - - if (objType.IsSubclassOfRawGeneric(typeof(List<>))) - x = (T) HandleListDerivative(root, objType.Name, objType); - else - x = (T) Map(x, root); - - return x; - } - - private static void RemoveNamespace(XDocument xdoc) - { - if (xdoc.Root == null) return; - - foreach (var e in xdoc.Root.DescendantsAndSelf()) - { - if (e.Name.Namespace != XNamespace.None) - e.Name = XNamespace.None.GetName(e.Name.LocalName); - - if (e.Attributes() - .Any(a => a.IsNamespaceDeclaration || a.Name.Namespace != XNamespace.None)) - e.ReplaceAttributes( - e.Attributes() - .Select(a => a.IsNamespaceDeclaration - ? null - : a.Name.Namespace != XNamespace.None - ? new XAttribute(XNamespace.None.GetName(a.Name.LocalName), a.Value) - : a)); - } - } - - protected virtual object Map(object x, XElement root) - { - var objType = x.GetType().GetTypeInfo(); - var props = objType.GetProperties(); - - foreach (var prop in props) - { - var type = prop.PropertyType.GetTypeInfo(); - var typeIsPublic = type.IsPublic || type.IsNestedPublic; - - if (!typeIsPublic || !prop.CanWrite) - continue; - - XName name; - var attributes = prop.GetCustomAttributes(typeof(DeserializeAsAttribute), false); - - if (attributes.Any()) - { - var attribute = (DeserializeAsAttribute) attributes.First(); - name = attribute.Name.AsNamespaced(Namespace); - } - else - { - name = prop.Name.AsNamespaced(Namespace); - } - - var value = GetValueFromXml(root, name, prop); - - if (value == null) - { - if (type.IsGenericType) - { - var genericType = type.GetGenericArguments()[0]; - var first = GetElementByName(root, genericType.Name); - var list = (IList) Activator.CreateInstance(type.AsType()); - - if (first != null && root != null) - { - var elements = root.Elements(first.Name); - - PopulateListFromElements(genericType, elements, list); - } - - prop.SetValue(x, list, null); - } - continue; - } - - if (type.IsGenericType && type.GetGenericTypeDefinition() == typeof(Nullable<>)) - { - // if the value is empty, set the property to null... - if (string.IsNullOrEmpty(value.ToString())) - { - prop.SetValue(x, null, null); - continue; - } - - type = type.GetGenericArguments()[0].GetTypeInfo(); - } - - var asType = type.AsType(); - if (asType == typeof(bool)) - { - var toConvert = value.ToString() - .ToLower(); - - prop.SetValue(x, XmlConvert.ToBoolean(toConvert), null); - } - else if (type.IsPrimitive) - { - prop.SetValue(x, value.ChangeType(asType, Culture), null); - } - else if (type.IsEnum) - { - var converted = type.AsType().FindEnumValue(value.ToString(), Culture); - - prop.SetValue(x, converted, null); - } - else if (asType == typeof(Uri)) - { - var uri = new Uri(value.ToString(), UriKind.RelativeOrAbsolute); - - prop.SetValue(x, uri, null); - } - else if (asType == typeof(string)) - { - prop.SetValue(x, value, null); - } - else if (asType == typeof(DateTime)) - { - value = DateFormat.HasValue() - ? DateTime.ParseExact(value.ToString(), DateFormat, Culture) - : DateTime.Parse(value.ToString(), Culture); - - prop.SetValue(x, value, null); - } - else if (asType == typeof(DateTimeOffset)) - { - var toConvert = value.ToString(); - - if (string.IsNullOrEmpty(toConvert)) continue; - - DateTimeOffset deserialisedValue; - - try - { - deserialisedValue = XmlConvert.ToDateTimeOffset(toConvert); - prop.SetValue(x, deserialisedValue, null); - } - catch (Exception) - { - if (TryGetFromString(toConvert, out var result, asType)) - { - prop.SetValue(x, result, null); - } - else - { - //fallback to parse - deserialisedValue = DateTimeOffset.Parse(toConvert); - prop.SetValue(x, deserialisedValue, null); - } - } - } - else if (asType == typeof(decimal)) - { - value = decimal.Parse(value.ToString(), Culture); - prop.SetValue(x, value, null); - } - else if (asType == typeof(Guid)) - { - var raw = value.ToString(); - - value = string.IsNullOrEmpty(raw) - ? Guid.Empty - : new Guid(value.ToString()); - - prop.SetValue(x, value, null); - } - else if (asType == typeof(TimeSpan)) - { - var timeSpan = XmlConvert.ToTimeSpan(value.ToString()); - - prop.SetValue(x, timeSpan, null); - } - else if (type.IsGenericType) - { - var t = type.GetGenericArguments()[0]; - var list = (IList) Activator.CreateInstance(asType); - var container = this.GetElementByName(root, name); - - if (container.HasElements) - { - var first = container.Elements().FirstOrDefault(); - - if (first != null) - { - var elements = container.Elements(first.Name); - - PopulateListFromElements(t, elements, list); - } - } - - prop.SetValue(x, list, null); - } - else if (asType.IsSubclassOfRawGeneric(typeof(List<>))) - { - // handles classes that derive from List - // e.g. a collection that also has attributes - var list = HandleListDerivative(root, prop.Name, asType); - - prop.SetValue(x, list, null); - } - else - { - //fallback to type converters if possible - - if (TryGetFromString(value.ToString(), out var result, asType)) - { - prop.SetValue(x, result, null); - } - else - { - // nested property classes - if (root == null) continue; - var element = GetElementByName(root, name); - - if (element == null) continue; - - var item = CreateAndMap(asType, element); - - prop.SetValue(x, item, null); - } - } - } - - return x; - } - - private static bool TryGetFromString(string inputString, out object result, Type type) - { - var converter = TypeDescriptor.GetConverter(type); - - if (converter.CanConvertFrom(typeof(string))) - { - result = converter.ConvertFromInvariantString(inputString); - - return true; - } - - result = null; - - return false; - } - - private void PopulateListFromElements(Type t, IEnumerable elements, IList list) - { - foreach (var item in elements.Select(element => CreateAndMap(t, element))) - list.Add(item); - } - - private object HandleListDerivative(XElement root, string propName, Type type) - { - var t = type.IsGenericType - ? type.GetGenericArguments()[0] - : type.BaseType.GetGenericArguments()[0]; - - var list = (IList) Activator.CreateInstance(type); - IList elements = root.Descendants(t.Name.AsNamespaced(Namespace)) - .ToList(); - var name = t.Name; - var attribute = t.GetAttribute(); - - if (attribute != null) - name = attribute.Name; - - if (!elements.Any()) - { - var lowerName = name.ToLower().AsNamespaced(Namespace); - - elements = root.Descendants(lowerName).ToList(); - } - - if (!elements.Any()) - { - var camelName = name.ToCamelCase(Culture).AsNamespaced(Namespace); - - elements = root.Descendants(camelName).ToList(); - } - - if (!elements.Any()) - elements = root.Descendants() - .Where(e => e.Name.LocalName.RemoveUnderscoresAndDashes() == name) - .ToList(); - - if (!elements.Any()) - { - var lowerName = name.ToLower().AsNamespaced(Namespace); - - elements = root.Descendants() - .Where(e => e.Name.LocalName.RemoveUnderscoresAndDashes() == lowerName) - .ToList(); - } - - PopulateListFromElements(t, elements, list); - - // get properties too, not just list items - // only if this isn't a generic type - if (!type.IsGenericType) - Map(list, root.Element(propName.AsNamespaced(Namespace)) ?? root); - - return list; - } - - protected virtual object CreateAndMap(Type t, XElement element) - { - object item; - - if (t == typeof(string)) - { - item = element.Value; - } - else if (t.GetTypeInfo().IsPrimitive) - { - item = element.Value.ChangeType(t, Culture); - } - else - { - item = Activator.CreateInstance(t); - Map(item, element); - } - - return item; - } - - protected virtual object GetValueFromXml(XElement root, XName name, PropertyInfo prop) - { - object val = null; - if (root == null) return val; - - var element = GetElementByName(root, name); - - if (element == null) - { - var attribute = GetAttributeByName(root, name); - - if (attribute != null) - val = attribute.Value; - } - else - { - if (!element.IsEmpty || element.HasElements || element.HasAttributes) - val = element.Value; - } - - return val; - } - - protected virtual XElement GetElementByName(XElement root, XName name) - { - var lowerName = name.LocalName.ToLower().AsNamespaced(name.NamespaceName); - var camelName = name.LocalName.ToCamelCase(Culture).AsNamespaced(name.NamespaceName); - - if (root.Element(name) != null) - return root.Element(name); - - if (root.Element(lowerName) != null) - return root.Element(lowerName); - - if (root.Element(camelName) != null) - return root.Element(camelName); - - if (name == "Value".AsNamespaced(name.NamespaceName) && - (!root.HasAttributes || root.Attributes().All(x => x.Name != name))) - return root; - - // try looking for element that matches sanitized property name (Order by depth) - return root.Descendants() - .OrderBy(d => d.Ancestors().Count()) - .FirstOrDefault(d => d.Name.LocalName.RemoveUnderscoresAndDashes() == name.LocalName) ?? - root.Descendants() - .OrderBy(d => d.Ancestors().Count()) - .FirstOrDefault(d => d.Name.LocalName.RemoveUnderscoresAndDashes() == name.LocalName.ToLower()); - } - - protected virtual XAttribute GetAttributeByName(XElement root, XName name) - { - var names = new List - { - name.LocalName, - name.LocalName.ToLower() - .AsNamespaced(name.NamespaceName), - name.LocalName.ToCamelCase(Culture) - .AsNamespaced(name.NamespaceName) - }; - - return root.DescendantsAndSelf() - .OrderBy(d => d.Ancestors().Count()) - .Attributes() - .FirstOrDefault(d => names.Contains(d.Name.LocalName.RemoveUnderscoresAndDashes())); - } - } -} \ No newline at end of file diff --git a/RestSharp/Enum.cs b/RestSharp/Enum.cs deleted file mode 100644 index 5ff6ad02a..000000000 --- a/RestSharp/Enum.cs +++ /dev/null @@ -1,83 +0,0 @@ -#region License -// Copyright 2010 John Sheehan -// -// Licensed under the Apache License, Version 2.0 (the "License"); -// you may not use this file except in compliance with the License. -// You may obtain a copy of the License at -// -// http://www.apache.org/licenses/LICENSE-2.0 -// -// Unless required by applicable law or agreed to in writing, software -// distributed under the License is distributed on an "AS IS" BASIS, -// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -// See the License for the specific language governing permissions and -// limitations under the License. -#endregion - -namespace RestSharp -{ - /// - /// Types of parameters that can be added to requests - /// - public enum ParameterType - { - Cookie, - GetOrPost, - UrlSegment, - HttpHeader, - RequestBody, - QueryString - } - - /// - /// Data formats - /// - public enum DataFormat - { - Json, - Xml - } - - /// - /// HTTP method to use when making requests - /// - public enum Method - { - GET, - POST, - PUT, - DELETE, - HEAD, - OPTIONS, - PATCH, - MERGE, - } - - /// - /// Format strings for commonly-used date formats - /// - public struct DateFormat - { - /// - /// .NET format string for ISO 8601 date format - /// - public const string ISO_8601 = "s"; - - /// - /// .NET format string for roundtrip date format - /// - public const string ROUND_TRIP = "u"; - } - - /// - /// Status for responses (surprised?) - /// - public enum ResponseStatus - { - None, - Completed, - Error, - TimedOut, - Aborted - } -} diff --git a/RestSharp/Extensions/MiscExtensions.cs b/RestSharp/Extensions/MiscExtensions.cs deleted file mode 100644 index 254a1d7ee..000000000 --- a/RestSharp/Extensions/MiscExtensions.cs +++ /dev/null @@ -1,96 +0,0 @@ -#region License - -// Copyright 2010 John Sheehan -// -// Licensed under the Apache License, Version 2.0 (the "License"); -// you may not use this file except in compliance with the License. -// You may obtain a copy of the License at -// -// http://www.apache.org/licenses/LICENSE-2.0 -// -// Unless required by applicable law or agreed to in writing, software -// distributed under the License is distributed on an "AS IS" BASIS, -// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -// See the License for the specific language governing permissions and -// limitations under the License. - -#endregion - -using System.IO; -using System.Text; - -namespace RestSharp.Extensions -{ - /// - /// Extension method overload! - /// - public static class MiscExtensions - { - /// - /// Save a byte array to a file - /// - /// Bytes to save - /// Full path to save file to - public static void SaveAs(this byte[] input, string path) - { - File.WriteAllBytes(path, input); - } - - /// - /// Read a stream into a byte array - /// - /// Stream to read - /// byte[] - public static byte[] ReadAsBytes(this Stream input) - { - var buffer = new byte[16 * 1024]; - - using (var ms = new MemoryStream()) - { - int read; - - while ((read = input.Read(buffer, 0, buffer.Length)) > 0) - ms.Write(buffer, 0, read); - - return ms.ToArray(); - } - } - - /// - /// Copies bytes from one stream to another - /// - /// The input stream. - /// The output stream. - public static void CopyTo(this Stream input, Stream output) - { - var buffer = new byte[32768]; - - while (true) - { - var read = input.Read(buffer, 0, buffer.Length); - - if (read <= 0) - return; - - output.Write(buffer, 0, read); - } - } - - /// - /// Converts a byte array to a string, using its byte order mark to convert it to the right encoding. - /// http://www.shrinkrays.net/code-snippets/csharp/an-extension-method-for-converting-a-byte-array-to-a-string.aspx - /// - /// An array of bytes to convert - /// The byte as a string. - public static string AsString(this byte[] buffer) - { - if (buffer == null) - return ""; - - // Ansi as default - var encoding = Encoding.UTF8; - - return encoding.GetString(buffer, 0, buffer.Length); - } - } -} \ No newline at end of file diff --git a/RestSharp/Extensions/ReflectionExtensions.cs b/RestSharp/Extensions/ReflectionExtensions.cs deleted file mode 100644 index 391eda813..000000000 --- a/RestSharp/Extensions/ReflectionExtensions.cs +++ /dev/null @@ -1,115 +0,0 @@ -#region License - -// Copyright 2010 John Sheehan -// -// Licensed under the Apache License, Version 2.0 (the "License"); -// you may not use this file except in compliance with the License. -// You may obtain a copy of the License at -// -// http://www.apache.org/licenses/LICENSE-2.0 -// -// Unless required by applicable law or agreed to in writing, software -// distributed under the License is distributed on an "AS IS" BASIS, -// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -// See the License for the specific language governing permissions and -// limitations under the License. - -#endregion - -using System; -using System.Globalization; -using System.Linq; -using System.Reflection; - -namespace RestSharp.Extensions -{ - /// - /// Reflection extensions - /// - public static class ReflectionExtensions - { - /// - /// Retrieve an attribute from a member (property) - /// - /// Type of attribute to retrieve - /// Member to retrieve attribute from - /// - public static T GetAttribute(this MemberInfo prop) where T : Attribute - { - return Attribute.GetCustomAttribute(prop, typeof(T)) as T; - } - - /// - /// Retrieve an attribute from a type - /// - /// Type of attribute to retrieve - /// Type to retrieve attribute from - /// - public static T GetAttribute(this Type type) where T : Attribute - { - return Attribute.GetCustomAttribute(type, typeof(T)) as T; - } - - /// - /// Checks a type to see if it derives from a raw generic (e.g. List[[]]) - /// - /// - /// - /// - public static bool IsSubclassOfRawGeneric(this Type toCheck, Type generic) - { - while (toCheck != null && toCheck != typeof(object)) - { - Type cur = toCheck.GetTypeInfo().IsGenericType - ? toCheck.GetGenericTypeDefinition() - : toCheck; - - if (generic == cur) - { - return true; - } - toCheck = toCheck.GetTypeInfo().BaseType; - } - - return false; - } - - public static object ChangeType(this object source, TypeInfo newType) - { - return Convert.ChangeType(source, newType.AsType()); - } - - public static object ChangeType(this object source, Type newType, CultureInfo culture) - { - return Convert.ChangeType(source, newType); - } - - /// - /// Find a value from a System.Enum by trying several possible variants - /// of the string value of the enum. - /// - /// Type of enum - /// Value for which to search - /// The culture used to calculate the name variants - /// - public static object FindEnumValue(this Type type, string value, CultureInfo culture) - { - Enum ret = Enum.GetValues(type) - .Cast() - .FirstOrDefault(v => v.ToString() - .GetNameVariants(culture) - .Contains(value, StringComparer.Create(culture, true))); - - if (ret != null) return ret; - - object enumValueAsUnderlyingType = Convert.ChangeType(value, Enum.GetUnderlyingType(type), culture); - - if (enumValueAsUnderlyingType != null && Enum.IsDefined(type, enumValueAsUnderlyingType)) - { - ret = (Enum) Enum.ToObject(type, enumValueAsUnderlyingType); - } - - return ret; - } - } -} \ No newline at end of file diff --git a/RestSharp/Extensions/ResponseExtensions.cs b/RestSharp/Extensions/ResponseExtensions.cs deleted file mode 100644 index ed747cccb..000000000 --- a/RestSharp/Extensions/ResponseExtensions.cs +++ /dev/null @@ -1,25 +0,0 @@ -namespace RestSharp.Extensions -{ - public static class ResponseExtensions - { - public static IRestResponse ToAsyncResponse(this IRestResponse response) - { - return new RestResponse - { - ContentEncoding = response.ContentEncoding, - ContentLength = response.ContentLength, - ContentType = response.ContentType, - Cookies = response.Cookies, - ErrorException = response.ErrorException, - ErrorMessage = response.ErrorMessage, - Headers = response.Headers, - RawBytes = response.RawBytes, - ResponseStatus = response.ResponseStatus, - ResponseUri = response.ResponseUri, - Server = response.Server, - StatusCode = response.StatusCode, - StatusDescription = response.StatusDescription - }; - } - } -} diff --git a/RestSharp/Extensions/ResponseStatusExtensions.cs b/RestSharp/Extensions/ResponseStatusExtensions.cs deleted file mode 100644 index d89baa401..000000000 --- a/RestSharp/Extensions/ResponseStatusExtensions.cs +++ /dev/null @@ -1,43 +0,0 @@ -using System; -using System.Net; - -namespace RestSharp.Extensions -{ - public static class ResponseStatusExtensions - { - /// - /// Convert a to a instance. - /// - /// The response status. - /// - /// responseStatus - public static WebException ToWebException(this ResponseStatus responseStatus) - { - switch (responseStatus) - { - case ResponseStatus.None: - return new WebException("The request could not be processed.", - WebExceptionStatus.ServerProtocolViolation - ); - - case ResponseStatus.Error: - return new WebException("An error occurred while processing the request.", - WebExceptionStatus.ServerProtocolViolation - ); - - case ResponseStatus.TimedOut: - return new WebException("The request timed-out.", - WebExceptionStatus.Timeout - ); - - case ResponseStatus.Aborted: - return new WebException("The request was aborted.", - WebExceptionStatus.Timeout - ); - - default: - throw new ArgumentOutOfRangeException(nameof(responseStatus)); - } - } - } -} \ No newline at end of file diff --git a/RestSharp/Extensions/StringExtensions.cs b/RestSharp/Extensions/StringExtensions.cs deleted file mode 100644 index 9f5c2c97a..000000000 --- a/RestSharp/Extensions/StringExtensions.cs +++ /dev/null @@ -1,395 +0,0 @@ -#region License - -// Copyright 2010 John Sheehan -// -// Licensed under the Apache License, Version 2.0 (the "License"); -// you may not use this file except in compliance with the License. -// You may obtain a copy of the License at -// -// http://www.apache.org/licenses/LICENSE-2.0 -// -// Unless required by applicable law or agreed to in writing, software -// distributed under the License is distributed on an "AS IS" BASIS, -// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -// See the License for the specific language governing permissions and -// limitations under the License. - -#endregion - -using System; -using System.Collections.Generic; -using System.Globalization; -using System.Text; -using System.Text.RegularExpressions; -using System.Web; - -namespace RestSharp.Extensions -{ - public static class StringExtensions - { - public static string UrlDecode(this string input) - { - return HttpUtility.UrlDecode(input); - } - - /// - /// Uses Uri.EscapeDataString() based on recommendations on MSDN - /// http://blogs.msdn.com/b/yangxind/archive/2006/11/09/don-t-use-net-system-uri-unescapedatastring-in-url-decoding.aspx - /// - public static string UrlEncode(this string input) - { - const int maxLength = 32766; - - if (input == null) - throw new ArgumentNullException("input"); - - if (input.Length <= maxLength) - return Uri.EscapeDataString(input); - - var sb = new StringBuilder(input.Length * 2); - var index = 0; - - while (index < input.Length) - { - var length = Math.Min(input.Length - index, maxLength); - var subString = input.Substring(index, length); - - sb.Append(Uri.EscapeDataString(subString)); - index += subString.Length; - } - - return sb.ToString(); - } - - public static string HtmlDecode(this string input) - { - return HttpUtility.HtmlDecode(input); - } - - public static string HtmlEncode(this string input) - { - return HttpUtility.HtmlEncode(input); - } - - public static string HtmlAttributeEncode(this string input) - { - return HttpUtility.HtmlAttributeEncode(input); - } - - /// - /// Check that a string is not null or empty - /// - /// String to check - /// bool - public static bool HasValue(this string input) - { - return !string.IsNullOrEmpty(input); - } - - /// - /// Remove underscores from a string - /// - /// String to process - /// string - public static string RemoveUnderscoresAndDashes(this string input) - { - return input.Replace("_", "") - .Replace("-", ""); // avoiding regex - } - - /// - /// Parses most common JSON date formats - /// - /// JSON value to parse - /// - /// DateTime - public static DateTime ParseJsonDate(this string input, CultureInfo culture) - { - const long maxAllowedTimestamp = 253402300799; - - input = input.Replace("\n", ""); - input = input.Replace("\r", ""); - input = input.RemoveSurroundingQuotes(); - - long unix; - - if (long.TryParse(input, out unix)) - { - var epoch = new DateTime(1970, 1, 1, 0, 0, 0, DateTimeKind.Utc); - - if (unix > maxAllowedTimestamp) - return epoch.AddMilliseconds(unix); - return epoch.AddSeconds(unix); - } - - if (input.Contains("/Date(")) - return ExtractDate(input, @"\\?/Date\((-?\d+)(-|\+)?([0-9]{4})?\)\\?/", culture); - - if (input.Contains("new Date(")) - { - input = input.Replace(" ", ""); - - // because all whitespace is removed, match against newDate( instead of new Date( - return ExtractDate(input, @"newDate\((-?\d+)*\)", culture); - } - - return ParseFormattedDate(input, culture); - } - - /// - /// Remove leading and trailing " from a string - /// - /// String to parse - /// String - public static string RemoveSurroundingQuotes(this string input) - { - if (input.StartsWith("\"") && input.EndsWith("\"")) - input = input.Substring(1, input.Length - 2); - - return input; - } - - private static DateTime ParseFormattedDate(string input, CultureInfo culture) - { - string[] formats = - { - "u", - "s", - "yyyy'-'MM'-'dd'T'HH':'mm':'ss'Z'", - "yyyy-MM-ddTHH:mm:ssZ", - "yyyy-MM-dd HH:mm:ssZ", - "yyyy-MM-ddTHH:mm:ss", - "yyyy-MM-ddTHH:mm:sszzzzzz", - "M/d/yyyy h:mm:ss tt" // default format for invariant culture - }; - - if (DateTime.TryParseExact(input, formats, culture, - DateTimeStyles.AssumeUniversal | DateTimeStyles.AdjustToUniversal, out var date)) - return date; - - return DateTime.TryParse(input, culture, DateTimeStyles.None, out date) ? date : default(DateTime); - } - - private static DateTime ExtractDate(string input, string pattern, CultureInfo culture) - { - var dt = DateTime.MinValue; - var regex = new Regex(pattern); - - if (regex.IsMatch(input)) - { - var matches = regex.Matches(input); - var match = matches[0]; - var ms = Convert.ToInt64(match.Groups[1].Value); - var epoch = new DateTime(1970, 1, 1, 0, 0, 0, DateTimeKind.Utc); - - dt = epoch.AddMilliseconds(ms); - - // adjust if time zone modifier present - if (match.Groups.Count <= 2 || string.IsNullOrEmpty(match.Groups[3].Value)) return dt; - - var mod = DateTime.ParseExact(match.Groups[3].Value, "HHmm", culture); - - dt = match.Groups[2].Value == "+" - ? dt.Add(mod.TimeOfDay) - : dt.Subtract(mod.TimeOfDay); - } - - return dt; - } - - /// - /// Checks a string to see if it matches a regex - /// - /// String to check - /// Pattern to match - /// bool - public static bool Matches(this string input, string pattern) - { - return Regex.IsMatch(input, pattern); - } - - /// - /// Converts a string to pascal case - /// - /// String to convert - /// - /// string - public static string ToPascalCase(this string lowercaseAndUnderscoredWord, CultureInfo culture) - { - return ToPascalCase(lowercaseAndUnderscoredWord, true, culture); - } - - /// - /// Converts a string to pascal case with the option to remove underscores - /// - /// String to convert - /// Option to remove underscores - /// - /// - public static string ToPascalCase(this string text, bool removeUnderscores, CultureInfo culture) - { - if (string.IsNullOrEmpty(text)) - return text; - - text = text.Replace("_", " "); - - var joinString = removeUnderscores - ? string.Empty - : "_"; - var words = text.Split(' '); - - if (words.Length <= 1 && !words[0].IsUpperCase()) - return string.Concat(words[0].Substring(0, 1).ToUpper(culture), words[0].Substring(1)); - - for (var i = 0; i < words.Length; i++) - { - if (words[i].Length <= 0) continue; - - var word = words[i]; - var restOfWord = word.Substring(1); - - if (restOfWord.IsUpperCase()) - restOfWord = restOfWord.ToLower(culture); - - var firstChar = char.ToUpper(word[0], culture); - - words[i] = string.Concat(firstChar, restOfWord); - } - - return string.Join(joinString, words); - } - - /// - /// Converts a string to camel case - /// - /// String to convert - /// - /// String - public static string ToCamelCase(this string lowercaseAndUnderscoredWord, CultureInfo culture) - { - return MakeInitialLowerCase(ToPascalCase(lowercaseAndUnderscoredWord, culture)); - } - - /// - /// Convert the first letter of a string to lower case - /// - /// String to convert - /// string - public static string MakeInitialLowerCase(this string word) - { - return string.Concat(word.Substring(0, 1).ToLower(), word.Substring(1)); - } - - /// - /// Checks to see if a string is all uppper case - /// - /// String to check - /// bool - public static bool IsUpperCase(this string inputString) - { - return Regex.IsMatch(inputString, @"^[A-Z]+$"); - } - - /// - /// Add underscores to a pascal-cased string - /// - /// String to convert - /// string - public static string AddUnderscores(this string pascalCasedWord) - { - return Regex.Replace( - Regex.Replace( - Regex.Replace(pascalCasedWord, @"([A-Z]+)([A-Z][a-z])", "$1_$2"), - @"([a-z\d])([A-Z])", - "$1_$2"), - @"[-\s]", - "_"); - } - - /// - /// Add dashes to a pascal-cased string - /// - /// String to convert - /// string - public static string AddDashes(this string pascalCasedWord) - { - return Regex.Replace( - Regex.Replace( - Regex.Replace(pascalCasedWord, @"([A-Z]+)([A-Z][a-z])", "$1-$2"), - @"([a-z\d])([A-Z])", - "$1-$2"), - @"[\s]", - "-"); - } - - /// - /// Add an undescore prefix to a pascasl-cased string - /// - /// - /// - public static string AddUnderscorePrefix(this string pascalCasedWord) - { - return string.Format("_{0}", pascalCasedWord); - } - - /// - /// Add spaces to a pascal-cased string - /// - /// String to convert - /// string - public static string AddSpaces(this string pascalCasedWord) - { - return Regex.Replace( - Regex.Replace( - Regex.Replace(pascalCasedWord, @"([A-Z]+)([A-Z][a-z])", "$1 $2"), - @"([a-z\d])([A-Z])", - "$1 $2"), - @"[-\s]", - " "); - } - - /// - /// Return possible variants of a name for name matching. - /// - /// String to convert - /// The culture to use for conversion - /// IEnumerable<string> - public static IEnumerable GetNameVariants(this string name, CultureInfo culture) - { - if (string.IsNullOrEmpty(name)) - yield break; - - yield return name; - - // try camel cased name - yield return name.ToCamelCase(culture); - - // try lower cased name - yield return name.ToLower(culture); - - // try name with underscores - yield return name.AddUnderscores(); - - // try name with underscores with lower case - yield return name.AddUnderscores().ToLower(culture); - - // try name with dashes - yield return name.AddDashes(); - - // try name with dashes with lower case - yield return name.AddDashes().ToLower(culture); - - // try name with underscore prefix - yield return name.AddUnderscorePrefix(); - - // try name with underscore prefix, using camel case - yield return name.ToCamelCase(culture).AddUnderscorePrefix(); - - // try name with spaces - yield return name.AddSpaces(); - - // try name with spaces with lower case - yield return name.AddSpaces().ToLower(culture); - } - } -} \ No newline at end of file diff --git a/RestSharp/Extensions/XmlExtensions.cs b/RestSharp/Extensions/XmlExtensions.cs deleted file mode 100644 index b515d445c..000000000 --- a/RestSharp/Extensions/XmlExtensions.cs +++ /dev/null @@ -1,46 +0,0 @@ -#region License - -// Copyright 2010 John Sheehan -// -// Licensed under the Apache License, Version 2.0 (the "License"); -// you may not use this file except in compliance with the License. -// You may obtain a copy of the License at -// -// http://www.apache.org/licenses/LICENSE-2.0 -// -// Unless required by applicable law or agreed to in writing, software -// distributed under the License is distributed on an "AS IS" BASIS, -// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -// See the License for the specific language governing permissions and -// limitations under the License. - -#endregion - -using System.Xml.Linq; - -namespace RestSharp.Extensions -{ - /// - /// XML Extension Methods - /// - public static class XmlExtensions - { - /// - /// Returns the name of an element with the namespace if specified - /// - /// Element name - /// XML Namespace - /// - public static XName AsNamespaced(this string name, string @namespace) - { - XName xName = name; - - if (@namespace.HasValue()) - { - xName = XName.Get(name, @namespace); - } - - return xName; - } - } -} diff --git a/RestSharp/FileParameter.cs b/RestSharp/FileParameter.cs deleted file mode 100644 index 51fdfe3c7..000000000 --- a/RestSharp/FileParameter.cs +++ /dev/null @@ -1,74 +0,0 @@ -using System; -using System.IO; - -namespace RestSharp -{ - /// - /// Container for files to be uploaded with requests - /// - public class FileParameter - { - /// - /// Creates a file parameter from an array of bytes. - /// - ///The parameter name to use in the request. - ///The data to use as the file's contents. - ///The filename to use in the request. - ///The content type to use in the request. - ///The - public static FileParameter Create(string name, byte[] data, string filename, string contentType) - { -#if FRAMEWORK - long length = data.LongLength; -#else - long length = data.Length; -#endif - - return new FileParameter - { - Writer = s => s.Write(data, 0, data.Length), - FileName = filename, - ContentType = contentType, - ContentLength = length, - Name = name - }; - } - - /// - /// Creates a file parameter from an array of bytes. - /// - ///The parameter name to use in the request. - ///The data to use as the file's contents. - ///The filename to use in the request. - ///The using the default content type. - public static FileParameter Create(string name, byte[] data, string filename) - { - return Create(name, data, filename, null); - } - - /// - /// The length of data to be sent - /// - public long ContentLength { get; set; } - - /// - /// Provides raw data for file - /// - public Action Writer { get; set; } - - /// - /// Name of the file to use when uploading - /// - public string FileName { get; set; } - - /// - /// MIME content type of file - /// - public string ContentType { get; set; } - - /// - /// Name of the parameter - /// - public string Name { get; set; } - } -} diff --git a/RestSharp/Http.Async.cs b/RestSharp/Http.Async.cs deleted file mode 100644 index d6517d9b9..000000000 --- a/RestSharp/Http.Async.cs +++ /dev/null @@ -1,408 +0,0 @@ -#region License - -// Copyright 2010 John Sheehan -// -// Licensed under the Apache License, Version 2.0 (the "License"); -// you may not use this file except in compliance with the License. -// You may obtain a copy of the License at -// -// http://www.apache.org/licenses/LICENSE-2.0 -// -// Unless required by applicable law or agreed to in writing, software -// distributed under the License is distributed on an "AS IS" BASIS, -// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -// See the License for the specific language governing permissions and -// limitations under the License. - -#endregion - -using System; -using System.Linq; -using System.Net; -using System.Threading; -using RestSharp.Extensions; - -namespace RestSharp -{ - /// - /// HttpWebRequest wrapper (async methods) - /// - public partial class Http - { - private TimeOutState timeoutState; - - public HttpWebRequest DeleteAsync(Action action) - { - return GetStyleMethodInternalAsync("DELETE", action); - } - - public HttpWebRequest GetAsync(Action action) - { - return GetStyleMethodInternalAsync("GET", action); - } - - public HttpWebRequest HeadAsync(Action action) - { - return GetStyleMethodInternalAsync("HEAD", action); - } - - public HttpWebRequest OptionsAsync(Action action) - { - return GetStyleMethodInternalAsync("OPTIONS", action); - } - - public HttpWebRequest PostAsync(Action action) - { - return PutPostInternalAsync("POST", action); - } - - public HttpWebRequest PutAsync(Action action) - { - return PutPostInternalAsync("PUT", action); - } - - public HttpWebRequest PatchAsync(Action action) - { - return PutPostInternalAsync("PATCH", action); - } - - public HttpWebRequest MergeAsync(Action action) - { - return PutPostInternalAsync("MERGE", action); - } - - /// - /// Execute an async POST-style request with the specified HTTP Method. - /// - /// - /// The HTTP method to execute. - /// - public HttpWebRequest AsPostAsync(Action action, string httpMethod) - { - return PutPostInternalAsync(httpMethod.ToUpperInvariant(), action); - } - - /// - /// Execute an async GET-style request with the specified HTTP Method. - /// - /// - /// The HTTP method to execute. - /// - public HttpWebRequest AsGetAsync(Action action, string httpMethod) - { - return GetStyleMethodInternalAsync(httpMethod.ToUpperInvariant(), action); - } - - private HttpWebRequest GetStyleMethodInternalAsync(string method, Action callback) - { - HttpWebRequest webRequest = null; - - try - { - var url = Url; - - webRequest = ConfigureAsyncWebRequest(method, url); - - if (HasBody && (method == "DELETE" || method == "OPTIONS")) - { - webRequest.ContentType = RequestContentType; - WriteRequestBodyAsync(webRequest, callback); - } - else - { - timeoutState = new TimeOutState {Request = webRequest}; - - var asyncResult = webRequest.BeginGetResponse( - result => ResponseCallback(result, callback), webRequest); - - SetTimeout(asyncResult, timeoutState); - } - } - catch (Exception ex) - { - ExecuteCallback(CreateErrorResponse(ex), callback); - } - - return webRequest; - } - - private HttpResponse CreateErrorResponse(Exception ex) - { - var response = new HttpResponse(); - - if (ex is WebException webException && webException.Status == WebExceptionStatus.RequestCanceled) - { - response.ResponseStatus = timeoutState.TimedOut - ? ResponseStatus.TimedOut - : ResponseStatus.Aborted; - - return response; - } - - response.ErrorMessage = ex.Message; - response.ErrorException = ex; - response.ResponseStatus = ResponseStatus.Error; - - return response; - } - - private HttpWebRequest PutPostInternalAsync(string method, Action callback) - { - HttpWebRequest webRequest = null; - - try - { - webRequest = ConfigureAsyncWebRequest(method, Url); - PreparePostBody(webRequest); - WriteRequestBodyAsync(webRequest, callback); - } - catch (Exception ex) - { - ExecuteCallback(CreateErrorResponse(ex), callback); - } - - return webRequest; - } - - private void WriteRequestBodyAsync(HttpWebRequest webRequest, Action callback) - { - IAsyncResult asyncResult; - timeoutState = new TimeOutState {Request = webRequest}; - - if (HasBody || HasFiles || AlwaysMultipartFormData) - { - webRequest.ContentLength = CalculateContentLength(); - asyncResult = webRequest.BeginGetRequestStream( - result => RequestStreamCallback(result, callback), webRequest); - } - else - { - asyncResult = webRequest.BeginGetResponse(r => ResponseCallback(r, callback), webRequest); - } - - SetTimeout(asyncResult, timeoutState); - } - - private long CalculateContentLength() - { - if (RequestBodyBytes != null) - return RequestBodyBytes.Length; - - if (!HasFiles && !AlwaysMultipartFormData) - return Encoding.GetByteCount(RequestBody); - - // calculate length for multipart form - long length = 0; - - foreach (var file in Files) - { - length += Encoding.GetByteCount(GetMultipartFileHeader(file)); - length += file.ContentLength; - length += Encoding.GetByteCount(LINE_BREAK); - } - - length = Parameters.Aggregate(length, - (current, param) => current + Encoding.GetByteCount(GetMultipartFormData(param))); - - length += Encoding.GetByteCount(GetMultipartFooter()); - - return length; - } - - private void RequestStreamCallback(IAsyncResult result, Action callback) - { - var webRequest = (HttpWebRequest) result.AsyncState; - - if (timeoutState.TimedOut) - { - var response = new HttpResponse {ResponseStatus = ResponseStatus.TimedOut}; - - ExecuteCallback(response, callback); - - return; - } - - // write body to request stream - try - { - using (var requestStream = webRequest.EndGetRequestStream(result)) - { - if (HasFiles || AlwaysMultipartFormData) - WriteMultipartFormData(requestStream); - else if (RequestBodyBytes != null) - requestStream.Write(RequestBodyBytes, 0, RequestBodyBytes.Length); - else if (RequestBody != null) - WriteStringTo(requestStream, RequestBody); - } - } - catch (Exception ex) - { - ExecuteCallback(CreateErrorResponse(ex), callback); - - return; - } - - var asyncResult = webRequest.BeginGetResponse(r => ResponseCallback(r, callback), webRequest); - - SetTimeout(asyncResult, timeoutState); - } - - private void SetTimeout(IAsyncResult asyncResult, TimeOutState timeOutState) - { - if (Timeout != 0) - ThreadPool.RegisterWaitForSingleObject(asyncResult.AsyncWaitHandle, - TimeoutCallback, timeOutState, Timeout, true); - } - - private static void TimeoutCallback(object state, bool timedOut) - { - if (!timedOut) - return; - - if (!(state is TimeOutState timeoutState)) - return; - - lock (timeoutState) - { - timeoutState.TimedOut = true; - } - - timeoutState.Request?.Abort(); - } - - private static void GetRawResponseAsync(IAsyncResult result, Action callback) - { - HttpWebResponse raw; - - try - { - var webRequest = (HttpWebRequest) result.AsyncState; - - raw = webRequest.EndGetResponse(result) as HttpWebResponse; - } - catch (WebException ex) - { - if (ex.Status == WebExceptionStatus.RequestCanceled) - throw; - - // Check to see if this is an HTTP error or a transport error. - // In cases where an HTTP error occurs ( status code >= 400 ) - // return the underlying HTTP response, otherwise assume a - // transport exception (ex: connection timeout) and - // rethrow the exception - - if (ex.Response is HttpWebResponse response) - raw = response; - else - throw; - } - - callback(raw); - - raw?.Close(); - } - - private void ResponseCallback(IAsyncResult result, Action callback) - { - var response = new HttpResponse {ResponseStatus = ResponseStatus.None}; - - try - { - if (timeoutState.TimedOut) - { - response.ResponseStatus = ResponseStatus.TimedOut; - ExecuteCallback(response, callback); - - return; - } - - GetRawResponseAsync(result, webResponse => - { - ExtractResponseData(response, webResponse); - ExecuteCallback(response, callback); - }); - } - catch (Exception ex) - { - ExecuteCallback(CreateErrorResponse(ex), callback); - } - } - - private static void ExecuteCallback(HttpResponse response, Action callback) - { - PopulateErrorForIncompleteResponse(response); - callback(response); - } - - private static void PopulateErrorForIncompleteResponse(HttpResponse response) - { - if (response.ResponseStatus != ResponseStatus.Completed && response.ErrorException == null) - { - response.ErrorException = response.ResponseStatus.ToWebException(); - response.ErrorMessage = response.ErrorException.Message; - } - } - - // TODO: Try to merge the shared parts between ConfigureWebRequest and ConfigureAsyncWebRequest (quite a bit of code - // TODO: duplication at the moment). - private HttpWebRequest ConfigureAsyncWebRequest(string method, Uri url) - { - var webRequest = (HttpWebRequest) WebRequest.Create(url); - - webRequest.UseDefaultCredentials = UseDefaultCredentials; - - webRequest.PreAuthenticate = PreAuthenticate; - webRequest.Pipelined = Pipelined; - - AppendHeaders(webRequest); - AppendCookies(webRequest); - - webRequest.Method = method; - - // make sure Content-Length header is always sent since default is -1 - // WP7 doesn't as of Beta doesn't support a way to set this value either directly - // or indirectly - if (!HasFiles && !AlwaysMultipartFormData) - webRequest.ContentLength = 0; - - if (Credentials != null) - webRequest.Credentials = Credentials; - - if (UserAgent.HasValue()) - webRequest.UserAgent = UserAgent; - - if (ClientCertificates != null) - webRequest.ClientCertificates.AddRange(ClientCertificates); - - webRequest.AutomaticDecompression = - DecompressionMethods.Deflate | DecompressionMethods.GZip | DecompressionMethods.None; - - webRequest.ServicePoint.Expect100Continue = false; - - if (Timeout != 0) - webRequest.Timeout = Timeout; - - if (ReadWriteTimeout != 0) - webRequest.ReadWriteTimeout = ReadWriteTimeout; - - webRequest.Proxy = Proxy; - - if (CachePolicy != null) - webRequest.CachePolicy = CachePolicy; - - if (FollowRedirects && MaxRedirects.HasValue) - webRequest.MaximumAutomaticRedirections = MaxRedirects.Value; - - webRequest.AllowAutoRedirect = FollowRedirects; - webRequest.ServerCertificateValidationCallback = RemoteCertificateValidationCallback; - return webRequest; - } - - private class TimeOutState - { - public bool TimedOut { get; set; } - - public HttpWebRequest Request { get; set; } - } - } -} \ No newline at end of file diff --git a/RestSharp/Http.Sync.cs b/RestSharp/Http.Sync.cs deleted file mode 100644 index 482481698..000000000 --- a/RestSharp/Http.Sync.cs +++ /dev/null @@ -1,279 +0,0 @@ -#region License - -// Copyright 2010 John Sheehan -// -// Licensed under the Apache License, Version 2.0 (the "License"); -// you may not use this file except in compliance with the License. -// You may obtain a copy of the License at -// -// http://www.apache.org/licenses/LICENSE-2.0 -// -// Unless required by applicable law or agreed to in writing, software -// distributed under the License is distributed on an "AS IS" BASIS, -// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -// See the License for the specific language governing permissions and -// limitations under the License. - -#endregion - -using System; -using System.Net; -using RestSharp.Extensions; - -namespace RestSharp -{ - /// - /// HttpWebRequest wrapper (sync methods) - /// - public partial class Http - { - /// - /// Execute a POST request - /// - public HttpResponse Post() - { - return PostPutInternal("POST"); - } - - /// - /// Execute a PUT request - /// - public HttpResponse Put() - { - return PostPutInternal("PUT"); - } - - /// - /// Execute a GET request - /// - public HttpResponse Get() - { - return GetStyleMethodInternal("GET"); - } - - /// - /// Execute a HEAD request - /// - public HttpResponse Head() - { - return GetStyleMethodInternal("HEAD"); - } - - /// - /// Execute an OPTIONS request - /// - public HttpResponse Options() - { - return GetStyleMethodInternal("OPTIONS"); - } - - /// - /// Execute a DELETE request - /// - public HttpResponse Delete() - { - return GetStyleMethodInternal("DELETE"); - } - - /// - /// Execute a PATCH request - /// - public HttpResponse Patch() - { - return PostPutInternal("PATCH"); - } - - /// - /// Execute a MERGE request - /// - public HttpResponse Merge() - { - return PostPutInternal("MERGE"); - } - - /// - /// Execute a GET-style request with the specified HTTP Method. - /// - /// The HTTP method to execute. - /// - public HttpResponse AsGet(string httpMethod) - { - return GetStyleMethodInternal(httpMethod.ToUpperInvariant()); - } - - /// - /// Execute a POST-style request with the specified HTTP Method. - /// - /// The HTTP method to execute. - /// - public HttpResponse AsPost(string httpMethod) - { - return PostPutInternal(httpMethod.ToUpperInvariant()); - } - - private HttpResponse GetStyleMethodInternal(string method) - { - var webRequest = ConfigureWebRequest(method, Url); - - if (HasBody && (method == "DELETE" || method == "OPTIONS")) - { - webRequest.ContentType = RequestContentType; - WriteRequestBody(webRequest); - } - - return GetResponse(webRequest); - } - - private HttpResponse PostPutInternal(string method) - { - var webRequest = ConfigureWebRequest(method, Url); - - PreparePostBody(webRequest); - - WriteRequestBody(webRequest); - return GetResponse(webRequest); - } - - partial void AddSyncHeaderActions() - { - //this.restrictedHeaderActions.Add("Connection", (r, v) => r.Connection = v); - restrictedHeaderActions.Add("Connection", (r, v) => { r.KeepAlive = v.ToLower().Contains("keep-alive"); }); - restrictedHeaderActions.Add("Content-Length", (r, v) => r.ContentLength = Convert.ToInt64(v)); - restrictedHeaderActions.Add("Expect", (r, v) => r.Expect = v); - restrictedHeaderActions.Add("If-Modified-Since", (r, v) => r.IfModifiedSince = Convert.ToDateTime(v)); - restrictedHeaderActions.Add("Referer", (r, v) => r.Referer = v); - restrictedHeaderActions.Add("Transfer-Encoding", (r, v) => - { - r.TransferEncoding = v; - r.SendChunked = true; - }); - restrictedHeaderActions.Add("User-Agent", (r, v) => r.UserAgent = v); - } - - private void ExtractErrorResponse(HttpResponse httpResponse, Exception ex) - { - if (ex is WebException webException && webException.Status == WebExceptionStatus.Timeout) - { - httpResponse.ResponseStatus = ResponseStatus.TimedOut; - httpResponse.ErrorMessage = ex.Message; - httpResponse.ErrorException = webException; - - return; - } - - httpResponse.ErrorMessage = ex.Message; - httpResponse.ErrorException = ex; - httpResponse.ResponseStatus = ResponseStatus.Error; - } - - private HttpResponse GetResponse(HttpWebRequest request) - { - var response = new HttpResponse {ResponseStatus = ResponseStatus.None}; - - try - { - var webResponse = GetRawResponse(request); - - ExtractResponseData(response, webResponse); - } - catch (Exception ex) - { - ExtractErrorResponse(response, ex); - } - - return response; - } - - private static HttpWebResponse GetRawResponse(HttpWebRequest request) - { - try - { - return (HttpWebResponse) request.GetResponse(); - } - catch (WebException ex) - { - // Check to see if this is an HTTP error or a transport error. - // In cases where an HTTP error occurs ( status code >= 400 ) - // return the underlying HTTP response, otherwise assume a - // transport exception (ex: connection timeout) and - // rethrow the exception - - if (ex.Response is HttpWebResponse response) - return response; - - throw; - } - } - - private void WriteRequestBody(HttpWebRequest webRequest) - { - if (HasBody || HasFiles || AlwaysMultipartFormData) - webRequest.ContentLength = CalculateContentLength(); - - using (var requestStream = webRequest.GetRequestStream()) - { - if (HasFiles || AlwaysMultipartFormData) - WriteMultipartFormData(requestStream); - else if (RequestBodyBytes != null) - requestStream.Write(RequestBodyBytes, 0, RequestBodyBytes.Length); - else if (RequestBody != null) - WriteStringTo(requestStream, RequestBody); - } - } - - // TODO: Try to merge the shared parts between ConfigureWebRequest and ConfigureAsyncWebRequest (quite a bit of code - // TODO: duplication at the moment). - private HttpWebRequest ConfigureWebRequest(string method, Uri url) - { - var webRequest = (HttpWebRequest) WebRequest.Create(url); - - webRequest.UseDefaultCredentials = UseDefaultCredentials; - webRequest.PreAuthenticate = PreAuthenticate; - webRequest.ServicePoint.Expect100Continue = false; - - AppendHeaders(webRequest); - AppendCookies(webRequest); - - webRequest.Method = method; - - // make sure Content-Length header is always sent since default is -1 - if (!HasFiles && !AlwaysMultipartFormData) - webRequest.ContentLength = 0; - - if (AutomaticDecompression) - { - webRequest.AutomaticDecompression = - DecompressionMethods.Deflate | DecompressionMethods.GZip | DecompressionMethods.None; - } - - if (ClientCertificates != null) - webRequest.ClientCertificates.AddRange(ClientCertificates); - - if (UserAgent.HasValue()) - webRequest.UserAgent = UserAgent; - - if (Timeout != 0) - webRequest.Timeout = Timeout; - - if (ReadWriteTimeout != 0) - webRequest.ReadWriteTimeout = ReadWriteTimeout; - - if (Credentials != null) - webRequest.Credentials = Credentials; - - webRequest.Proxy = Proxy; - - if (CachePolicy != null) - webRequest.CachePolicy = CachePolicy; - - webRequest.AllowAutoRedirect = FollowRedirects; - - if (FollowRedirects && MaxRedirects.HasValue) - webRequest.MaximumAutomaticRedirections = MaxRedirects.Value; - - webRequest.ServerCertificateValidationCallback = RemoteCertificateValidationCallback; - - return webRequest; - } - } -} \ No newline at end of file diff --git a/RestSharp/Http.cs b/RestSharp/Http.cs deleted file mode 100644 index 5a52ea89d..000000000 --- a/RestSharp/Http.cs +++ /dev/null @@ -1,423 +0,0 @@ -#region License - -// Copyright 2010 John Sheehan -// -// Licensed under the Apache License, Version 2.0 (the "License"); -// you may not use this file except in compliance with the License. -// You may obtain a copy of the License at -// -// http://www.apache.org/licenses/LICENSE-2.0 -// -// Unless required by applicable law or agreed to in writing, software -// distributed under the License is distributed on an "AS IS" BASIS, -// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -// See the License for the specific language governing permissions and -// limitations under the License. - -#endregion - -using System; -using System.Collections.Generic; -using System.IO; -using System.Linq; -using System.Net; -using System.Net.Cache; -using System.Net.Security; -using System.Security.Cryptography.X509Certificates; -using System.Text; -using System.Text.RegularExpressions; -using RestSharp.Extensions; - -namespace RestSharp -{ - /// - /// HttpWebRequest wrapper - /// - public partial class Http : IHttp, IHttpFactory - { - private const string LINE_BREAK = "\r\n"; - - private const string FORM_BOUNDARY = "-----------------------------28947758029299"; - - private readonly IDictionary> restrictedHeaderActions; - - /// - /// Default constructor - /// - public Http() - { - Headers = new List(); - Files = new List(); - Parameters = new List(); - Cookies = new List(); - restrictedHeaderActions = new Dictionary>( - StringComparer.OrdinalIgnoreCase); - - AddSharedHeaderActions(); - AddSyncHeaderActions(); - } - - /// - /// True if this HTTP request has any HTTP parameters - /// - protected bool HasParameters => Parameters.Any(); - - /// - /// True if this HTTP request has any HTTP cookies - /// - protected bool HasCookies => Cookies.Any(); - - /// - /// True if a request body has been specified - /// - protected bool HasBody => RequestBodyBytes != null || !string.IsNullOrEmpty(RequestBody); - - /// - /// True if files have been set to be uploaded - /// - protected bool HasFiles => Files.Any(); - - /// - /// Enable or disable automatic gzip/deflate decompression - /// - public bool AutomaticDecompression { get; set; } - - /// - /// Always send a multipart/form-data request - even when no Files are present. - /// - public bool AlwaysMultipartFormData { get; set; } - - /// - /// UserAgent to be sent with request - /// - public string UserAgent { get; set; } - - /// - /// Timeout in milliseconds to be used for the request - /// - public int Timeout { get; set; } - - /// - /// The number of milliseconds before the writing or reading times out. - /// - public int ReadWriteTimeout { get; set; } - - /// - /// System.Net.ICredentials to be sent with request - /// - public ICredentials Credentials { get; set; } - - /// - /// The System.Net.CookieContainer to be used for the request - /// - public CookieContainer CookieContainer { get; set; } - - /// - /// The method to use to write the response instead of reading into RawBytes - /// - public Action ResponseWriter { get; set; } - - /// - /// Collection of files to be sent with request - /// - public IList Files { get; } - - /// - /// Whether or not HTTP 3xx response redirects should be automatically followed - /// - public bool FollowRedirects { get; set; } - - /// - /// Whether or not to use pipelined connections - /// - public bool Pipelined { get; set; } - - /// - /// X509CertificateCollection to be sent with request - /// - public X509CertificateCollection ClientCertificates { get; set; } - - /// - /// Maximum number of automatic redirects to follow if FollowRedirects is true - /// - public int? MaxRedirects { get; set; } - - /// - /// Determine whether or not the "default credentials" (e.g. the user account under which the current process is - /// running) - /// will be sent along to the server. - /// - public bool UseDefaultCredentials { get; set; } - - public Encoding Encoding { get; set; } = Encoding.UTF8; - - /// - /// HTTP headers to be sent with request - /// - public IList Headers { get; } - - /// - /// HTTP parameters (QueryString or Form values) to be sent with request - /// - public IList Parameters { get; } - - /// - /// HTTP cookies to be sent with request - /// - public IList Cookies { get; } - - /// - /// Request body to be sent with request - /// - public string RequestBody { get; set; } - - /// - /// Content type of the request body. - /// - public string RequestContentType { get; set; } - - /// - /// An alternative to RequestBody, for when the caller already has the byte array. - /// - public byte[] RequestBodyBytes { get; set; } - - /// - /// URL to call for this request - /// - public Uri Url { get; set; } - - /// - /// Flag to send authorisation header with the HttpWebRequest - /// - public bool PreAuthenticate { get; set; } - - /// - /// Proxy info to be sent with request - /// - public IWebProxy Proxy { get; set; } - - /// - /// Caching policy for requests created with this wrapper. - /// - public RequestCachePolicy CachePolicy { get; set; } - - /// - /// Callback function for handling the validation of remote certificates. - /// - public RemoteCertificateValidationCallback RemoteCertificateValidationCallback { get; set; } - - /// - /// Creates an IHttp - /// - /// - public IHttp Create() - { - return new Http(); - } - - partial void AddSyncHeaderActions(); - - private void AddSharedHeaderActions() - { - restrictedHeaderActions.Add("Accept", (r, v) => r.Accept = v); - restrictedHeaderActions.Add("Content-Type", (r, v) => r.ContentType = v); - restrictedHeaderActions.Add("Date", (r, v) => - { - DateTime parsed; - - if (DateTime.TryParse(v, out parsed)) - r.Date = parsed; - }); - - restrictedHeaderActions.Add("Host", (r, v) => r.Host = v); - - restrictedHeaderActions.Add("Range", AddRange); - } - - private static string GetMultipartFormContentType() - { - return string.Format("multipart/form-data; boundary={0}", FORM_BOUNDARY); - } - - private static string GetMultipartFileHeader(HttpFile file) - { - return string.Format( - "--{0}{4}Content-Disposition: form-data; name=\"{1}\"; filename=\"{2}\"{4}Content-Type: {3}{4}{4}", - FORM_BOUNDARY, file.Name, file.FileName, file.ContentType ?? "application/octet-stream", LINE_BREAK); - } - - private string GetMultipartFormData(HttpParameter param) - { - var format = param.Name == RequestContentType - ? "--{0}{3}Content-Type: {4}{3}Content-Disposition: form-data; name=\"{1}\"{3}{3}{2}{3}" - : "--{0}{3}Content-Disposition: form-data; name=\"{1}\"{3}{3}{2}{3}"; - - return string.Format(format, FORM_BOUNDARY, param.Name, param.Value, LINE_BREAK, param.ContentType); - } - - private static string GetMultipartFooter() - { - return string.Format("--{0}--{1}", FORM_BOUNDARY, LINE_BREAK); - } - - // handle restricted headers the .NET way - thanks @dimebrain! - // http://msdn.microsoft.com/en-us/library/system.net.httpwebrequest.headers.aspx - private void AppendHeaders(HttpWebRequest webRequest) - { - foreach (var header in Headers) - if (restrictedHeaderActions.ContainsKey(header.Name)) - restrictedHeaderActions[header.Name].Invoke(webRequest, header.Value); - else - webRequest.Headers.Add(header.Name, header.Value); - } - - private void AppendCookies(HttpWebRequest webRequest) - { - webRequest.CookieContainer = CookieContainer ?? new CookieContainer(); - - foreach (var httpCookie in Cookies) - { - var cookie = new Cookie - { - Name = httpCookie.Name, - Value = httpCookie.Value, - Domain = webRequest.RequestUri.Host - }; - - webRequest.CookieContainer.Add(cookie); - } - } - - private string EncodeParameters() - { - var querystring = new StringBuilder(); - - foreach (var p in Parameters) - { - if (querystring.Length > 1) - querystring.Append("&"); - - querystring.AppendFormat("{0}={1}", p.Name.UrlEncode(), p.Value.UrlEncode()); - } - - return querystring.ToString(); - } - - private void PreparePostBody(HttpWebRequest webRequest) - { - if (HasFiles || AlwaysMultipartFormData) - { - webRequest.ContentType = GetMultipartFormContentType(); - } - else if (HasParameters) - { - webRequest.ContentType = "application/x-www-form-urlencoded"; - RequestBody = EncodeParameters(); - } - else if (HasBody) - { - webRequest.ContentType = RequestContentType; - } - } - - private void WriteStringTo(Stream stream, string toWrite) - { - var bytes = Encoding.GetBytes(toWrite); - - stream.Write(bytes, 0, bytes.Length); - } - - private void WriteMultipartFormData(Stream requestStream) - { - foreach (var param in Parameters) - WriteStringTo(requestStream, GetMultipartFormData(param)); - - foreach (var file in Files) - { - // Add just the first part of this param, since we will write the file data directly to the Stream - WriteStringTo(requestStream, GetMultipartFileHeader(file)); - - // Write the file data directly to the Stream, rather than serializing it to a string. - file.Writer(requestStream); - WriteStringTo(requestStream, LINE_BREAK); - } - - WriteStringTo(requestStream, GetMultipartFooter()); - } - - private void ExtractResponseData(HttpResponse response, HttpWebResponse webResponse) - { - using (webResponse) - { - response.ContentEncoding = webResponse.ContentEncoding; - response.Server = webResponse.Server; - response.ProtocolVersion = webResponse.ProtocolVersion; - response.ContentType = webResponse.ContentType; - response.ContentLength = webResponse.ContentLength; - - var webResponseStream = webResponse.GetResponseStream(); - - ProcessResponseStream(webResponseStream, response); - - response.StatusCode = webResponse.StatusCode; - response.StatusDescription = webResponse.StatusDescription; - response.ResponseUri = webResponse.ResponseUri; - response.ResponseStatus = ResponseStatus.Completed; - - if (webResponse.Cookies != null) - foreach (Cookie cookie in webResponse.Cookies) - response.Cookies.Add(new HttpCookie - { - Comment = cookie.Comment, - CommentUri = cookie.CommentUri, - Discard = cookie.Discard, - Domain = cookie.Domain, - Expired = cookie.Expired, - Expires = cookie.Expires, - HttpOnly = cookie.HttpOnly, - Name = cookie.Name, - Path = cookie.Path, - Port = cookie.Port, - Secure = cookie.Secure, - TimeStamp = cookie.TimeStamp, - Value = cookie.Value, - Version = cookie.Version - }); - - foreach (var headerName in webResponse.Headers.AllKeys) - { - var headerValue = webResponse.Headers[headerName]; - - response.Headers.Add(new HttpHeader - { - Name = headerName, - Value = headerValue - }); - } - webResponse.Close(); - } - } - - private void ProcessResponseStream(Stream webResponseStream, HttpResponse response) - { - if (ResponseWriter == null) - response.RawBytes = webResponseStream.ReadAsBytes(); - else - ResponseWriter(webResponseStream); - } - - private static void AddRange(HttpWebRequest r, string range) - { - var m = Regex.Match(range, "(\\w+)=(\\d+)-(\\d+)$"); - - if (!m.Success) - return; - - string rangeSpecifier = m.Groups[1].Value; - long from = Convert.ToInt64(m.Groups[2].Value); - long to = Convert.ToInt64(m.Groups[3].Value); - - r.AddRange(rangeSpecifier, from, to); - } - } -} \ No newline at end of file diff --git a/RestSharp/HttpCookie.cs b/RestSharp/HttpCookie.cs deleted file mode 100644 index acc2cecd8..000000000 --- a/RestSharp/HttpCookie.cs +++ /dev/null @@ -1,80 +0,0 @@ -using System; - -namespace RestSharp -{ - /// - /// Representation of an HTTP cookie - /// - public class HttpCookie - { - /// - /// Comment of the cookie - /// - public string Comment { get; set; } - - /// - /// Comment of the cookie - /// - public Uri CommentUri { get; set; } - - /// - /// Indicates whether the cookie should be discarded at the end of the session - /// - public bool Discard { get; set; } - - /// - /// Domain of the cookie - /// - public string Domain { get; set; } - - /// - /// Indicates whether the cookie is expired - /// - public bool Expired { get; set; } - - /// - /// Date and time that the cookie expires - /// - public DateTime Expires { get; set; } - - /// - /// Indicates that this cookie should only be accessed by the server - /// - public bool HttpOnly { get; set; } - - /// - /// Name of the cookie - /// - public string Name { get; set; } - - /// - /// Path of the cookie - /// - public string Path { get; set; } - - /// - /// Port of the cookie - /// - public string Port { get; set; } - - /// - /// Indicates that the cookie should only be sent over secure channels - /// - public bool Secure { get; set; } - - /// - /// Date and time the cookie was created - /// - public DateTime TimeStamp { get; set; } - - /// - /// Value of the cookie - /// - public string Value { get; set; } - - /// - /// Version of the cookie - /// - public int Version { get; set; } - } -} diff --git a/RestSharp/HttpFile.cs b/RestSharp/HttpFile.cs deleted file mode 100644 index 5df4b9073..000000000 --- a/RestSharp/HttpFile.cs +++ /dev/null @@ -1,36 +0,0 @@ -using System; -using System.IO; - -namespace RestSharp -{ - /// - /// Container for HTTP file - /// - public class HttpFile - { - /// - /// The length of data to be sent - /// - public long ContentLength { get; set; } - - /// - /// Provides raw data for file - /// - public Action Writer { get; set; } - - /// - /// Name of the file to use when uploading - /// - public string FileName { get; set; } - - /// - /// MIME content type of file - /// - public string ContentType { get; set; } - - /// - /// Name of the parameter - /// - public string Name { get; set; } - } -} diff --git a/RestSharp/HttpHeader.cs b/RestSharp/HttpHeader.cs deleted file mode 100644 index 6544aea32..000000000 --- a/RestSharp/HttpHeader.cs +++ /dev/null @@ -1,18 +0,0 @@ -namespace RestSharp -{ - /// - /// Representation of an HTTP header - /// - public class HttpHeader - { - /// - /// Name of the header - /// - public string Name { get; set; } - - /// - /// Value of the header - /// - public string Value { get; set; } - } -} diff --git a/RestSharp/HttpParameter.cs b/RestSharp/HttpParameter.cs deleted file mode 100644 index 735073411..000000000 --- a/RestSharp/HttpParameter.cs +++ /dev/null @@ -1,23 +0,0 @@ -namespace RestSharp -{ - /// - /// Representation of an HTTP parameter (QueryString or Form value) - /// - public class HttpParameter - { - /// - /// Name of the parameter - /// - public string Name { get; set; } - - /// - /// Value of the parameter - /// - public string Value { get; set; } - - /// - /// Content-Type of the parameter - /// - public string ContentType { get; set; } - } -} diff --git a/RestSharp/HttpResponse.cs b/RestSharp/HttpResponse.cs deleted file mode 100644 index 0dba99c4c..000000000 --- a/RestSharp/HttpResponse.cs +++ /dev/null @@ -1,123 +0,0 @@ -#region License - -// Copyright 2010 John Sheehan -// -// Licensed under the Apache License, Version 2.0 (the "License"); -// you may not use this file except in compliance with the License. -// You may obtain a copy of the License at -// -// http://www.apache.org/licenses/LICENSE-2.0 -// -// Unless required by applicable law or agreed to in writing, software -// distributed under the License is distributed on an "AS IS" BASIS, -// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -// See the License for the specific language governing permissions and -// limitations under the License. - -#endregion - -using System; -using System.Collections.Generic; -using System.Net; -using RestSharp.Extensions; - -namespace RestSharp -{ - /// - /// HTTP response data - /// - public class HttpResponse : IHttpResponse - { - private string content; - - /// - /// Default constructor - /// - public HttpResponse() - { - this.ResponseStatus = ResponseStatus.None; - this.Headers = new List(); - this.Cookies = new List(); - } - - /// - /// MIME content type of response - /// - public string ContentType { get; set; } - - /// - /// Length in bytes of the response content - /// - public long ContentLength { get; set; } - - /// - /// Encoding of the response content - /// - public string ContentEncoding { get; set; } - - /// - /// Lazy-loaded string representation of response content - /// - public string Content - { - get { return this.content ?? (this.content = this.RawBytes.AsString()); } - } - - /// - /// HTTP response status code - /// - public HttpStatusCode StatusCode { get; set; } - - /// - /// Description of HTTP status returned - /// - public string StatusDescription { get; set; } - - /// - /// Response content - /// - public byte[] RawBytes { get; set; } - - /// - /// The URL that actually responded to the content (different from request if redirected) - /// - public Uri ResponseUri { get; set; } - - /// - /// HttpWebResponse.Server - /// - public string Server { get; set; } - - /// - /// Headers returned by server with the response - /// - public IList Headers { get; private set; } - - /// - /// Cookies returned by server with the response - /// - public IList Cookies { get; private set; } - - /// - /// Status of the request. Will return Error for transport errors. - /// HTTP errors will still return ResponseStatus.Completed, check StatusCode instead - /// - public ResponseStatus ResponseStatus { get; set; } - - /// - /// Transport or other non-HTTP error generated while attempting request - /// - public string ErrorMessage { get; set; } - - /// - /// Exception thrown when error is encountered. - /// - public Exception ErrorException { get; set; } - - /// - /// The HTTP protocol version (1.0, 1.1, etc) - /// - /// Only set when underlying framework supports it. - public Version ProtocolVersion { get; set; } - } -} diff --git a/RestSharp/IHttp.cs b/RestSharp/IHttp.cs deleted file mode 100644 index 79df1e811..000000000 --- a/RestSharp/IHttp.cs +++ /dev/null @@ -1,134 +0,0 @@ -#region License - -// Copyright 2010 John Sheehan -// -// Licensed under the Apache License, Version 2.0 (the "License"); -// you may not use this file except in compliance with the License. -// You may obtain a copy of the License at -// -// http://www.apache.org/licenses/LICENSE-2.0 -// -// Unless required by applicable law or agreed to in writing, software -// distributed under the License is distributed on an "AS IS" BASIS, -// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -// See the License for the specific language governing permissions and -// limitations under the License. - -#endregion - -using System; -using System.Collections.Generic; -using System.IO; -using System.Net; -using System.Text; - -using System.Net.Cache; -using System.Net.Security; -using System.Security.Cryptography.X509Certificates; - -namespace RestSharp -{ - public interface IHttp - { - Action ResponseWriter { get; set; } - - CookieContainer CookieContainer { get; set; } - - ICredentials Credentials { get; set; } - - /// - /// Enable or disable automatic gzip/deflate decompression - /// - bool AutomaticDecompression { get; set; } - - /// - /// Always send a multipart/form-data request - even when no Files are present. - /// - bool AlwaysMultipartFormData { get; set; } - - string UserAgent { get; set; } - - int Timeout { get; set; } - - int ReadWriteTimeout { get; set; } - - bool FollowRedirects { get; set; } - - bool Pipelined { get; set; } - - X509CertificateCollection ClientCertificates { get; set; } - - int? MaxRedirects { get; set; } - - bool UseDefaultCredentials { get; set; } - - Encoding Encoding { get; set; } - - IList Headers { get; } - - IList Parameters { get; } - - IList Files { get; } - - IList Cookies { get; } - - string RequestBody { get; set; } - - string RequestContentType { get; set; } - - bool PreAuthenticate { get; set; } - - RequestCachePolicy CachePolicy { get; set; } - - /// - /// An alternative to RequestBody, for when the caller already has the byte array. - /// - byte[] RequestBodyBytes { get; set; } - - Uri Url { get; set; } - - HttpWebRequest DeleteAsync(Action action); - - HttpWebRequest GetAsync(Action action); - - HttpWebRequest HeadAsync(Action action); - - HttpWebRequest OptionsAsync(Action action); - - HttpWebRequest PostAsync(Action action); - - HttpWebRequest PutAsync(Action action); - - HttpWebRequest PatchAsync(Action action); - - HttpWebRequest MergeAsync(Action action); - - HttpWebRequest AsPostAsync(Action action, string httpMethod); - - HttpWebRequest AsGetAsync(Action action, string httpMethod); - - HttpResponse Delete(); - - HttpResponse Get(); - - HttpResponse Head(); - - HttpResponse Options(); - - HttpResponse Post(); - - HttpResponse Put(); - - HttpResponse Patch(); - - HttpResponse Merge(); - - HttpResponse AsPost(string httpMethod); - - HttpResponse AsGet(string httpMethod); - - IWebProxy Proxy { get; set; } - - RemoteCertificateValidationCallback RemoteCertificateValidationCallback { get; set; } - } -} diff --git a/RestSharp/IHttpFactory.cs b/RestSharp/IHttpFactory.cs deleted file mode 100644 index b49a64967..000000000 --- a/RestSharp/IHttpFactory.cs +++ /dev/null @@ -1,17 +0,0 @@ - -namespace RestSharp -{ - public interface IHttpFactory - { - IHttp Create(); - } - - public class SimpleFactory : IHttpFactory - where T : IHttp, new() - { - public IHttp Create() - { - return new T(); - } - } -} diff --git a/RestSharp/IHttpResponse.cs b/RestSharp/IHttpResponse.cs deleted file mode 100644 index 8b7042a14..000000000 --- a/RestSharp/IHttpResponse.cs +++ /dev/null @@ -1,89 +0,0 @@ -using System; -using System.Collections.Generic; -using System.Net; - -namespace RestSharp -{ - /// - /// HTTP response data - /// - public interface IHttpResponse - { - /// - /// MIME content type of response - /// - string ContentType { get; set; } - - /// - /// Length in bytes of the response content - /// - long ContentLength { get; set; } - - /// - /// Encoding of the response content - /// - string ContentEncoding { get; set; } - - /// - /// String representation of response content - /// - string Content { get; } - - /// - /// HTTP response status code - /// - HttpStatusCode StatusCode { get; set; } - - /// - /// Description of HTTP status returned - /// - string StatusDescription { get; set; } - - /// - /// Response content - /// - byte[] RawBytes { get; set; } - - /// - /// The URL that actually responded to the content (different from request if redirected) - /// - Uri ResponseUri { get; set; } - - /// - /// HttpWebResponse.Server - /// - string Server { get; set; } - - /// - /// Headers returned by server with the response - /// - IList Headers { get; } - - /// - /// Cookies returned by server with the response - /// - IList Cookies { get; } - - /// - /// Status of the request. Will return Error for transport errors. - /// HTTP errors will still return ResponseStatus.Completed, check StatusCode instead - /// - ResponseStatus ResponseStatus { get; set; } - - /// - /// Transport or other non-HTTP error generated while attempting request - /// - string ErrorMessage { get; set; } - - /// - /// Exception thrown when error is encountered. - /// - Exception ErrorException { get; set; } - - /// - /// The HTTP protocol version (1.0, 1.1, etc) - /// - /// Only set when underlying framework supports it. - Version ProtocolVersion { get; set; } - } -} diff --git a/RestSharp/IRestClient.cs b/RestSharp/IRestClient.cs deleted file mode 100644 index decace04d..000000000 --- a/RestSharp/IRestClient.cs +++ /dev/null @@ -1,229 +0,0 @@ -#region License - -// Copyright 2010 John Sheehan -// -// Licensed under the Apache License, Version 2.0 (the "License"); -// you may not use this file except in compliance with the License. -// You may obtain a copy of the License at -// -// http://www.apache.org/licenses/LICENSE-2.0 -// -// Unless required by applicable law or agreed to in writing, software -// distributed under the License is distributed on an "AS IS" BASIS, -// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -// See the License for the specific language governing permissions and -// limitations under the License. - -#endregion - -using System; -using System.Net; -using System.Collections.Generic; -using System.Text; -using RestSharp.Authenticators; -using RestSharp.Deserializers; - -using System.Threading; -using System.Threading.Tasks; -using System.Net.Cache; -using System.Security.Cryptography.X509Certificates; -using System.Net.Security; - -namespace RestSharp -{ - public interface IRestClient - { - CookieContainer CookieContainer { get; set; } - - bool AutomaticDecompression { get; set; } - - int? MaxRedirects { get; set; } - - string UserAgent { get; set; } - - int Timeout { get; set; } - - int ReadWriteTimeout { get; set; } - - bool UseSynchronizationContext { get; set; } - - IAuthenticator Authenticator { get; set; } - - Uri BaseUrl { get; set; } - - Encoding Encoding { get; set; } - - bool PreAuthenticate { get; set; } - - IList DefaultParameters { get; } - - RestRequestAsyncHandle ExecuteAsync(IRestRequest request, Action callback); - - RestRequestAsyncHandle ExecuteAsync(IRestRequest request, Action, RestRequestAsyncHandle> callback); - - IRestResponse Deserialize(IRestResponse response); - - IRestResponse Execute(IRestRequest request); - - IRestResponse Execute(IRestRequest request) where T : new(); - - byte[] DownloadData(IRestRequest request); - - /// - /// X509CertificateCollection to be sent with request - /// - X509CertificateCollection ClientCertificates { get; set; } - - IWebProxy Proxy { get; set; } - - RequestCachePolicy CachePolicy { get; set; } - - bool Pipelined { get; set; } - - bool FollowRedirects { get; set; } - - Uri BuildUri(IRestRequest request); - - /// - /// Callback function for handling the validation of remote certificates. Useful for certificate pinning and - /// overriding certificate errors in the scope of a request. - /// - RemoteCertificateValidationCallback RemoteCertificateValidationCallback { get; set; } - - /// - /// Executes a GET-style request and callback asynchronously, authenticating if needed - /// - /// Request to be executed - /// Callback function to be executed upon completion providing access to the async handle. - /// The HTTP method to execute - RestRequestAsyncHandle ExecuteAsyncGet(IRestRequest request, Action callback, string httpMethod); - - /// - /// Executes a POST-style request and callback asynchronously, authenticating if needed - /// - /// Request to be executed - /// Callback function to be executed upon completion providing access to the async handle. - /// The HTTP method to execute - RestRequestAsyncHandle ExecuteAsyncPost(IRestRequest request, Action callback, string httpMethod); - - /// - /// Executes a GET-style request and callback asynchronously, authenticating if needed - /// - /// Target deserialization type - /// Request to be executed - /// Callback function to be executed upon completion - /// The HTTP method to execute - RestRequestAsyncHandle ExecuteAsyncGet(IRestRequest request, Action, - RestRequestAsyncHandle> callback, string httpMethod); - - /// - /// Executes a GET-style request and callback asynchronously, authenticating if needed - /// - /// Target deserialization type - /// Request to be executed - /// Callback function to be executed upon completion - /// The HTTP method to execute - RestRequestAsyncHandle ExecuteAsyncPost(IRestRequest request, Action, - RestRequestAsyncHandle> callback, string httpMethod); - - void AddHandler(string contentType, IDeserializer deserializer); - - void RemoveHandler(string contentType); - - void ClearHandlers(); - - IRestResponse ExecuteAsGet(IRestRequest request, string httpMethod); - - IRestResponse ExecuteAsPost(IRestRequest request, string httpMethod); - - IRestResponse ExecuteAsGet(IRestRequest request, string httpMethod) where T : new(); - - IRestResponse ExecuteAsPost(IRestRequest request, string httpMethod) where T : new(); - - /// - /// Executes the request and callback asynchronously, authenticating if needed - /// - /// Target deserialization type - /// Request to be executed - /// The cancellation token - Task> ExecuteTaskAsync(IRestRequest request, CancellationToken token); - - /// - /// Executes the request asynchronously, authenticating if needed - /// - /// Target deserialization type - /// Request to be executed - Task> ExecuteTaskAsync(IRestRequest request); - - /// - /// Executes a GET-style request asynchronously, authenticating if needed - /// - /// Target deserialization type - /// Request to be executed - Task> ExecuteGetTaskAsync(IRestRequest request); - - /// - /// Executes a GET-style request asynchronously, authenticating if needed - /// - /// Target deserialization type - /// Request to be executed - /// The cancellation token - Task> ExecuteGetTaskAsync(IRestRequest request, CancellationToken token); - - /// - /// Executes a POST-style request asynchronously, authenticating if needed - /// - /// Target deserialization type - /// Request to be executed - Task> ExecutePostTaskAsync(IRestRequest request); - - /// - /// Executes a POST-style request asynchronously, authenticating if needed - /// - /// Target deserialization type - /// Request to be executed - /// The cancellation token - Task> ExecutePostTaskAsync(IRestRequest request, CancellationToken token); - - /// - /// Executes the request and callback asynchronously, authenticating if needed - /// - /// Request to be executed - /// The cancellation token - Task ExecuteTaskAsync(IRestRequest request, CancellationToken token); - - /// - /// Executes the request asynchronously, authenticating if needed - /// - /// Request to be executed - Task ExecuteTaskAsync(IRestRequest request); - - /// - /// Executes a GET-style asynchronously, authenticating if needed - /// - /// Request to be executed - Task ExecuteGetTaskAsync(IRestRequest request); - - /// - /// Executes a GET-style asynchronously, authenticating if needed - /// - /// Request to be executed - /// The cancellation token - Task ExecuteGetTaskAsync(IRestRequest request, CancellationToken token); - - /// - /// Executes a POST-style asynchronously, authenticating if needed - /// - /// Request to be executed - Task ExecutePostTaskAsync(IRestRequest request); - - /// - /// Executes a POST-style asynchronously, authenticating if needed - /// - /// Request to be executed - /// The cancellation token - Task ExecutePostTaskAsync(IRestRequest request, CancellationToken token); - } -} diff --git a/RestSharp/IRestRequest.cs b/RestSharp/IRestRequest.cs deleted file mode 100644 index 96dd1a3fb..000000000 --- a/RestSharp/IRestRequest.cs +++ /dev/null @@ -1,357 +0,0 @@ -#region License - -// Copyright 2010 John Sheehan -// -// Licensed under the Apache License, Version 2.0 (the "License"); -// you may not use this file except in compliance with the License. -// You may obtain a copy of the License at -// -// http://www.apache.org/licenses/LICENSE-2.0 -// -// Unless required by applicable law or agreed to in writing, software -// distributed under the License is distributed on an "AS IS" BASIS, -// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -// See the License for the specific language governing permissions and -// limitations under the License. - -#endregion - -using System; -using System.Collections.Generic; -using System.IO; -using System.Net; -using RestSharp.Serializers; - -namespace RestSharp -{ - public interface IRestRequest - { - /// - /// Always send a multipart/form-data request - even when no Files are present. - /// - bool AlwaysMultipartFormData { get; set; } - - /// - /// Serializer to use when writing JSON request bodies. Used if RequestFormat is Json. - /// By default the included JsonSerializer is used (currently using JSON.NET default serialization). - /// - ISerializer JsonSerializer { get; set; } - - /// - /// Serializer to use when writing XML request bodies. Used if RequestFormat is Xml. - /// By default the included XmlSerializer is used. - /// - ISerializer XmlSerializer { get; set; } - - /// - /// Set this to write response to Stream rather than reading into memory. - /// - Action ResponseWriter { get; set; } - - /// - /// Container of all HTTP parameters to be passed with the request. - /// See AddParameter() for explanation of the types of parameters that can be passed - /// - List Parameters { get; } - - /// - /// Container of all the files to be uploaded with the request. - /// - List Files { get; } - - /// - /// Determines what HTTP method to use for this request. Supported methods: GET, POST, PUT, DELETE, HEAD, OPTIONS - /// Default is GET - /// - Method Method { get; set; } - - /// - /// The Resource URL to make the request against. - /// Tokens are substituted with UrlSegment parameters and match by name. - /// Should not include the scheme or domain. Do not include leading slash. - /// Combined with RestClient.BaseUrl to assemble final URL: - /// {BaseUrl}/{Resource} (BaseUrl is scheme + domain, e.g. http://example.com) - /// - /// - /// // example for url token replacement - /// request.Resource = "Products/{ProductId}"; - /// request.AddParameter("ProductId", 123, ParameterType.UrlSegment); - /// - string Resource { get; set; } - - /// - /// Serializer to use when writing XML request bodies. Used if RequestFormat is Xml. - /// By default XmlSerializer is used. - /// - DataFormat RequestFormat { get; set; } - - /// - /// Used by the default deserializers to determine where to start deserializing from. - /// Can be used to skip container or root elements that do not have corresponding deserialzation targets. - /// - string RootElement { get; set; } - - /// - /// Used by the default deserializers to explicitly set which date format string to use when parsing dates. - /// - string DateFormat { get; set; } - - /// - /// Used by XmlDeserializer. If not specified, XmlDeserializer will flatten response by removing namespaces from element names. - /// - string XmlNamespace { get; set; } - - /// - /// In general you would not need to set this directly. Used by the NtlmAuthenticator. - /// - ICredentials Credentials { get; set; } - - /// - /// Timeout in milliseconds to be used for the request. This timeout value overrides a timeout set on the RestClient. - /// - int Timeout { get; set; } - - /// - /// The number of milliseconds before the writing or reading times out. This timeout value overrides a timeout set on the RestClient. - /// - int ReadWriteTimeout { get; set; } - - /// - /// How many attempts were made to send this Request? - /// - /// - /// This Number is incremented each time the RestClient sends the request. - /// Useful when using Asynchronous Execution with Callbacks - /// - int Attempts { get; } - - /// - /// Determine whether or not the "default credentials" (e.g. the user account under which the current process is running) - /// will be sent along to the server. The default is false. - /// - bool UseDefaultCredentials { get; set; } - - /// - /// Adds a file to the Files collection to be included with a POST or PUT request - /// (other methods do not support file uploads). - /// - /// The parameter name to use in the request - /// Full path to file to upload - /// The MIME type of the file to upload - /// This request - IRestRequest AddFile(string name, string path, string contentType = null); - - /// - /// Adds the bytes to the Files collection with the specified file name and content type - /// - /// The parameter name to use in the request - /// The file data - /// The file name to use for the uploaded file - /// The MIME type of the file to upload - /// This request - IRestRequest AddFile(string name, byte[] bytes, string fileName, string contentType = null); - - /// - /// Adds the bytes to the Files collection with the specified file name and content type - /// - /// The parameter name to use in the request - /// A function that writes directly to the stream. Should NOT close the stream. - /// The file name to use for the uploaded file - /// The length (in bytes) of the file content. - /// The MIME type of the file to upload - /// This request - IRestRequest AddFile(string name, Action writer, string fileName, long contentLength, string contentType = null); - - /// - /// Add bytes to the Files collection as if it was a file of specific type - /// - /// A form parameter name - /// The file data - /// The file name to use for the uploaded file - /// Specific content type. Es: application/x-gzip - /// - IRestRequest AddFileBytes(string name, byte[] bytes, string filename, string contentType = "application/x-gzip"); - - /// - /// Serializes obj to format specified by RequestFormat, but passes xmlNamespace if using the default XmlSerializer - /// The default format is XML. Change RequestFormat if you wish to use a different serialization format. - /// - /// The object to serialize - /// The XML namespace to use when serializing - /// This request - IRestRequest AddBody(object obj, string xmlNamespace); - - /// - /// Serializes obj to data format specified by RequestFormat and adds it to the request body. - /// The default format is XML. Change RequestFormat if you wish to use a different serialization format. - /// - /// The object to serialize - /// This request - IRestRequest AddBody(object obj); - - /// - /// Serializes obj to JSON format and adds it to the request body. - /// - /// The object to serialize - /// This request - IRestRequest AddJsonBody(object obj); - - /// - /// Serializes obj to XML format and adds it to the request body. - /// - /// The object to serialize - /// This request - IRestRequest AddXmlBody(object obj); - - /// - /// Serializes obj to format specified by RequestFormat, but passes xmlNamespace if using the default XmlSerializer - /// Serializes obj to XML format and passes xmlNamespace then adds it to the request body. - /// - /// The object to serialize - /// The XML namespace to use when serializing - /// This request - IRestRequest AddXmlBody(object obj, string xmlNamespace); - - /// - /// Calls AddParameter() for all public, readable properties specified in the includedProperties list - /// - /// - /// request.AddObject(product, "ProductId", "Price", ...); - /// - /// The object with properties to add as parameters - /// The names of the properties to include - /// This request - IRestRequest AddObject(object obj, params string[] includedProperties); - - /// - /// Calls AddParameter() for all public, readable properties of obj - /// - /// The object with properties to add as parameters - /// This request - IRestRequest AddObject(object obj); - - /// - /// Add the parameter to the request - /// - /// Parameter to add - /// - IRestRequest AddParameter(Parameter p); - - /// - /// Adds a HTTP parameter to the request (QueryString for GET, DELETE, OPTIONS and HEAD; Encoded form for POST and PUT) - /// - /// Name of the parameter - /// Value of the parameter - /// This request - IRestRequest AddParameter(string name, object value); - - /// - /// Adds a parameter to the request. There are five types of parameters: - /// - GetOrPost: Either a QueryString value or encoded form value based on method - /// - HttpHeader: Adds the name/value pair to the HTTP request's Headers collection - /// - UrlSegment: Inserted into URL if there is a matching url token e.g. {AccountId} - /// - Cookie: Adds the name/value pair to the HTTP request's Cookies collection - /// - RequestBody: Used by AddBody() (not recommended to use directly) - /// - /// Name of the parameter - /// Value of the parameter - /// The type of parameter to add - /// This request - IRestRequest AddParameter(string name, object value, ParameterType type); - - /// - /// Adds a parameter to the request. There are five types of parameters: - /// - GetOrPost: Either a QueryString value or encoded form value based on method - /// - HttpHeader: Adds the name/value pair to the HTTP request's Headers collection - /// - UrlSegment: Inserted into URL if there is a matching url token e.g. {AccountId} - /// - Cookie: Adds the name/value pair to the HTTP request's Cookies collection - /// - RequestBody: Used by AddBody() (not recommended to use directly) - /// - /// Name of the parameter - /// Value of the parameter - /// Content-Type of the parameter - /// The type of parameter to add - /// This request - IRestRequest AddParameter(string name, object value, string contentType, ParameterType type); - - /// - /// Add or update the parameter to the request - /// - /// Parameter to add - /// - IRestRequest AddOrUpdateParameter(Parameter p); - - /// - /// Adds a HTTP parameter to the request (QueryString for GET, DELETE, OPTIONS and HEAD; Encoded form for POST and PUT) - /// - /// Name of the parameter - /// Value of the parameter - /// This request - IRestRequest AddOrUpdateParameter(string name, object value); - - /// - /// Adds a parameter to the request. There are five types of parameters: - /// - GetOrPost: Either a QueryString value or encoded form value based on method - /// - HttpHeader: Adds the name/value pair to the HTTP request's Headers collection - /// - UrlSegment: Inserted into URL if there is a matching url token e.g. {AccountId} - /// - Cookie: Adds the name/value pair to the HTTP request's Cookies collection - /// - RequestBody: Used by AddBody() (not recommended to use directly) - /// - /// Name of the parameter - /// Value of the parameter - /// The type of parameter to add - /// This request - IRestRequest AddOrUpdateParameter(string name, object value, ParameterType type); - - /// - /// Adds a parameter to the request. There are five types of parameters: - /// - GetOrPost: Either a QueryString value or encoded form value based on method - /// - HttpHeader: Adds the name/value pair to the HTTP request's Headers collection - /// - UrlSegment: Inserted into URL if there is a matching url token e.g. {AccountId} - /// - Cookie: Adds the name/value pair to the HTTP request's Cookies collection - /// - RequestBody: Used by AddBody() (not recommended to use directly) - /// - /// Name of the parameter - /// Value of the parameter - /// Content-Type of the parameter - /// The type of parameter to add - /// This request - IRestRequest AddOrUpdateParameter(string name, object value, string contentType, ParameterType type); - - /// - /// Shortcut to AddParameter(name, value, HttpHeader) overload - /// - /// Name of the header to add - /// Value of the header to add - /// - IRestRequest AddHeader(string name, string value); - - /// - /// Shortcut to AddParameter(name, value, Cookie) overload - /// - /// Name of the cookie to add - /// Value of the cookie to add - /// - IRestRequest AddCookie(string name, string value); - - /// - /// Shortcut to AddParameter(name, value, UrlSegment) overload - /// - /// Name of the segment to add - /// Value of the segment to add - /// - IRestRequest AddUrlSegment(string name, string value); - - /// - /// Shortcut to AddParameter(name, value, QueryString) overload - /// - /// Name of the parameter to add - /// Value of the parameter to add - /// - IRestRequest AddQueryParameter(string name, string value); - - Action OnBeforeDeserialization { get; set; } - - void IncreaseNumAttempts(); - } -} diff --git a/RestSharp/IRestResponse.cs b/RestSharp/IRestResponse.cs deleted file mode 100644 index 23de73067..000000000 --- a/RestSharp/IRestResponse.cs +++ /dev/null @@ -1,116 +0,0 @@ -using System; -using System.Collections.Generic; -using System.Net; - -namespace RestSharp -{ - /// - /// Container for data sent back from API - /// - public interface IRestResponse - { - /// - /// The RestRequest that was made to get this RestResponse - /// - /// - /// Mainly for debugging if ResponseStatus is not OK - /// - IRestRequest Request { get; set; } - - /// - /// MIME content type of response - /// - string ContentType { get; set; } - - /// - /// Length in bytes of the response content - /// - long ContentLength { get; set; } - - /// - /// Encoding of the response content - /// - string ContentEncoding { get; set; } - - /// - /// String representation of response content - /// - string Content { get; set; } - - /// - /// HTTP response status code - /// - HttpStatusCode StatusCode { get; set; } - - /// - /// Whether or not the response status code indicates success - /// - bool IsSuccessful { get; } - - /// - /// Description of HTTP status returned - /// - string StatusDescription { get; set; } - - /// - /// Response content - /// - byte[] RawBytes { get; set; } - - /// - /// The URL that actually responded to the content (different from request if redirected) - /// - Uri ResponseUri { get; set; } - - /// - /// HttpWebResponse.Server - /// - string Server { get; set; } - - /// - /// Cookies returned by server with the response - /// - IList Cookies { get; } - - /// - /// Headers returned by server with the response - /// - IList Headers { get; } - - /// - /// Status of the request. Will return Error for transport errors. - /// HTTP errors will still return ResponseStatus.Completed, check StatusCode instead - /// - ResponseStatus ResponseStatus { get; set; } - - /// - /// Transport or other non-HTTP error generated while attempting request - /// - string ErrorMessage { get; set; } - - /// - /// Exceptions thrown during the request, if any. - /// - /// Will contain only network transport or framework exceptions thrown during the request. - /// HTTP protocol errors are handled by RestSharp and will not appear here. - Exception ErrorException { get; set; } - - /// - /// The HTTP protocol version (1.0, 1.1, etc) - /// - /// Only set when underlying framework supports it. - Version ProtocolVersion { get; set; } - } - - /// - /// Container for data sent back from API including deserialized data - /// - /// Type of data to deserialize to - public interface IRestResponse : IRestResponse - { - /// - /// Deserialized entity data - /// - T Data { get; set; } - } -} diff --git a/RestSharp/Parameter.cs b/RestSharp/Parameter.cs deleted file mode 100644 index 9e7c932ad..000000000 --- a/RestSharp/Parameter.cs +++ /dev/null @@ -1,55 +0,0 @@ -#region License - -// Copyright 2010 John Sheehan -// -// Licensed under the Apache License, Version 2.0 (the "License"); -// you may not use this file except in compliance with the License. -// You may obtain a copy of the License at -// -// http://www.apache.org/licenses/LICENSE-2.0 -// -// Unless required by applicable law or agreed to in writing, software -// distributed under the License is distributed on an "AS IS" BASIS, -// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -// See the License for the specific language governing permissions and -// limitations under the License. - -#endregion - -namespace RestSharp -{ - /// - /// Parameter container for REST requests - /// - public class Parameter - { - /// - /// Name of the parameter - /// - public string Name { get; set; } - - /// - /// Value of the parameter - /// - public object Value { get; set; } - - /// - /// Type of the parameter - /// - public ParameterType Type { get; set; } - - /// - /// MIME content type of the parameter - /// - public string ContentType { get; set; } - - /// - /// Return a human-readable representation of this parameter - /// - /// String - public override string ToString() - { - return string.Format("{0}={1}", this.Name, this.Value); - } - } -} diff --git a/RestSharp/RestClient.Async.cs b/RestSharp/RestClient.Async.cs deleted file mode 100644 index 769515f47..000000000 --- a/RestSharp/RestClient.Async.cs +++ /dev/null @@ -1,389 +0,0 @@ -#region License - -// Copyright 2010 John Sheehan -// -// Licensed under the Apache License, Version 2.0 (the "License"); -// you may not use this file except in compliance with the License. -// You may obtain a copy of the License at -// -// http://www.apache.org/licenses/LICENSE-2.0 -// -// Unless required by applicable law or agreed to in writing, software -// distributed under the License is distributed on an "AS IS" BASIS, -// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -// See the License for the specific language governing permissions and -// limitations under the License. - -#endregion - -using System; -using System.Net; -using System.Threading; -using System.Threading.Tasks; - -namespace RestSharp -{ - public partial class RestClient - { - /// - /// Executes the request and callback asynchronously, authenticating if needed - /// - /// Request to be executed - /// Callback function to be executed upon completion providing access to the async handle. - public virtual RestRequestAsyncHandle ExecuteAsync(IRestRequest request, - Action callback) - { - var method = Enum.GetName(typeof(Method), request.Method); - - switch (request.Method) - { - case Method.MERGE: - case Method.PATCH: - case Method.POST: - case Method.PUT: - return ExecuteAsync(request, callback, method, DoAsPostAsync); - - default: - return ExecuteAsync(request, callback, method, DoAsGetAsync); - } - } - - /// - /// Executes a GET-style request and callback asynchronously, authenticating if needed - /// - /// Request to be executed - /// Callback function to be executed upon completion providing access to the async handle. - /// The HTTP method to execute - public virtual RestRequestAsyncHandle ExecuteAsyncGet(IRestRequest request, - Action callback, string httpMethod) - { - return ExecuteAsync(request, callback, httpMethod, DoAsGetAsync); - } - - /// - /// Executes a POST-style request and callback asynchronously, authenticating if needed - /// - /// Request to be executed - /// Callback function to be executed upon completion providing access to the async handle. - /// The HTTP method to execute - public virtual RestRequestAsyncHandle ExecuteAsyncPost(IRestRequest request, - Action callback, string httpMethod) - { - request.Method = Method.POST; // Required by RestClient.BuildUri... - return ExecuteAsync(request, callback, httpMethod, DoAsPostAsync); - } - - /// - /// Executes the request and callback asynchronously, authenticating if needed - /// - /// Target deserialization type - /// Request to be executed - /// Callback function to be executed upon completion - public virtual RestRequestAsyncHandle ExecuteAsync(IRestRequest request, - Action, RestRequestAsyncHandle> callback) - { - return ExecuteAsync(request, - (response, asyncHandle) => DeserializeResponse(request, callback, response, asyncHandle)); - } - - /// - /// Executes a GET-style request and callback asynchronously, authenticating if needed - /// - /// Target deserialization type - /// Request to be executed - /// Callback function to be executed upon completion - /// The HTTP method to execute - public virtual RestRequestAsyncHandle ExecuteAsyncGet(IRestRequest request, - Action, RestRequestAsyncHandle> callback, string httpMethod) - { - return ExecuteAsyncGet(request, - (response, asyncHandle) => DeserializeResponse(request, callback, response, asyncHandle), httpMethod); - } - - /// - /// Executes a POST-style request and callback asynchronously, authenticating if needed - /// - /// Target deserialization type - /// Request to be executed - /// Callback function to be executed upon completion - /// The HTTP method to execute - public virtual RestRequestAsyncHandle ExecuteAsyncPost(IRestRequest request, - Action, RestRequestAsyncHandle> callback, string httpMethod) - { - return ExecuteAsyncPost(request, - (response, asyncHandle) => DeserializeResponse(request, callback, response, asyncHandle), httpMethod); - } - - /// - /// Executes a GET-style request asynchronously, authenticating if needed - /// - /// Target deserialization type - /// Request to be executed - public virtual Task> ExecuteGetTaskAsync(IRestRequest request) - { - return ExecuteGetTaskAsync(request, CancellationToken.None); - } - - /// - /// Executes a GET-style request asynchronously, authenticating if needed - /// - /// Target deserialization type - /// Request to be executed - /// The cancellation token - public virtual Task> ExecuteGetTaskAsync(IRestRequest request, CancellationToken token) - { - if (request == null) - throw new ArgumentNullException("request"); - - request.Method = Method.GET; - - return ExecuteTaskAsync(request, token); - } - - /// - /// Executes a POST-style request asynchronously, authenticating if needed - /// - /// Target deserialization type - /// Request to be executed - public virtual Task> ExecutePostTaskAsync(IRestRequest request) - { - return ExecutePostTaskAsync(request, CancellationToken.None); - } - - /// - /// Executes a POST-style request asynchronously, authenticating if needed - /// - /// Target deserialization type - /// Request to be executed - /// The cancellation token - public virtual Task> ExecutePostTaskAsync(IRestRequest request, CancellationToken token) - { - if (request == null) - throw new ArgumentNullException("request"); - - request.Method = Method.POST; - - return ExecuteTaskAsync(request, token); - } - - /// - /// Executes the request asynchronously, authenticating if needed - /// - /// Target deserialization type - /// Request to be executed - public virtual Task> ExecuteTaskAsync(IRestRequest request) - { - return ExecuteTaskAsync(request, CancellationToken.None); - } - - /// - /// Executes the request asynchronously, authenticating if needed - /// - /// Target deserialization type - /// Request to be executed - /// The cancellation token - public virtual Task> ExecuteTaskAsync(IRestRequest request, CancellationToken token) - { - if (request == null) - throw new ArgumentNullException("request"); - - var taskCompletionSource = new TaskCompletionSource>(); - - try - { - var async = ExecuteAsync( - request, - (response, _) => - { - if (token.IsCancellationRequested) - taskCompletionSource.TrySetCanceled(); - // Don't run TrySetException, since we should set Error properties and swallow exceptions - // to be consistent with sync methods - else - taskCompletionSource.TrySetResult(response); - }); - - var registration = - token.Register(() => - { - async.Abort(); - taskCompletionSource.TrySetCanceled(); - }); - - taskCompletionSource.Task.ContinueWith(t => registration.Dispose(), token); - } - catch (Exception ex) - { - taskCompletionSource.TrySetException(ex); - } - - return taskCompletionSource.Task; - } - - /// - /// Executes the request asynchronously, authenticating if needed - /// - /// Request to be executed - public virtual Task ExecuteTaskAsync(IRestRequest request) - { - return ExecuteTaskAsync(request, CancellationToken.None); - } - - /// - /// Executes a GET-style asynchronously, authenticating if needed - /// - /// Request to be executed - public virtual Task ExecuteGetTaskAsync(IRestRequest request) - { - return ExecuteGetTaskAsync(request, CancellationToken.None); - } - - /// - /// Executes a GET-style asynchronously, authenticating if needed - /// - /// Request to be executed - /// The cancellation token - public virtual Task ExecuteGetTaskAsync(IRestRequest request, CancellationToken token) - { - if (request == null) - throw new ArgumentNullException("request"); - - request.Method = Method.GET; - - return ExecuteTaskAsync(request, token); - } - - /// - /// Executes a POST-style asynchronously, authenticating if needed - /// - /// Request to be executed - public virtual Task ExecutePostTaskAsync(IRestRequest request) - { - return ExecutePostTaskAsync(request, CancellationToken.None); - } - - /// - /// Executes a POST-style asynchronously, authenticating if needed - /// - /// Request to be executed - /// The cancellation token - public virtual Task ExecutePostTaskAsync(IRestRequest request, CancellationToken token) - { - if (request == null) - throw new ArgumentNullException("request"); - - request.Method = Method.POST; - - return ExecuteTaskAsync(request, token); - } - - /// - /// Executes the request asynchronously, authenticating if needed - /// - /// Request to be executed - /// The cancellation token - public virtual Task ExecuteTaskAsync(IRestRequest request, CancellationToken token) - { - if (request == null) - throw new ArgumentNullException("request"); - - var taskCompletionSource = new TaskCompletionSource(); - - try - { - var async = ExecuteAsync( - request, - (response, _) => - { - if (token.IsCancellationRequested) - taskCompletionSource.TrySetCanceled(); - // Don't run TrySetException, since we should set Error - // properties and swallow exceptions to be consistent - // with sync methods - else - taskCompletionSource.TrySetResult(response); - }); - - var registration = - token.Register(() => - { - async.Abort(); - taskCompletionSource.TrySetCanceled(); - }); - - taskCompletionSource.Task.ContinueWith(t => registration.Dispose(), token); - } - catch (Exception ex) - { - taskCompletionSource.TrySetException(ex); - } - - return taskCompletionSource.Task; - } - - private RestRequestAsyncHandle ExecuteAsync(IRestRequest request, - Action callback, string httpMethod, - Func, string, HttpWebRequest> getWebRequest) - { - var http = HttpFactory.Create(); - - AuthenticateIfNeeded(this, request); - ConfigureHttp(request, http); - - var asyncHandle = new RestRequestAsyncHandle(); - Action responseCb = r => ProcessResponse(request, r, asyncHandle, callback); - - if (UseSynchronizationContext && SynchronizationContext.Current != null) - { - var ctx = SynchronizationContext.Current; - var cb = responseCb; - - responseCb = resp => ctx.Post(s => cb(resp), null); - } - - asyncHandle.WebRequest = getWebRequest(http, responseCb, httpMethod); - - return asyncHandle; - } - - private static HttpWebRequest DoAsGetAsync(IHttp http, Action responseCb, string method) - { - return http.AsGetAsync(responseCb, method); - } - - private static HttpWebRequest DoAsPostAsync(IHttp http, Action responseCb, string method) - { - return http.AsPostAsync(responseCb, method); - } - - private static void ProcessResponse(IRestRequest request, HttpResponse httpResponse, - RestRequestAsyncHandle asyncHandle, Action callback) - { - var restResponse = ConvertToRestResponse(request, httpResponse); - callback(restResponse, asyncHandle); - } - - private void DeserializeResponse(IRestRequest request, Action, - RestRequestAsyncHandle> callback, IRestResponse response, RestRequestAsyncHandle asyncHandle) - { - IRestResponse restResponse; - - try - { - restResponse = Deserialize(request, response); - } - catch (Exception ex) - { - restResponse = new RestResponse - { - Request = request, - ResponseStatus = ResponseStatus.Error, - ErrorMessage = ex.Message, - ErrorException = ex - }; - } - - callback(restResponse, asyncHandle); - } - } -} \ No newline at end of file diff --git a/RestSharp/RestClient.Sync.cs b/RestSharp/RestClient.Sync.cs deleted file mode 100644 index a73024c9d..000000000 --- a/RestSharp/RestClient.Sync.cs +++ /dev/null @@ -1,111 +0,0 @@ -using System; - -namespace RestSharp -{ - public partial class RestClient - { - /// - /// Executes the specified request and downloads the response data - /// - /// Request to execute - /// Response data - public byte[] DownloadData(IRestRequest request) - { - var response = Execute(request); - - return response.RawBytes; - } - - /// - /// Executes the request and returns a response, authenticating if needed - /// - /// Request to be executed - /// RestResponse - public virtual IRestResponse Execute(IRestRequest request) - { - var method = Enum.GetName(typeof(Method), request.Method); - - switch (request.Method) - { - case Method.POST: - case Method.PUT: - case Method.PATCH: - case Method.MERGE: - return Execute(request, method, DoExecuteAsPost); - - default: - return Execute(request, method, DoExecuteAsGet); - } - } - - public IRestResponse ExecuteAsGet(IRestRequest request, string httpMethod) - { - return Execute(request, httpMethod, DoExecuteAsGet); - } - - public IRestResponse ExecuteAsPost(IRestRequest request, string httpMethod) - { - request.Method = Method.POST; // Required by RestClient.BuildUri... - - return Execute(request, httpMethod, DoExecuteAsPost); - } - - /// - /// Executes the specified request and deserializes the response content using the appropriate content handler - /// - /// Target deserialization type - /// Request to execute - /// RestResponse[[T]] with deserialized data in Data property - public virtual IRestResponse Execute(IRestRequest request) where T : new() - { - return Deserialize(request, Execute(request)); - } - - public IRestResponse ExecuteAsGet(IRestRequest request, string httpMethod) where T : new() - { - return Deserialize(request, ExecuteAsGet(request, httpMethod)); - } - - public IRestResponse ExecuteAsPost(IRestRequest request, string httpMethod) where T : new() - { - return Deserialize(request, ExecuteAsPost(request, httpMethod)); - } - - private IRestResponse Execute(IRestRequest request, string httpMethod, - Func getResponse) - { - AuthenticateIfNeeded(this, request); - - IRestResponse response = new RestResponse(); - - try - { - var http = HttpFactory.Create(); - - ConfigureHttp(request, http); - - response = ConvertToRestResponse(request, getResponse(http, httpMethod)); - response.Request = request; - response.Request.IncreaseNumAttempts(); - } - catch (Exception ex) - { - response.ResponseStatus = ResponseStatus.Error; - response.ErrorMessage = ex.Message; - response.ErrorException = ex; - } - - return response; - } - - private static HttpResponse DoExecuteAsGet(IHttp http, string method) - { - return http.AsGet(method); - } - - private static HttpResponse DoExecuteAsPost(IHttp http, string method) - { - return http.AsPost(method); - } - } -} \ No newline at end of file diff --git a/RestSharp/RestClient.cs b/RestSharp/RestClient.cs deleted file mode 100644 index 416a280f6..000000000 --- a/RestSharp/RestClient.cs +++ /dev/null @@ -1,605 +0,0 @@ -#region License - -// Copyright 2010 John Sheehan -// -// Licensed under the Apache License, Version 2.0 (the "License"); -// you may not use this file except in compliance with the License. -// You may obtain a copy of the License at -// -// http://www.apache.org/licenses/LICENSE-2.0 -// -// Unless required by applicable law or agreed to in writing, software -// distributed under the License is distributed on an "AS IS" BASIS, -// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -// See the License for the specific language governing permissions and -// limitations under the License. - -#endregion - -using System; -using System.Collections.Generic; -using System.Linq; -using System.Net; -using System.Net.Cache; -using System.Net.Security; -using System.Reflection; -using System.Security.Cryptography.X509Certificates; -using System.Text; -using System.Text.RegularExpressions; -using RestSharp.Authenticators; -using RestSharp.Deserializers; -using RestSharp.Extensions; - -namespace RestSharp -{ - /// - /// Client to translate RestRequests into Http requests and process response result - /// - public partial class RestClient : IRestClient - { - // silverlight friendly way to get current version - private static readonly Version version = new AssemblyName(Assembly.GetExecutingAssembly().FullName).Version; - - private static readonly Regex StructuredSyntaxSuffixRegex = new Regex(@"\+\w+$", RegexOptions.Compiled); - - private static readonly Regex StructuredSyntaxSuffixWildcardRegex = - new Regex(@"^\*\+\w+$", RegexOptions.Compiled); - - public IHttpFactory HttpFactory = new SimpleFactory(); - - /// - /// Default constructor that registers default content handlers - /// - public RestClient() - { - Encoding = Encoding.UTF8; - ContentHandlers = new Dictionary(); - AcceptTypes = new List(); - DefaultParameters = new List(); - AutomaticDecompression = true; - - // TODO: Make this configurable - // register default handlers - AddHandler("application/json", new JsonDeserializer()); - AddHandler("application/xml", new XmlDeserializer()); - AddHandler("text/json", new JsonDeserializer()); - AddHandler("text/x-json", new JsonDeserializer()); - AddHandler("text/javascript", new JsonDeserializer()); - AddHandler("text/xml", new XmlDeserializer()); - AddHandler("*+json", new JsonDeserializer()); - AddHandler("*+xml", new XmlDeserializer()); - AddHandler("*", new XmlDeserializer()); - - FollowRedirects = true; - } - - /// - /// Sets the BaseUrl property for requests made by this client instance - /// - /// - public RestClient(Uri baseUrl) : this() - { - BaseUrl = baseUrl; - } - - /// - /// Sets the BaseUrl property for requests made by this client instance - /// - /// - public RestClient(string baseUrl) : this() - { - if (string.IsNullOrEmpty(baseUrl)) - throw new ArgumentNullException("baseUrl"); - - BaseUrl = new Uri(baseUrl); - } - - private IDictionary ContentHandlers { get; } - - private IList AcceptTypes { get; } - - /// - /// Enable or disable automatic gzip/deflate decompression - /// - public bool AutomaticDecompression { get; set; } - - /// - /// Maximum number of redirects to follow if FollowRedirects is true - /// - public int? MaxRedirects { get; set; } - - /// - /// X509CertificateCollection to be sent with request - /// - public X509CertificateCollection ClientCertificates { get; set; } - - /// - /// Proxy to use for requests made by this client instance. - /// Passed on to underlying WebRequest if set. - /// - public IWebProxy Proxy { get; set; } - - /// - /// The cache policy to use for requests initiated by this client instance. - /// - public RequestCachePolicy CachePolicy { get; set; } - - public bool Pipelined { get; set; } - - /// - /// Default is true. Determine whether or not requests that result in - /// HTTP status codes of 3xx should follow returned redirect - /// - public bool FollowRedirects { get; set; } - - /// - /// The CookieContainer used for requests made by this client instance - /// - public CookieContainer CookieContainer { get; set; } - - /// - /// UserAgent to use for requests made by this client instance - /// - public string UserAgent { get; set; } - - /// - /// Timeout in milliseconds to use for requests made by this client instance - /// - public int Timeout { get; set; } - - /// - /// The number of milliseconds before the writing or reading times out. - /// - public int ReadWriteTimeout { get; set; } - - /// - /// Whether to invoke async callbacks using the SynchronizationContext.Current captured when invoked - /// - public bool UseSynchronizationContext { get; set; } - - /// - /// Authenticator to use for requests made by this client instance - /// - public IAuthenticator Authenticator { get; set; } - - /// - /// Combined with Request.Resource to construct URL for request - /// Should include scheme and domain without trailing slash. - /// - /// - /// client.BaseUrl = new Uri("http://example.com"); - /// - public virtual Uri BaseUrl { get; set; } - - public Encoding Encoding { get; set; } - - public bool PreAuthenticate { get; set; } - - /// - /// Callback function for handling the validation of remote certificates. Useful for certificate pinning and - /// overriding certificate errors in the scope of a request. - /// - public RemoteCertificateValidationCallback RemoteCertificateValidationCallback { get; set; } - - /// - /// Parameters included with every request made with this instance of RestClient - /// If specified in both client and request, the request wins - /// - public IList DefaultParameters { get; } - - /// - /// Registers a content handler to process response content - /// - /// MIME content type of the response content - /// Deserializer to use to process content - public void AddHandler(string contentType, IDeserializer deserializer) - { - ContentHandlers[contentType] = deserializer; - - if (contentType == "*" || IsWildcardStructuredSuffixSyntax(contentType)) return; - - AcceptTypes.Add(contentType); - // add Accept header based on registered deserializers - var accepts = string.Join(", ", AcceptTypes.ToArray()); - - this.RemoveDefaultParameter("Accept"); - this.AddDefaultParameter("Accept", accepts, ParameterType.HttpHeader); - } - - /// - /// Remove a content handler for the specified MIME content type - /// - /// MIME content type to remove - public void RemoveHandler(string contentType) - { - ContentHandlers.Remove(contentType); - AcceptTypes.Remove(contentType); - this.RemoveDefaultParameter("Accept"); - } - - /// - /// Remove all content handlers - /// - public void ClearHandlers() - { - ContentHandlers.Clear(); - AcceptTypes.Clear(); - this.RemoveDefaultParameter("Accept"); - } - - public IRestResponse Deserialize(IRestResponse response) - { - return Deserialize(response.Request, response); - } - - /// - /// Assembles URL to call based on parameters, method and resource - /// - /// RestRequest to execute - /// Assembled System.Uri - public Uri BuildUri(IRestRequest request) - { - if (BaseUrl == null) - throw new NullReferenceException("RestClient must contain a value for BaseUrl"); - - var assembled = request.Resource; - var urlParms = request.Parameters.Where(p => p.Type == ParameterType.UrlSegment); - var builder = new UriBuilder(BaseUrl); - - foreach (var p in urlParms) - { - if (p.Value == null) - throw new ArgumentException( - string.Format("Cannot build uri when url segment parameter '{0}' value is null.", p.Name), - "request"); - - if (!string.IsNullOrEmpty(assembled)) - assembled = assembled.Replace("{" + p.Name + "}", p.Value.ToString().UrlEncode()); - - builder.Path = builder.Path.UrlDecode().Replace("{" + p.Name + "}", p.Value.ToString().UrlEncode()); - } - - BaseUrl = new Uri(builder.ToString()); - - if (!string.IsNullOrEmpty(assembled) && assembled.StartsWith("/")) - assembled = assembled.Substring(1); - - if (BaseUrl != null && !string.IsNullOrEmpty(BaseUrl.AbsoluteUri)) - { - if (!BaseUrl.AbsoluteUri.EndsWith("/") && !string.IsNullOrEmpty(assembled)) - assembled = string.Concat("/", assembled); - - assembled = string.IsNullOrEmpty(assembled) - ? BaseUrl.AbsoluteUri - : string.Format("{0}{1}", BaseUrl, assembled); - } - - IEnumerable parameters; - - if (request.Method != Method.POST && request.Method != Method.PUT && request.Method != Method.PATCH) - parameters = request.Parameters - .Where(p => p.Type == ParameterType.GetOrPost || - p.Type == ParameterType.QueryString) - .ToList(); - else - parameters = request.Parameters - .Where(p => p.Type == ParameterType.QueryString) - .ToList(); - - if (!parameters.Any()) - return new Uri(assembled); - - // build and attach querystring - var data = EncodeParameters(parameters); - var separator = assembled != null && assembled.Contains("?") - ? "&" - : "?"; - - assembled = string.Concat(assembled, separator, data); - - return new Uri(assembled); - } - - /// - /// Retrieve the handler for the specified MIME content type - /// - /// MIME content type to retrieve - /// IDeserializer instance - private IDeserializer GetHandler(string contentType) - { - if (contentType == null) - throw new ArgumentNullException("contentType"); - - if (string.IsNullOrEmpty(contentType) && ContentHandlers.ContainsKey("*")) - return ContentHandlers["*"]; - - int semicolonIndex = contentType.IndexOf(';'); - - if (semicolonIndex > -1) - contentType = contentType.Substring(0, semicolonIndex); - - if (ContentHandlers.ContainsKey(contentType)) - return ContentHandlers[contentType]; - - // Avoid unnecessary use of regular expressions in checking for structured syntax suffix by looking for a '+' first - if (contentType.IndexOf('+') >= 0) - { - // https://tools.ietf.org/html/rfc6839#page-4 - Match structuredSyntaxSuffixMatch = StructuredSyntaxSuffixRegex.Match(contentType); - - if (structuredSyntaxSuffixMatch.Success) - { - string structuredSyntaxSuffixWildcard = "*" + structuredSyntaxSuffixMatch.Value; - if (ContentHandlers.ContainsKey(structuredSyntaxSuffixWildcard)) - { - return ContentHandlers[structuredSyntaxSuffixWildcard]; - } - } - } - - return ContentHandlers.ContainsKey("*") ? ContentHandlers["*"] : null; - } - - private void AuthenticateIfNeeded(RestClient client, IRestRequest request) => - Authenticator?.Authenticate(client, request); - - private static string EncodeParameters(IEnumerable parameters) => - string.Join("&", parameters.Select(EncodeParameter).ToArray()); - - private static string EncodeParameter(Parameter parameter) => - parameter.Value == null - ? string.Concat(parameter.Name.UrlEncode(), "=") - : string.Concat(parameter.Name.UrlEncode(), "=", parameter.Value.ToString().UrlEncode()); - - private void ConfigureHttp(IRestRequest request, IHttp http) - { - http.Encoding = Encoding; - http.AlwaysMultipartFormData = request.AlwaysMultipartFormData; - http.UseDefaultCredentials = request.UseDefaultCredentials; - http.ResponseWriter = request.ResponseWriter; - http.CookieContainer = CookieContainer; - http.AutomaticDecompression = AutomaticDecompression; - - // move RestClient.DefaultParameters into Request.Parameters - foreach (var p in DefaultParameters) - { - if (request.Parameters.Any(p2 => p2.Name == p.Name && p2.Type == p.Type)) - continue; - - request.AddParameter(p); - } - - // Add Accept header based on registered deserializers if none has been set by the caller. - if (request.Parameters.All(p2 => p2.Name.ToLowerInvariant() != "accept")) - { - var accepts = string.Join(", ", AcceptTypes.ToArray()); - - request.AddParameter("Accept", accepts, ParameterType.HttpHeader); - } - - http.Url = BuildUri(request); - http.PreAuthenticate = PreAuthenticate; - - var userAgent = UserAgent ?? http.UserAgent; - - http.UserAgent = userAgent.HasValue() - ? userAgent - : "RestSharp/" + version; - - var timeout = request.Timeout > 0 - ? request.Timeout - : Timeout; - - if (timeout > 0) - http.Timeout = timeout; - - var readWriteTimeout = request.ReadWriteTimeout > 0 - ? request.ReadWriteTimeout - : ReadWriteTimeout; - - if (readWriteTimeout > 0) - http.ReadWriteTimeout = readWriteTimeout; - - http.FollowRedirects = FollowRedirects; - - if (ClientCertificates != null) - http.ClientCertificates = ClientCertificates; - - http.MaxRedirects = MaxRedirects; - http.CachePolicy = CachePolicy; - http.Pipelined = Pipelined; - - if (request.Credentials != null) - http.Credentials = request.Credentials; - - var headers = from p in request.Parameters - where p.Type == ParameterType.HttpHeader - select new HttpHeader - { - Name = p.Name, - Value = Convert.ToString(p.Value) - }; - - foreach (var header in headers) - http.Headers.Add(header); - - var cookies = from p in request.Parameters - where p.Type == ParameterType.Cookie - select new HttpCookie - { - Name = p.Name, - Value = Convert.ToString(p.Value) - }; - - foreach (var cookie in cookies) - http.Cookies.Add(cookie); - - var @params = from p in request.Parameters - where p.Type == ParameterType.GetOrPost && p.Value != null - select new HttpParameter - { - Name = p.Name, - Value = Convert.ToString(p.Value) - }; - - foreach (var parameter in @params) - http.Parameters.Add(parameter); - - foreach (var file in request.Files) - http.Files.Add(new HttpFile - { - Name = file.Name, - ContentType = file.ContentType, - Writer = file.Writer, - FileName = file.FileName, - ContentLength = file.ContentLength - }); - - var body = request.Parameters.FirstOrDefault(p => p.Type == ParameterType.RequestBody); - - // Only add the body if there aren't any files to make it a multipart form request - // If there are files, then add the body to the HTTP Parameters - if (body != null) - { - http.RequestContentType = body.Name; - - if (!http.Files.Any()) - { - var val = body.Value; - - if (val is byte[] bytes) - http.RequestBodyBytes = bytes; - else - http.RequestBody = Convert.ToString(body.Value); - } - else - { - http.Parameters.Add(new HttpParameter - { - Name = body.Name, - Value = Convert.ToString(body.Value), - ContentType = body.ContentType - }); - } - } - http.Proxy = Proxy; -#if NETSTANDARD2_0 - if (http.Proxy == null) - { - var _ = WebRequest.DefaultWebProxy; - WebRequest.DefaultWebProxy = null; - } -#endif - http.RemoteCertificateValidationCallback = RemoteCertificateValidationCallback; - } - - private static RestResponse ConvertToRestResponse(IRestRequest request, HttpResponse httpResponse) - { - var restResponse = new RestResponse - { - Content = httpResponse.Content, - ContentEncoding = httpResponse.ContentEncoding, - ContentLength = httpResponse.ContentLength, - ContentType = httpResponse.ContentType, - ErrorException = httpResponse.ErrorException, - ErrorMessage = httpResponse.ErrorMessage, - RawBytes = httpResponse.RawBytes, - ResponseStatus = httpResponse.ResponseStatus, - ResponseUri = httpResponse.ResponseUri, - ProtocolVersion = httpResponse.ProtocolVersion, - Server = httpResponse.Server, - StatusCode = httpResponse.StatusCode, - StatusDescription = httpResponse.StatusDescription, - Request = request - }; - - foreach (var header in httpResponse.Headers) - restResponse.Headers.Add(new Parameter - { - Name = header.Name, - Value = header.Value, - Type = ParameterType.HttpHeader - }); - - foreach (var cookie in httpResponse.Cookies) - restResponse.Cookies.Add(new RestResponseCookie - { - Comment = cookie.Comment, - CommentUri = cookie.CommentUri, - Discard = cookie.Discard, - Domain = cookie.Domain, - Expired = cookie.Expired, - Expires = cookie.Expires, - HttpOnly = cookie.HttpOnly, - Name = cookie.Name, - Path = cookie.Path, - Port = cookie.Port, - Secure = cookie.Secure, - TimeStamp = cookie.TimeStamp, - Value = cookie.Value, - Version = cookie.Version - }); - - return restResponse; - } - - private IRestResponse Deserialize(IRestRequest request, IRestResponse raw) - { - request.OnBeforeDeserialization(raw); - - IRestResponse response = new RestResponse(); - - try - { - response = raw.ToAsyncResponse(); - response.Request = request; - - // Only attempt to deserialize if the request has not errored due - // to a transport or framework exception. HTTP errors should attempt to - // be deserialized - if (response.ErrorException == null) - { - IDeserializer handler = GetHandler(raw.ContentType); - - // Only continue if there is a handler defined else there is no way to deserialize the data. - // This can happen when a request returns for example a 404 page instead of the requested JSON/XML resource - if (handler != null) - { - handler.RootElement = request.RootElement; - handler.DateFormat = request.DateFormat; - handler.Namespace = request.XmlNamespace; - - response.Data = handler.Deserialize(raw); - } - } - } - catch (Exception ex) - { - response.ResponseStatus = ResponseStatus.Error; - response.ErrorMessage = ex.Message; - response.ErrorException = ex; - } - - return response; - } - - private static bool IsWildcardStructuredSuffixSyntax(string contentType) - { - int i = 0; - - // Avoid most unnecessary uses of RegEx by checking for necessary characters explicitly first - if (contentType[i++] != '*') - return false; - - if (contentType[i++] != '+') - return false; - - // If no more characters to check, exit now - if (i == contentType.Length) - return false; - - // At this point it is probably using a wildcard structured syntax suffix, but let's confirm. - return StructuredSyntaxSuffixWildcardRegex.IsMatch(contentType); - } - } -} \ No newline at end of file diff --git a/RestSharp/RestClientExtensions.cs b/RestSharp/RestClientExtensions.cs deleted file mode 100644 index 70577f3c4..000000000 --- a/RestSharp/RestClientExtensions.cs +++ /dev/null @@ -1,399 +0,0 @@ -using System; -using System.Linq; -using System.Threading.Tasks; - -namespace RestSharp -{ - public static class RestClientExtensions - { - /// - /// Executes the request and callback asynchronously, authenticating if needed - /// - /// The IRestClient this method extends - /// Request to be executed - /// Callback function to be executed upon completion - public static RestRequestAsyncHandle ExecuteAsync(this IRestClient client, IRestRequest request, - Action callback) - { - return client.ExecuteAsync(request, (response, handle) => callback(response)); - } - - /// - /// Executes the request and callback asynchronously, authenticating if needed - /// - /// The IRestClient this method extends - /// Target deserialization type - /// Request to be executed - /// Callback function to be executed upon completion providing access to the async handle - public static RestRequestAsyncHandle ExecuteAsync(this IRestClient client, IRestRequest request, - Action> callback) where T : new() - { - return client.ExecuteAsync(request, (response, asyncHandle) => callback(response)); - } - - public static RestRequestAsyncHandle GetAsync(this IRestClient client, IRestRequest request, - Action, RestRequestAsyncHandle> callback) where T : new() - { - request.Method = Method.GET; - - return client.ExecuteAsync(request, callback); - } - - public static RestRequestAsyncHandle PostAsync(this IRestClient client, IRestRequest request, - Action, RestRequestAsyncHandle> callback) where T : new() - { - request.Method = Method.POST; - - return client.ExecuteAsync(request, callback); - } - - public static RestRequestAsyncHandle PutAsync(this IRestClient client, IRestRequest request, - Action, RestRequestAsyncHandle> callback) where T : new() - { - request.Method = Method.PUT; - - return client.ExecuteAsync(request, callback); - } - - public static RestRequestAsyncHandle HeadAsync(this IRestClient client, IRestRequest request, - Action, RestRequestAsyncHandle> callback) where T : new() - { - request.Method = Method.HEAD; - - return client.ExecuteAsync(request, callback); - } - - public static RestRequestAsyncHandle OptionsAsync(this IRestClient client, IRestRequest request, - Action, RestRequestAsyncHandle> callback) where T : new() - { - request.Method = Method.OPTIONS; - - return client.ExecuteAsync(request, callback); - } - - public static RestRequestAsyncHandle PatchAsync(this IRestClient client, IRestRequest request, - Action, RestRequestAsyncHandle> callback) where T : new() - { - request.Method = Method.PATCH; - - return client.ExecuteAsync(request, callback); - } - - public static RestRequestAsyncHandle DeleteAsync(this IRestClient client, IRestRequest request, - Action, RestRequestAsyncHandle> callback) where T : new() - { - request.Method = Method.DELETE; - - return client.ExecuteAsync(request, callback); - } - - public static RestRequestAsyncHandle GetAsync(this IRestClient client, IRestRequest request, - Action callback) - { - request.Method = Method.GET; - - return client.ExecuteAsync(request, callback); - } - - public static RestRequestAsyncHandle PostAsync(this IRestClient client, IRestRequest request, - Action callback) - { - request.Method = Method.POST; - - return client.ExecuteAsync(request, callback); - } - - public static RestRequestAsyncHandle PutAsync(this IRestClient client, IRestRequest request, - Action callback) - { - request.Method = Method.PUT; - - return client.ExecuteAsync(request, callback); - } - - public static RestRequestAsyncHandle HeadAsync(this IRestClient client, IRestRequest request, - Action callback) - { - request.Method = Method.HEAD; - - return client.ExecuteAsync(request, callback); - } - - public static RestRequestAsyncHandle OptionsAsync(this IRestClient client, IRestRequest request, - Action callback) - { - request.Method = Method.OPTIONS; - - return client.ExecuteAsync(request, callback); - } - - public static RestRequestAsyncHandle PatchAsync(this IRestClient client, IRestRequest request, - Action callback) - { - request.Method = Method.PATCH; - - return client.ExecuteAsync(request, callback); - } - - public static RestRequestAsyncHandle DeleteAsync(this IRestClient client, IRestRequest request, - Action callback) - { - request.Method = Method.DELETE; - - return client.ExecuteAsync(request, callback); - } - - public static RestResponse ExecuteDynamic(this IRestClient client, IRestRequest request) - { - IRestResponse response = client.Execute(request); - RestResponse generic = (RestResponse)response; - dynamic content = SimpleJson.SimpleJson.DeserializeObject(response.Content); - - generic.Data = content; - - return generic; - } - - public static Task GetTaskAsync(this IRestClient client, IRestRequest request) where T : new() - { - return client.ExecuteGetTaskAsync(request).ContinueWith(x => x.Result.Data); - } - - public static Task PostTaskAsync(this IRestClient client, IRestRequest request) where T : new() - { - return client.ExecutePostTaskAsync(request).ContinueWith(x => x.Result.Data); - } - - public static Task PutTaskAsync(this IRestClient client, IRestRequest request) where T : new() - { - request.Method = Method.PUT; - - return client.ExecuteTaskAsync(request).ContinueWith(x => x.Result.Data); - } - - public static Task HeadTaskAsync(this IRestClient client, IRestRequest request) where T : new() - { - request.Method = Method.HEAD; - - return client.ExecuteTaskAsync(request).ContinueWith(x => x.Result.Data); - } - - public static Task OptionsTaskAsync(this IRestClient client, IRestRequest request) where T : new() - { - request.Method = Method.OPTIONS; - - return client.ExecuteTaskAsync(request).ContinueWith(x => x.Result.Data); - } - - public static Task PatchTaskAsync(this IRestClient client, IRestRequest request) where T : new() - { - request.Method = Method.PATCH; - - return client.ExecuteTaskAsync(request).ContinueWith(x => x.Result.Data); - } - - public static Task DeleteTaskAsync(this IRestClient client, IRestRequest request) where T : new() - { - request.Method = Method.DELETE; - - return client.ExecuteTaskAsync(request).ContinueWith(x => x.Result.Data); - } - - public static IRestResponse Get(this IRestClient client, IRestRequest request) where T : new() - { - request.Method = Method.GET; - - return client.Execute(request); - } - - public static IRestResponse Post(this IRestClient client, IRestRequest request) where T : new() - { - request.Method = Method.POST; - - return client.Execute(request); - } - - public static IRestResponse Put(this IRestClient client, IRestRequest request) where T : new() - { - request.Method = Method.PUT; - - return client.Execute(request); - } - - public static IRestResponse Head(this IRestClient client, IRestRequest request) where T : new() - { - request.Method = Method.HEAD; - - return client.Execute(request); - } - - public static IRestResponse Options(this IRestClient client, IRestRequest request) where T : new() - { - request.Method = Method.OPTIONS; - - return client.Execute(request); - } - - public static IRestResponse Patch(this IRestClient client, IRestRequest request) where T : new() - { - request.Method = Method.PATCH; - - return client.Execute(request); - } - - public static IRestResponse Delete(this IRestClient client, IRestRequest request) where T : new() - { - request.Method = Method.DELETE; - - return client.Execute(request); - } - - public static IRestResponse Get(this IRestClient client, IRestRequest request) - { - request.Method = Method.GET; - - return client.Execute(request); - } - - public static IRestResponse Post(this IRestClient client, IRestRequest request) - { - request.Method = Method.POST; - - return client.Execute(request); - } - - public static IRestResponse Put(this IRestClient client, IRestRequest request) - { - request.Method = Method.PUT; - - return client.Execute(request); - } - - public static IRestResponse Head(this IRestClient client, IRestRequest request) - { - request.Method = Method.HEAD; - - return client.Execute(request); - } - - public static IRestResponse Options(this IRestClient client, IRestRequest request) - { - request.Method = Method.OPTIONS; - - return client.Execute(request); - } - - public static IRestResponse Patch(this IRestClient client, IRestRequest request) - { - request.Method = Method.PATCH; - - return client.Execute(request); - } - - public static IRestResponse Delete(this IRestClient client, IRestRequest request) - { - request.Method = Method.DELETE; - - return client.Execute(request); - } - - /// - /// Add a parameter to use on every request made with this client instance - /// - /// The IRestClient instance - /// Parameter to add - /// - public static void AddDefaultParameter(this IRestClient restClient, Parameter p) - { - if (p.Type == ParameterType.RequestBody) - { - throw new NotSupportedException( - "Cannot set request body from default headers. Use Request.AddBody() instead."); - } - - restClient.DefaultParameters.Add(p); - } - - /// - /// Removes a parameter from the default parameters that are used on every request made with this client instance - /// - /// The IRestClient instance - /// The name of the parameter that needs to be removed - /// - public static void RemoveDefaultParameter(this IRestClient restClient, string name) - { - Parameter parameter = restClient.DefaultParameters.SingleOrDefault( - p => p.Name.Equals(name, StringComparison.OrdinalIgnoreCase)); - - if (parameter != null) - { - restClient.DefaultParameters.Remove(parameter); - } - } - - /// - /// Adds a HTTP parameter (QueryString for GET, DELETE, OPTIONS and HEAD; Encoded form for POST and PUT) - /// Used on every request made by this client instance - /// - /// The IRestClient instance - /// Name of the parameter - /// Value of the parameter - /// This request - public static void AddDefaultParameter(this IRestClient restClient, string name, object value) - { - restClient.AddDefaultParameter(new Parameter - { - Name = name, - Value = value, - Type = ParameterType.GetOrPost - }); - } - - /// - /// Adds a parameter to the request. There are four types of parameters: - /// - GetOrPost: Either a QueryString value or encoded form value based on method - /// - HttpHeader: Adds the name/value pair to the HTTP request's Headers collection - /// - UrlSegment: Inserted into URL if there is a matching url token e.g. {AccountId} - /// - RequestBody: Used by AddBody() (not recommended to use directly) - /// - /// The IRestClient instance - /// Name of the parameter - /// Value of the parameter - /// The type of parameter to add - /// This request - public static void AddDefaultParameter(this IRestClient restClient, string name, object value, - ParameterType type) - { - restClient.AddDefaultParameter(new Parameter - { - Name = name, - Value = value, - Type = type - }); - } - - /// - /// Shortcut to AddDefaultParameter(name, value, HttpHeader) overload - /// - /// The IRestClient instance - /// Name of the header to add - /// Value of the header to add - /// - public static void AddDefaultHeader(this IRestClient restClient, string name, string value) - { - restClient.AddDefaultParameter(name, value, ParameterType.HttpHeader); - } - - /// - /// Shortcut to AddDefaultParameter(name, value, UrlSegment) overload - /// - /// The IRestClient instance - /// Name of the segment to add - /// Value of the segment to add - /// - public static void AddDefaultUrlSegment(this IRestClient restClient, string name, string value) - { - restClient.AddDefaultParameter(name, value, ParameterType.UrlSegment); - } - } -} diff --git a/RestSharp/RestRequest.cs b/RestSharp/RestRequest.cs deleted file mode 100644 index 27520c96c..000000000 --- a/RestSharp/RestRequest.cs +++ /dev/null @@ -1,692 +0,0 @@ -#region License - -// Copyright 2010 John Sheehan -// -// Licensed under the Apache License, Version 2.0 (the "License"); -// you may not use this file except in compliance with the License. -// You may obtain a copy of the License at -// -// http://www.apache.org/licenses/LICENSE-2.0 -// -// Unless required by applicable law or agreed to in writing, software -// distributed under the License is distributed on an "AS IS" BASIS, -// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -// See the License for the specific language governing permissions and -// limitations under the License. - -#endregion - -using System; -using System.Collections.Generic; -using System.IO; -using System.Linq; -using System.Net; -using System.Text.RegularExpressions; -using RestSharp.Serializers; - -namespace RestSharp -{ - /// - /// Container for data used to make requests - /// - public class RestRequest : IRestRequest - { - /// - /// Default constructor - /// - public RestRequest() - { - RequestFormat = DataFormat.Xml; - Method = Method.GET; - Parameters = new List(); - Files = new List(); - XmlSerializer = new XmlSerializer(); - JsonSerializer = new JsonSerializer(); - - OnBeforeDeserialization = r => { }; - } - - /// - /// Sets Method property to value of method - /// - /// Method to use for this request - public RestRequest(Method method) : this() - { - Method = method; - } - - /// - /// Sets Resource property - /// - /// Resource to use for this request - public RestRequest(string resource) : this(resource, Method.GET) - { - } - - /// - /// Sets Resource and Method properties - /// - /// Resource to use for this request - /// Method to use for this request - public RestRequest(string resource, Method method) : this() - { - Resource = resource; - Method = method; - } - - /// - /// Sets Resource property - /// - /// Resource to use for this request - public RestRequest(Uri resource) : this(resource, Method.GET) - { - } - - /// - /// Sets Resource and Method properties - /// - /// Resource to use for this request - /// Method to use for this request - public RestRequest(Uri resource, Method method) - : this(resource.IsAbsoluteUri - ? resource.AbsolutePath + resource.Query - : resource.OriginalString, method) - { - //resource.PathAndQuery not supported by Silverlight :( - } - - /// - /// Gets or sets a user-defined state object that contains information about a request and which can be later - /// retrieved when the request completes. - /// - public object UserState { get; set; } - - /// - /// Always send a multipart/form-data request - even when no Files are present. - /// - public bool AlwaysMultipartFormData { get; set; } - - /// - /// Serializer to use when writing JSON request bodies. Used if RequestFormat is Json. - /// By default the included JsonSerializer is used (currently using JSON.NET default serialization). - /// - public ISerializer JsonSerializer { get; set; } - - /// - /// Serializer to use when writing XML request bodies. Used if RequestFormat is Xml. - /// By default the included XmlSerializer is used. - /// - public ISerializer XmlSerializer { get; set; } - - /// - /// Set this to write response to Stream rather than reading into memory. - /// - public Action ResponseWriter { get; set; } - - /// - /// Determine whether or not the "default credentials" (e.g. the user account under which the current process is - /// running) - /// will be sent along to the server. The default is false. - /// - public bool UseDefaultCredentials { get; set; } - - /// - /// Adds a file to the Files collection to be included with a POST or PUT request - /// (other methods do not support file uploads). - /// - /// The parameter name to use in the request - /// Full path to file to upload - /// The MIME type of the file to upload - /// This request - public IRestRequest AddFile(string name, string path, string contentType = null) - { - var f = new FileInfo(path); - var fileLength = f.Length; - - return AddFile(new FileParameter - { - Name = name, - FileName = Path.GetFileName(path), - ContentLength = fileLength, - Writer = s => - { - using (var file = new StreamReader(new FileStream(path, FileMode.Open))) - { - file.BaseStream.CopyTo(s); - } - }, - ContentType = contentType - }); - } - - /// - /// Adds the bytes to the Files collection with the specified file name - /// - /// The parameter name to use in the request - /// The file data - /// The file name to use for the uploaded file - /// The MIME type of the file to upload - /// This request - public IRestRequest AddFile(string name, byte[] bytes, string fileName, string contentType = null) - { - return AddFile(FileParameter.Create(name, bytes, fileName, contentType)); - } - - /// - /// Adds the bytes to the Files collection with the specified file name and content type - /// - /// The parameter name to use in the request - /// A function that writes directly to the stream. Should NOT close the stream. - /// The file name to use for the uploaded file - /// The length (in bytes) of the file content. - /// The MIME type of the file to upload - /// This request - public IRestRequest AddFile(string name, Action writer, string fileName, long contentLength, - string contentType = null) - { - return AddFile(new FileParameter - { - Name = name, - Writer = writer, - FileName = fileName, - ContentLength = contentLength, - ContentType = contentType - }); - } - - /// - /// Add bytes to the Files collection as if it was a file of specific type - /// - /// A form parameter name - /// The file data - /// The file name to use for the uploaded file - /// Specific content type. Es: application/x-gzip - /// - public IRestRequest AddFileBytes(string name, byte[] bytes, string filename, - string contentType = "application/x-gzip") - { - long length = bytes.Length; - - return AddFile(new FileParameter - { - Name = name, - FileName = filename, - ContentLength = length, - ContentType = contentType, - Writer = s => - { - using (var file = new StreamReader(new MemoryStream(bytes))) - { - file.BaseStream.CopyTo(s); - } - } - }); - } - - /// - /// Serializes obj to format specified by RequestFormat, but passes xmlNamespace if using the default XmlSerializer - /// The default format is XML. Change RequestFormat if you wish to use a different serialization format. - /// - /// The object to serialize - /// The XML namespace to use when serializing - /// This request - public IRestRequest AddBody(object obj, string xmlNamespace) - { - string serialized; - string contentType; - - // TODO: Make it possible to change the serialiser - switch (RequestFormat) - { - case DataFormat.Json: - serialized = JsonSerializer.Serialize(obj); - contentType = JsonSerializer.ContentType; - break; - - case DataFormat.Xml: - XmlSerializer.Namespace = xmlNamespace; - serialized = XmlSerializer.Serialize(obj); - contentType = XmlSerializer.ContentType; - break; - - default: - serialized = ""; - contentType = ""; - break; - } - - // passing the content type as the parameter name because there can only be - // one parameter with ParameterType.RequestBody so name isn't used otherwise - // it's a hack, but it works :) - return AddParameter(contentType, serialized, ParameterType.RequestBody); - } - - /// - /// Serializes obj to data format specified by RequestFormat and adds it to the request body. - /// The default format is XML. Change RequestFormat if you wish to use a different serialization format. - /// - /// The object to serialize - /// This request - public IRestRequest AddBody(object obj) - { - return AddBody(obj, ""); - } - - /// - /// Serializes obj to JSON format and adds it to the request body. - /// - /// The object to serialize - /// This request - public IRestRequest AddJsonBody(object obj) - { - RequestFormat = DataFormat.Json; - - return AddBody(obj, ""); - } - - /// - /// Serializes obj to XML format and adds it to the request body. - /// - /// The object to serialize - /// This request - public IRestRequest AddXmlBody(object obj) - { - RequestFormat = DataFormat.Xml; - - return AddBody(obj, ""); - } - - /// - /// Serializes obj to format specified by RequestFormat, but passes xmlNamespace if using the default XmlSerializer - /// Serializes obj to XML format and passes xmlNamespace then adds it to the request body. - /// - /// The object to serialize - /// The XML namespace to use when serializing - /// This request - public IRestRequest AddXmlBody(object obj, string xmlNamespace) - { - RequestFormat = DataFormat.Xml; - - return AddBody(obj, xmlNamespace); - } - - /// - /// Calls AddParameter() for all public, readable properties specified in the includedProperties list - /// - /// - /// request.AddObject(product, "ProductId", "Price", ...); - /// - /// The object with properties to add as parameters - /// The names of the properties to include - /// This request - public IRestRequest AddObject(object obj, params string[] includedProperties) - { - // automatically create parameters from object props - var type = obj.GetType(); - var props = type.GetProperties(); - - foreach (var prop in props) - { - var isAllowed = includedProperties.Length == 0 || - includedProperties.Length > 0 && includedProperties.Contains(prop.Name); - - if (!isAllowed) - continue; - - var propType = prop.PropertyType; - var val = prop.GetValue(obj, null); - - if (val == null) - continue; - - if (propType.IsArray) - { - var elementType = propType.GetElementType(); - - if (((Array) val).Length > 0 && - elementType != null && - (elementType.IsPrimitive || elementType.IsValueType || elementType == typeof(string))) - { - // convert the array to an array of strings - var values = (from object item in (Array) val - select item.ToString()).ToArray(); - - val = string.Join(",", values); - } - else - { - // try to cast it - val = string.Join(",", (string[]) val); - } - } - - AddParameter(prop.Name, val); - } - - return this; - } - - /// - /// Calls AddParameter() for all public, readable properties of obj - /// - /// The object with properties to add as parameters - /// This request - public IRestRequest AddObject(object obj) - { - AddObject(obj, new string[] { }); - - return this; - } - - /// - /// Add the parameter to the request - /// - /// Parameter to add - /// - public IRestRequest AddParameter(Parameter p) - { - Parameters.Add(p); - - return this; - } - - /// - /// Adds a HTTP parameter to the request (QueryString for GET, DELETE, OPTIONS and HEAD; Encoded form for POST and PUT) - /// - /// Name of the parameter - /// Value of the parameter - /// This request - public IRestRequest AddParameter(string name, object value) - { - return AddParameter(new Parameter - { - Name = name, - Value = value, - Type = ParameterType.GetOrPost - }); - } - - /// - /// Adds a parameter to the request. There are four types of parameters: - /// - GetOrPost: Either a QueryString value or encoded form value based on method - /// - HttpHeader: Adds the name/value pair to the HTTP request's Headers collection - /// - UrlSegment: Inserted into URL if there is a matching url token e.g. {AccountId} - /// - RequestBody: Used by AddBody() (not recommended to use directly) - /// - /// Name of the parameter - /// Value of the parameter - /// The type of parameter to add - /// This request - public IRestRequest AddParameter(string name, object value, ParameterType type) - { - return AddParameter(new Parameter - { - Name = name, - Value = value, - Type = type - }); - } - - /// - /// Adds a parameter to the request. There are four types of parameters: - /// - GetOrPost: Either a QueryString value or encoded form value based on method - /// - HttpHeader: Adds the name/value pair to the HTTP request's Headers collection - /// - UrlSegment: Inserted into URL if there is a matching url token e.g. {AccountId} - /// - RequestBody: Used by AddBody() (not recommended to use directly) - /// - /// Name of the parameter - /// Value of the parameter - /// Content-Type of the parameter - /// The type of parameter to add - /// This request - public IRestRequest AddParameter(string name, object value, string contentType, ParameterType type) - { - return AddParameter(new Parameter - { - Name = name, - Value = value, - ContentType = contentType, - Type = type - }); - } - - /// - /// Adds a parameter to the request or updates it with the given argument, if the parameter already exists in the request - /// - /// Parameter to add - /// - public IRestRequest AddOrUpdateParameter(Parameter p) - { - if (Parameters.Any(param => param.Name == p.Name)) - { - var parameter = Parameters.First(param => param.Name == p.Name); - parameter.Value = p.Value; - return this; - } - - Parameters.Add(p); - return this; - } - - /// - /// Adds a HTTP parameter to the request or updates it with the given argument, if the parameter already exists in the request - /// (QueryString for GET, DELETE, OPTIONS and HEAD; Encoded form for POST and PUT) - /// - /// Name of the parameter - /// Value of the parameter - /// This request - public IRestRequest AddOrUpdateParameter(string name, object value) - { - return AddOrUpdateParameter(new Parameter - { - Name = name, - Value = value, - Type = ParameterType.GetOrPost - }); - } - - /// - /// Adds a HTTP parameter to the request or updates it with the given argument, if the parameter already exists in the request - /// - GetOrPost: Either a QueryString value or encoded form value based on method - /// - HttpHeader: Adds the name/value pair to the HTTP request's Headers collection - /// - UrlSegment: Inserted into URL if there is a matching url token e.g. {AccountId} - /// - RequestBody: Used by AddBody() (not recommended to use directly) - /// - /// Name of the parameter - /// Value of the parameter - /// The type of parameter to add - /// This request - public IRestRequest AddOrUpdateParameter(string name, object value, ParameterType type) - { - return AddOrUpdateParameter(new Parameter - { - Name = name, - Value = value, - Type = type - }); - } - - /// - /// Adds a HTTP parameter to the request or updates it with the given argument, if the parameter already exists in the request - /// - GetOrPost: Either a QueryString value or encoded form value based on method - /// - HttpHeader: Adds the name/value pair to the HTTP request's Headers collection - /// - UrlSegment: Inserted into URL if there is a matching url token e.g. {AccountId} - /// - RequestBody: Used by AddBody() (not recommended to use directly) - /// - /// Name of the parameter - /// Value of the parameter - /// Content-Type of the parameter - /// The type of parameter to add - /// This request - public IRestRequest AddOrUpdateParameter(string name, object value, string contentType, ParameterType type) - { - return AddOrUpdateParameter(new Parameter - { - Name = name, - Value = value, - ContentType = contentType, - Type = type - }); - } - - /// - /// Shortcut to AddParameter(name, value, HttpHeader) overload - /// - /// Name of the header to add - /// Value of the header to add - /// - public IRestRequest AddHeader(string name, string value) - { - const string portSplit = @":\d+"; - Func invalidHost = - host => Uri.CheckHostName(Regex.Split(host, portSplit)[0]) == UriHostNameType.Unknown; - - if (name == "Host" && invalidHost(value)) - throw new ArgumentException("The specified value is not a valid Host header string.", "value"); - return AddParameter(name, value, ParameterType.HttpHeader); - } - - /// - /// Shortcut to AddParameter(name, value, Cookie) overload - /// - /// Name of the cookie to add - /// Value of the cookie to add - /// - public IRestRequest AddCookie(string name, string value) - { - return AddParameter(name, value, ParameterType.Cookie); - } - - /// - /// Shortcut to AddParameter(name, value, UrlSegment) overload - /// - /// Name of the segment to add - /// Value of the segment to add - /// - public IRestRequest AddUrlSegment(string name, string value) - { - return AddParameter(name, value, ParameterType.UrlSegment); - } - - /// - /// Shortcut to AddParameter(name, value, QueryString) overload - /// - /// Name of the parameter to add - /// Value of the parameter to add - /// - public IRestRequest AddQueryParameter(string name, string value) - { - return AddParameter(name, value, ParameterType.QueryString); - } - - /// - /// Container of all HTTP parameters to be passed with the request. - /// See AddParameter() for explanation of the types of parameters that can be passed - /// - public List Parameters { get; } - - /// - /// Container of all the files to be uploaded with the request. - /// - public List Files { get; } - - /// - /// Determines what HTTP method to use for this request. Supported methods: GET, POST, PUT, DELETE, HEAD, OPTIONS - /// Default is GET - /// - public Method Method { get; set; } - - /// - /// The Resource URL to make the request against. - /// Tokens are substituted with UrlSegment parameters and match by name. - /// Should not include the scheme or domain. Do not include leading slash. - /// Combined with RestClient.BaseUrl to assemble final URL: - /// {BaseUrl}/{Resource} (BaseUrl is scheme + domain, e.g. http://example.com) - /// - /// - /// // example for url token replacement - /// request.Resource = "Products/{ProductId}"; - /// request.AddParameter("ProductId", 123, ParameterType.UrlSegment); - /// - public string Resource { get; set; } - - /// - /// Determines how to serialize the request body. - /// By default Xml is used. - /// - public DataFormat RequestFormat { get; set; } - - /// - /// Used by the default deserializers to determine where to start deserializing from. - /// Can be used to skip container or root elements that do not have corresponding deserialzation targets. - /// - public string RootElement { get; set; } - - /// - /// A function to run prior to deserializing starting (e.g. change settings if error encountered) - /// - public Action OnBeforeDeserialization { get; set; } - - /// - /// Used by the default deserializers to explicitly set which date format string to use when parsing dates. - /// - public string DateFormat { get; set; } - - /// - /// Used by XmlDeserializer. If not specified, XmlDeserializer will flatten response by removing namespaces from - /// element names. - /// - public string XmlNamespace { get; set; } - - /// - /// In general you would not need to set this directly. Used by the NtlmAuthenticator. - /// - public ICredentials Credentials { get; set; } - - /// - /// Timeout in milliseconds to be used for the request. This timeout value overrides a timeout set on the RestClient. - /// - public int Timeout { get; set; } - - /// - /// The number of milliseconds before the writing or reading times out. This timeout value overrides a timeout set on - /// the RestClient. - /// - public int ReadWriteTimeout { get; set; } - - /// - /// Internal Method so that RestClient can increase the number of attempts - /// - public void IncreaseNumAttempts() - { - Attempts++; - } - - /// - /// How many attempts were made to send this Request? - /// - /// - /// This Number is incremented each time the RestClient sends the request. - /// Useful when using Asynchronous Execution with Callbacks - /// - public int Attempts { get; private set; } - - private IRestRequest AddFile(FileParameter file) - { - Files.Add(file); - - return this; - } - - /// - /// Shortcut to AddParameter(name, value, UrlSegment) overload - /// - /// Name of the segment to add - /// Value of the segment to add - /// - public IRestRequest AddUrlSegment(string name, object value) - { - return AddParameter(name, value, ParameterType.UrlSegment); - } - } -} \ No newline at end of file diff --git a/RestSharp/RestRequestAsyncHandle.cs b/RestSharp/RestRequestAsyncHandle.cs deleted file mode 100644 index 7f304c2e9..000000000 --- a/RestSharp/RestRequestAsyncHandle.cs +++ /dev/null @@ -1,23 +0,0 @@ -using System.Net; - -namespace RestSharp -{ - public class RestRequestAsyncHandle - { - public HttpWebRequest WebRequest; - - public RestRequestAsyncHandle() - { - } - - public RestRequestAsyncHandle(HttpWebRequest webRequest) - { - WebRequest = webRequest; - } - - public void Abort() - { - WebRequest?.Abort(); - } - } -} \ No newline at end of file diff --git a/RestSharp/RestResponse.cs b/RestSharp/RestResponse.cs deleted file mode 100644 index 3ddf7d16d..000000000 --- a/RestSharp/RestResponse.cs +++ /dev/null @@ -1,193 +0,0 @@ -#region License - -// Copyright 2010 John Sheehan -// -// Licensed under the Apache License, Version 2.0 (the "License"); -// you may not use this file except in compliance with the License. -// You may obtain a copy of the License at -// -// http://www.apache.org/licenses/LICENSE-2.0 -// -// Unless required by applicable law or agreed to in writing, software -// distributed under the License is distributed on an "AS IS" BASIS, -// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -// See the License for the specific language governing permissions and -// limitations under the License. - -#endregion - -using System; -using System.Collections.Generic; -using System.Diagnostics; -using System.Net; -using RestSharp.Extensions; - -namespace RestSharp -{ - /// - /// Base class for common properties shared by RestResponse and RestResponse[[T]] - /// - [DebuggerDisplay("{" + nameof(DebuggerDisplay) + "()}")] - public abstract class RestResponseBase - { - private string content; - - /// - /// Default constructor - /// - protected RestResponseBase() - { - ResponseStatus = ResponseStatus.None; - Headers = new List(); - Cookies = new List(); - } - - /// - /// The RestRequest that was made to get this RestResponse - /// - /// - /// Mainly for debugging if ResponseStatus is not OK - /// - public IRestRequest Request { get; set; } - - /// - /// MIME content type of response - /// - public string ContentType { get; set; } - - /// - /// Length in bytes of the response content - /// - public long ContentLength { get; set; } - - /// - /// Encoding of the response content - /// - public string ContentEncoding { get; set; } - - /// - /// String representation of response content - /// - public string Content - { - get => content ?? (content = RawBytes.AsString()); - set => content = value; - } - - /// - /// HTTP response status code - /// - public HttpStatusCode StatusCode { get; set; } - - /// - /// Whether or not the response status code indicates success - /// - public bool IsSuccessful => (int) StatusCode >= 200 && (int) StatusCode <= 299 && - ResponseStatus == ResponseStatus.Completed; - - /// - /// Description of HTTP status returned - /// - public string StatusDescription { get; set; } - - /// - /// Response content - /// - public byte[] RawBytes { get; set; } - - /// - /// The URL that actually responded to the content (different from request if redirected) - /// - public Uri ResponseUri { get; set; } - - /// - /// HttpWebResponse.Server - /// - public string Server { get; set; } - - /// - /// Cookies returned by server with the response - /// - public IList Cookies { get; protected internal set; } - - /// - /// Headers returned by server with the response - /// - public IList Headers { get; protected internal set; } - - /// - /// Status of the request. Will return Error for transport errors. - /// HTTP errors will still return ResponseStatus.Completed, check StatusCode instead - /// - public ResponseStatus ResponseStatus { get; set; } - - /// - /// Transport or other non-HTTP error generated while attempting request - /// - public string ErrorMessage { get; set; } - - /// - /// The exception thrown during the request, if any - /// - public Exception ErrorException { get; set; } - - /// - /// The HTTP protocol version (1.0, 1.1, etc) - /// - /// Only set when underlying framework supports it. - public Version ProtocolVersion { get; set; } - - /// - /// Assists with debugging responses by displaying in the debugger output - /// - /// - protected string DebuggerDisplay() - { - return string.Format("StatusCode: {0}, Content-Type: {1}, Content-Length: {2})", - StatusCode, ContentType, ContentLength); - } - } - - /// - /// Container for data sent back from API including deserialized data - /// - /// Type of data to deserialize to - [DebuggerDisplay("{" + nameof(DebuggerDisplay) + "()}")] - public class RestResponse : RestResponseBase, IRestResponse - { - /// - /// Deserialized entity data - /// - public T Data { get; set; } - - public static explicit operator RestResponse(RestResponse response) - { - return new RestResponse - { - ContentEncoding = response.ContentEncoding, - ContentLength = response.ContentLength, - ContentType = response.ContentType, - Cookies = response.Cookies, - ErrorMessage = response.ErrorMessage, - ErrorException = response.ErrorException, - Headers = response.Headers, - RawBytes = response.RawBytes, - ResponseStatus = response.ResponseStatus, - ResponseUri = response.ResponseUri, - ProtocolVersion = response.ProtocolVersion, - Server = response.Server, - StatusCode = response.StatusCode, - StatusDescription = response.StatusDescription, - Request = response.Request - }; - } - } - - /// - /// Container for data sent back from API - /// - [DebuggerDisplay("{" + nameof(DebuggerDisplay) + "()}")] - public class RestResponse : RestResponseBase, IRestResponse - { - } -} \ No newline at end of file diff --git a/RestSharp/RestResponseCookie.cs b/RestSharp/RestResponseCookie.cs deleted file mode 100644 index ca36f7f9b..000000000 --- a/RestSharp/RestResponseCookie.cs +++ /dev/null @@ -1,77 +0,0 @@ -using System; - -namespace RestSharp -{ - public class RestResponseCookie - { - /// - /// Comment of the cookie - /// - public string Comment { get; set; } - - /// - /// Comment of the cookie - /// - public Uri CommentUri { get; set; } - - /// - /// Indicates whether the cookie should be discarded at the end of the session - /// - public bool Discard { get; set; } - - /// - /// Domain of the cookie - /// - public string Domain { get; set; } - - /// - /// Indicates whether the cookie is expired - /// - public bool Expired { get; set; } - - /// - /// Date and time that the cookie expires - /// - public DateTime Expires { get; set; } - - /// - /// Indicates that this cookie should only be accessed by the server - /// - public bool HttpOnly { get; set; } - - /// - /// Name of the cookie - /// - public string Name { get; set; } - - /// - /// Path of the cookie - /// - public string Path { get; set; } - - /// - /// Port of the cookie - /// - public string Port { get; set; } - - /// - /// Indicates that the cookie should only be sent over secure channels - /// - public bool Secure { get; set; } - - /// - /// Date and time the cookie was created - /// - public DateTime TimeStamp { get; set; } - - /// - /// Value of the cookie - /// - public string Value { get; set; } - - /// - /// Version of the cookie - /// - public int Version { get; set; } - } -} diff --git a/RestSharp/RestSharp.Signed.csproj b/RestSharp/RestSharp.Signed.csproj deleted file mode 100644 index 8257e845a..000000000 --- a/RestSharp/RestSharp.Signed.csproj +++ /dev/null @@ -1,29 +0,0 @@ - - - netstandard2.0;net452 - true - ..\RestSharp.snk - RestSharp - RestSharp - - - TRACE;DEBUG;NETSTANDARD2_0;SIGNED - bin\DebugSigned\net452\ - - - TRACE;DEBUG;NETSTANDARD2_0:SIGNED - bin\DebugSigned\netstandard2.0\ - - - - - - - - 4.3.0 - - - - - - \ No newline at end of file diff --git a/RestSharp/RestSharp.csproj b/RestSharp/RestSharp.csproj deleted file mode 100644 index b8800d5ee..000000000 --- a/RestSharp/RestSharp.csproj +++ /dev/null @@ -1,28 +0,0 @@ - - - netstandard2.0;net452 - For full release notes see https://github.com/restsharp/RestSharp/blob/master/releasenotes.md - https://github.com/restsharp/RestSharp/blob/master/restsharp.png - https://github.com/restsharp/RestSharp/blob/master/LICENSE.txt - http://restsharp.org - Simple REST and HTTP API Client - John Sheehan, RestSharp Community - 106.0.0 - true - ..\RestSharp.snk - true - true - true - - - - All - - - - - - - - - \ No newline at end of file diff --git a/RestSharp/Serializers/JsonSerializer.cs b/RestSharp/Serializers/JsonSerializer.cs deleted file mode 100644 index 978b83ead..000000000 --- a/RestSharp/Serializers/JsonSerializer.cs +++ /dev/null @@ -1,48 +0,0 @@ - -namespace RestSharp.Serializers -{ - /// - /// Default JSON serializer for request bodies - /// Doesn't currently use the SerializeAs attribute, defers to Newtonsoft's attributes - /// - public class JsonSerializer : ISerializer - { - /// - /// Default serializer - /// - public JsonSerializer() - { - ContentType = "application/json"; - } - - /// - /// Serialize the object as JSON - /// - /// Object to serialize - /// JSON as String - public string Serialize(object obj) - { - return SimpleJson.SimpleJson.SerializeObject(obj); - } - - /// - /// Unused for JSON Serialization - /// - public string DateFormat { get; set; } - - /// - /// Unused for JSON Serialization - /// - public string RootElement { get; set; } - - /// - /// Unused for JSON Serialization - /// - public string Namespace { get; set; } - - /// - /// Content type for serialized content - /// - public string ContentType { get; set; } - } -} diff --git a/RestSharp/Serializers/SerializeAsAttribute.cs b/RestSharp/Serializers/SerializeAsAttribute.cs deleted file mode 100644 index 028ba5f90..000000000 --- a/RestSharp/Serializers/SerializeAsAttribute.cs +++ /dev/null @@ -1,100 +0,0 @@ -#region License - -// Copyright 2010 John Sheehan -// -// Licensed under the Apache License, Version 2.0 (the "License"); -// you may not use this file except in compliance with the License. -// You may obtain a copy of the License at -// -// http://www.apache.org/licenses/LICENSE-2.0 -// -// Unless required by applicable law or agreed to in writing, software -// distributed under the License is distributed on an "AS IS" BASIS, -// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -// See the License for the specific language governing permissions and -// limitations under the License. - -#endregion - -using System; -using RestSharp.Extensions; -using System.Globalization; - -namespace RestSharp.Serializers -{ - /// - /// Allows control how class and property names and values are serialized by XmlSerializer - /// Currently not supported with the JsonSerializer - /// When specified at the property level the class-level specification is overridden - /// - [AttributeUsage(AttributeTargets.Property | AttributeTargets.Class, Inherited = false)] - public sealed class SerializeAsAttribute : Attribute - { - public SerializeAsAttribute() - { - this.NameStyle = NameStyle.AsIs; - this.Index = int.MaxValue; - this.Culture = CultureInfo.InvariantCulture; - } - - /// - /// The name to use for the serialized element - /// - public string Name { get; set; } - - /// - /// Sets the value to be serialized as an Attribute instead of an Element - /// - public bool Attribute { get; set; } - - /// - /// The culture to use when serializing - /// - public CultureInfo Culture { get; set; } - - /// - /// Transforms the casing of the name based on the selected value. - /// - public NameStyle NameStyle { get; set; } - - /// - /// The order to serialize the element. Default is int.MaxValue. - /// - public int Index { get; set; } - - /// - /// Called by the attribute when NameStyle is speficied - /// - /// The string to transform - /// String - public string TransformName(string input) - { - string name = this.Name ?? input; - - switch (this.NameStyle) - { - case NameStyle.CamelCase: - return name.ToCamelCase(this.Culture); - - case NameStyle.PascalCase: - return name.ToPascalCase(this.Culture); - - case NameStyle.LowerCase: - return name.ToLower(); - } - - return input; - } - } - - /// - /// Options for transforming casing of element names - /// - public enum NameStyle - { - AsIs, - CamelCase, - LowerCase, - PascalCase - } -} diff --git a/RestSharp/Serializers/XmlSerializer.cs b/RestSharp/Serializers/XmlSerializer.cs deleted file mode 100644 index bf16ef840..000000000 --- a/RestSharp/Serializers/XmlSerializer.cs +++ /dev/null @@ -1,283 +0,0 @@ -#region License - -// Copyright 2010 John Sheehan -// -// Licensed under the Apache License, Version 2.0 (the "License"); -// you may not use this file except in compliance with the License. -// You may obtain a copy of the License at -// -// http://www.apache.org/licenses/LICENSE-2.0 -// -// Unless required by applicable law or agreed to in writing, software -// distributed under the License is distributed on an "AS IS" BASIS, -// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -// See the License for the specific language governing permissions and -// limitations under the License. - -#endregion - -using System; -using System.Collections; -using System.Globalization; -using System.Linq; -using System.Reflection; -using System.Xml.Linq; -using RestSharp.Extensions; - -namespace RestSharp.Serializers -{ - /// - /// Default XML Serializer - /// - public class XmlSerializer : ISerializer - { - /// - /// Default constructor, does not specify namespace - /// - public XmlSerializer() - { - ContentType = "text/xml"; - } - - /// - /// Specify the namespaced to be used when serializing - /// - /// XML namespace - public XmlSerializer(string @namespace) - { - Namespace = @namespace; - ContentType = "text/xml"; - } - - /// - /// Serialize the object as XML - /// - /// Object to serialize - /// XML as string - public string Serialize(object obj) - { - var doc = new XDocument(); - var t = obj.GetType(); - var name = t.Name; - var options = t.GetAttribute(); - - if (options != null) - name = options.TransformName(options.Name ?? name); - - var root = new XElement(name.AsNamespaced(Namespace)); - - if (obj is IList list) - { - var itemTypeName = ""; - - foreach (var item in list) - { - var type = item.GetType(); - var opts = type.GetAttribute(); - - if (opts != null) - itemTypeName = opts.TransformName(opts.Name ?? name); - - if (itemTypeName == "") - itemTypeName = type.Name; - - var instance = new XElement(itemTypeName.AsNamespaced(Namespace)); - - Map(instance, item); - root.Add(instance); - } - } - else - { - Map(root, obj); - } - - if (RootElement.HasValue()) - { - var wrapper = new XElement(RootElement.AsNamespaced(Namespace), root); - doc.Add(wrapper); - } - else - { - doc.Add(root); - } - - return doc.ToString(); - } - - /// - /// Name of the root element to use when serializing - /// - public string RootElement { get; set; } - - /// - /// XML namespace to use when serializing - /// - public string Namespace { get; set; } - - /// - /// Format string to use when serializing dates - /// - public string DateFormat { get; set; } - - /// - /// Content type for serialized content - /// - public string ContentType { get; set; } - - private void Map(XContainer root, object obj) - { - var objType = obj.GetType(); - var props = from p in objType.GetTypeInfo().GetProperties() - let indexAttribute = p.GetAttribute() - where p.CanRead && p.CanWrite - orderby indexAttribute?.Index ?? int.MaxValue - select p; - var globalOptions = objType.GetAttribute(); - - foreach (var prop in props) - { - var name = prop.Name; - var rawValue = prop.GetValue(obj, null); - - if (rawValue == null) - continue; - - var value = GetSerializedValue(rawValue); - var propType = prop.PropertyType; - var useAttribute = false; - var settings = prop.GetAttribute(); - - if (settings != null) - { - name = settings.Name.HasValue() - ? settings.Name - : name; - useAttribute = settings.Attribute; - } - - var options = prop.GetAttribute(); - - if (options != null) - name = options.TransformName(name); - else if (globalOptions != null) - name = globalOptions.TransformName(name); - - var nsName = name.AsNamespaced(Namespace); - var element = new XElement(nsName); - if (propType.GetTypeInfo().IsPrimitive || propType.GetTypeInfo().IsValueType || - propType == typeof(string)) - { - if (useAttribute) - { - root.Add(new XAttribute(name, value)); - continue; - } - - element.Value = value; - } - else if (rawValue is IList) - { - var itemTypeName = ""; - - foreach (var item in (IList) rawValue) - { - if (itemTypeName == "") - { - var type = item.GetType(); - var setting = type.GetAttribute(); - - itemTypeName = setting != null && setting.Name.HasValue() - ? setting.Name - : type.Name; - } - - var instance = new XElement(itemTypeName.AsNamespaced(Namespace)); - - Map(instance, item); - element.Add(instance); - } - } - else - { - Map(element, rawValue); - } - - root.Add(element); - } - } - - private string GetSerializedValue(object obj) - { - var output = obj; - - switch (obj) - { - case DateTime time when DateFormat.HasValue(): - output = time.ToString(DateFormat, CultureInfo.InvariantCulture); - break; - case bool _: - output = ((bool) obj).ToString().ToLowerInvariant(); - break; - } - - return IsNumeric(obj) ? SerializeNumber(obj) : output.ToString(); - } - - private static string SerializeNumber(object number) - { - switch (number) - { - case long l: - return l.ToString(CultureInfo.InvariantCulture); - case ulong @ulong: - return @ulong.ToString(CultureInfo.InvariantCulture); - case int i: - return i.ToString(CultureInfo.InvariantCulture); - case uint u: - return u.ToString(CultureInfo.InvariantCulture); - case decimal @decimal: - return @decimal.ToString(CultureInfo.InvariantCulture); - case float f: - return f.ToString(CultureInfo.InvariantCulture); - } - - return Convert.ToDouble(number, CultureInfo.InvariantCulture).ToString("r", CultureInfo.InvariantCulture); - } - - /// - /// Determines if a given object is numeric in any way - /// (can be integer, double, null, etc). - /// - private static bool IsNumeric(object value) - { - switch (value) - { - case sbyte _: - return true; - case byte _: - return true; - case short _: - return true; - case ushort _: - return true; - case int _: - return true; - case uint _: - return true; - case long _: - return true; - case ulong _: - return true; - case float _: - return true; - case double _: - return true; - case decimal _: - return true; - } - - return false; - } - } -} \ No newline at end of file diff --git a/RestSharp/SimpleJson.cs b/RestSharp/SimpleJson.cs deleted file mode 100644 index 74d462054..000000000 --- a/RestSharp/SimpleJson.cs +++ /dev/null @@ -1,2127 +0,0 @@ -//----------------------------------------------------------------------- -// -// Copyright (c) 2011, The Outercurve Foundation. -// -// Licensed under the MIT License (the "License"); -// you may not use this file except in compliance with the License. -// You may obtain a copy of the License at -// http://www.opensource.org/licenses/mit-license.php -// -// Unless required by applicable law or agreed to in writing, software -// distributed under the License is distributed on an "AS IS" BASIS, -// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -// See the License for the specific language governing permissions and -// limitations under the License. -// -// Nathan Totten (ntotten.com), Jim Zimmerman (jimzimmerman.com) and Prabir Shrestha (prabir.me) -// https://github.com/facebook-csharp-sdk/simple-json -//----------------------------------------------------------------------- - -// VERSION: - -// NOTE: uncomment the following line to make SimpleJson class internal. -//#define SIMPLE_JSON_INTERNAL - -// NOTE: uncomment the following line to make JsonArray and JsonObject class internal. -//#define SIMPLE_JSON_OBJARRAYINTERNAL - -// NOTE: uncomment the following line to enable dynamic support. -//#define SIMPLE_JSON_DYNAMIC - -// NOTE: uncomment the following line to enable DataContract support. -//#define SIMPLE_JSON_DATACONTRACT - -// NOTE: uncomment the following line to enable IReadOnlyCollection and IReadOnlyList support. -//#define SIMPLE_JSON_READONLY_COLLECTIONS - -// NOTE: uncomment the following line to disable linq expressions/compiled lambda (better performance) instead of method.invoke(). -// define if you are using .net framework <= 3.0 or < WP7.5 -//#define SIMPLE_JSON_NO_LINQ_EXPRESSION - -// NOTE: uncomment the following line if you are compiling under Window Metro style application/library. -// usually already defined in properties -//#define NETFX_CORE; - -// If you are targetting WinStore, WP8 and NET4.5+ PCL make sure to #define SIMPLE_JSON_TYPEINFO; - -// original json parsing code from http://techblog.procurios.nl/k/618/news/view/14605/14863/How-do-I-write-my-own-parser-for-JSON.html - -#if NETFX_CORE -#define SIMPLE_JSON_TYPEINFO -#endif - -using System; -using System.CodeDom.Compiler; -using System.Collections; -using System.Collections.Generic; -#if !SIMPLE_JSON_NO_LINQ_EXPRESSION -using System.Linq.Expressions; -#endif -using System.ComponentModel; -using System.Diagnostics.CodeAnalysis; -#if SIMPLE_JSON_DYNAMIC -using System.Dynamic; -#endif -using System.Globalization; -using System.Reflection; -using System.Runtime.Serialization; -using System.Text; -using SimpleJson.Reflection; - -// ReSharper disable LoopCanBeConvertedToQuery -// ReSharper disable RedundantExplicitArrayCreation -// ReSharper disable SuggestUseVarKeywordEvident -namespace SimpleJson -{ - /// - /// Represents the json array. - /// - [GeneratedCode("simple-json", "1.0.0")] - [EditorBrowsable(EditorBrowsableState.Never)] - [SuppressMessage("Microsoft.Naming", "CA1710:IdentifiersShouldHaveCorrectSuffix")] -#if SIMPLE_JSON_OBJARRAYINTERNAL - internal -#else - public -#endif - class JsonArray : List - { - /// - /// Initializes a new instance of the class. - /// - public JsonArray() { } - - /// - /// Initializes a new instance of the class. - /// - /// The capacity of the json array. - public JsonArray(int capacity) : base(capacity) { } - - /// - /// The json representation of the array. - /// - /// The json representation of the array. - public override string ToString() - { - return SimpleJson.SerializeObject(this) ?? string.Empty; - } - } - - /// - /// Represents the json object. - /// - [GeneratedCode("simple-json", "1.0.0")] - [EditorBrowsable(EditorBrowsableState.Never)] - [SuppressMessage("Microsoft.Naming", "CA1710:IdentifiersShouldHaveCorrectSuffix")] -#if SIMPLE_JSON_OBJARRAYINTERNAL - internal -#else - public -#endif - class JsonObject : -#if SIMPLE_JSON_DYNAMIC - DynamicObject, -#endif - IDictionary - { - /// - /// The internal member dictionary. - /// - private readonly Dictionary _members; - - /// - /// Initializes a new instance of . - /// - public JsonObject() - { - _members = new Dictionary(); - } - - /// - /// Initializes a new instance of . - /// - /// The implementation to use when comparing keys, or null to use the default for the type of the key. - public JsonObject(IEqualityComparer comparer) - { - _members = new Dictionary(comparer); - } - - /// - /// Gets the at the specified index. - /// - /// - public object this[int index] - { - get { return GetAtIndex(_members, index); } - } - - internal static object GetAtIndex(IDictionary obj, int index) - { - if (obj == null) - throw new ArgumentNullException("obj"); - if (index >= obj.Count) - throw new ArgumentOutOfRangeException("index"); - int i = 0; - foreach (KeyValuePair o in obj) - if (i++ == index) return o.Value; - return null; - } - - /// - /// Adds the specified key. - /// - /// The key. - /// The value. - public void Add(string key, object value) - { - _members.Add(key, value); - } - - /// - /// Determines whether the specified key contains key. - /// - /// The key. - /// - /// true if the specified key contains key; otherwise, false. - /// - public bool ContainsKey(string key) - { - return _members.ContainsKey(key); - } - - /// - /// Gets the keys. - /// - /// The keys. - public ICollection Keys - { - get { return _members.Keys; } - } - - /// - /// Removes the specified key. - /// - /// The key. - /// - public bool Remove(string key) - { - return _members.Remove(key); - } - - /// - /// Tries the get value. - /// - /// The key. - /// The value. - /// - public bool TryGetValue(string key, out object value) - { - return _members.TryGetValue(key, out value); - } - - /// - /// Gets the values. - /// - /// The values. - public ICollection Values - { - get { return _members.Values; } - } - - /// - /// Gets or sets the with the specified key. - /// - /// - public object this[string key] - { - get { return _members[key]; } - set { _members[key] = value; } - } - - /// - /// Adds the specified item. - /// - /// The item. - public void Add(KeyValuePair item) - { - _members.Add(item.Key, item.Value); - } - - /// - /// Clears this instance. - /// - public void Clear() - { - _members.Clear(); - } - - /// - /// Determines whether [contains] [the specified item]. - /// - /// The item. - /// - /// true if [contains] [the specified item]; otherwise, false. - /// - public bool Contains(KeyValuePair item) - { - return _members.ContainsKey(item.Key) && _members[item.Key] == item.Value; - } - - /// - /// Copies to. - /// - /// The array. - /// Index of the array. - public void CopyTo(KeyValuePair[] array, int arrayIndex) - { - if (array == null) throw new ArgumentNullException("array"); - int num = Count; - foreach (KeyValuePair kvp in this) - { - array[arrayIndex++] = kvp; - if (--num <= 0) - return; - } - } - - /// - /// Gets the count. - /// - /// The count. - public int Count - { - get { return _members.Count; } - } - - /// - /// Gets a value indicating whether this instance is read only. - /// - /// - /// true if this instance is read only; otherwise, false. - /// - public bool IsReadOnly - { - get { return false; } - } - - /// - /// Removes the specified item. - /// - /// The item. - /// - public bool Remove(KeyValuePair item) - { - return _members.Remove(item.Key); - } - - /// - /// Gets the enumerator. - /// - /// - public IEnumerator> GetEnumerator() - { - return _members.GetEnumerator(); - } - - /// - /// Returns an enumerator that iterates through a collection. - /// - /// - /// An object that can be used to iterate through the collection. - /// - IEnumerator IEnumerable.GetEnumerator() - { - return _members.GetEnumerator(); - } - - /// - /// Returns a json that represents the current . - /// - /// - /// A json that represents the current . - /// - public override string ToString() - { - return SimpleJson.SerializeObject(this); - } - -#if SIMPLE_JSON_DYNAMIC - /// - /// Provides implementation for type conversion operations. Classes derived from the class can override this method to specify dynamic behavior for operations that convert an object from one type to another. - /// - /// Provides information about the conversion operation. The binder.Type property provides the type to which the object must be converted. For example, for the statement (String)sampleObject in C# (CType(sampleObject, Type) in Visual Basic), where sampleObject is an instance of the class derived from the class, binder.Type returns the type. The binder.Explicit property provides information about the kind of conversion that occurs. It returns true for explicit conversion and false for implicit conversion. - /// The result of the type conversion operation. - /// - /// Alwasy returns true. - /// - public override bool TryConvert(ConvertBinder binder, out object result) - { - // - if (binder == null) - throw new ArgumentNullException("binder"); - // - Type targetType = binder.Type; - - if ((targetType == typeof(IEnumerable)) || - (targetType == typeof(IEnumerable>)) || - (targetType == typeof(IDictionary)) || - (targetType == typeof(IDictionary))) - { - result = this; - return true; - } - - return base.TryConvert(binder, out result); - } - - /// - /// Provides the implementation for operations that delete an object member. This method is not intended for use in C# or Visual Basic. - /// - /// Provides information about the deletion. - /// - /// Alwasy returns true. - /// - public override bool TryDeleteMember(DeleteMemberBinder binder) - { - // - if (binder == null) - throw new ArgumentNullException("binder"); - // - return _members.Remove(binder.Name); - } - - /// - /// Provides the implementation for operations that get a value by index. Classes derived from the class can override this method to specify dynamic behavior for indexing operations. - /// - /// Provides information about the operation. - /// The indexes that are used in the operation. For example, for the sampleObject[3] operation in C# (sampleObject(3) in Visual Basic), where sampleObject is derived from the DynamicObject class, is equal to 3. - /// The result of the index operation. - /// - /// Alwasy returns true. - /// - public override bool TryGetIndex(GetIndexBinder binder, object[] indexes, out object result) - { - if (indexes == null) throw new ArgumentNullException("indexes"); - if (indexes.Length == 1) - { - result = ((IDictionary)this)[(string)indexes[0]]; - return true; - } - result = null; - return true; - } - - /// - /// Provides the implementation for operations that get member values. Classes derived from the class can override this method to specify dynamic behavior for operations such as getting a value for a property. - /// - /// Provides information about the object that called the dynamic operation. The binder.Name property provides the name of the member on which the dynamic operation is performed. For example, for the Console.WriteLine(sampleObject.SampleProperty) statement, where sampleObject is an instance of the class derived from the class, binder.Name returns "SampleProperty". The binder.IgnoreCase property specifies whether the member name is case-sensitive. - /// The result of the get operation. For example, if the method is called for a property, you can assign the property value to . - /// - /// Alwasy returns true. - /// - public override bool TryGetMember(GetMemberBinder binder, out object result) - { - object value; - if (_members.TryGetValue(binder.Name, out value)) - { - result = value; - return true; - } - result = null; - return true; - } - - /// - /// Provides the implementation for operations that set a value by index. Classes derived from the class can override this method to specify dynamic behavior for operations that access objects by a specified index. - /// - /// Provides information about the operation. - /// The indexes that are used in the operation. For example, for the sampleObject[3] = 10 operation in C# (sampleObject(3) = 10 in Visual Basic), where sampleObject is derived from the class, is equal to 3. - /// The value to set to the object that has the specified index. For example, for the sampleObject[3] = 10 operation in C# (sampleObject(3) = 10 in Visual Basic), where sampleObject is derived from the class, is equal to 10. - /// - /// true if the operation is successful; otherwise, false. If this method returns false, the run-time binder of the language determines the behavior. (In most cases, a language-specific run-time exception is thrown. - /// - public override bool TrySetIndex(SetIndexBinder binder, object[] indexes, object value) - { - if (indexes == null) throw new ArgumentNullException("indexes"); - if (indexes.Length == 1) - { - ((IDictionary)this)[(string)indexes[0]] = value; - return true; - } - return base.TrySetIndex(binder, indexes, value); - } - - /// - /// Provides the implementation for operations that set member values. Classes derived from the class can override this method to specify dynamic behavior for operations such as setting a value for a property. - /// - /// Provides information about the object that called the dynamic operation. The binder.Name property provides the name of the member to which the value is being assigned. For example, for the statement sampleObject.SampleProperty = "Test", where sampleObject is an instance of the class derived from the class, binder.Name returns "SampleProperty". The binder.IgnoreCase property specifies whether the member name is case-sensitive. - /// The value to set to the member. For example, for sampleObject.SampleProperty = "Test", where sampleObject is an instance of the class derived from the class, the is "Test". - /// - /// true if the operation is successful; otherwise, false. If this method returns false, the run-time binder of the language determines the behavior. (In most cases, a language-specific run-time exception is thrown.) - /// - public override bool TrySetMember(SetMemberBinder binder, object value) - { - // - if (binder == null) - throw new ArgumentNullException("binder"); - // - _members[binder.Name] = value; - return true; - } - - /// - /// Returns the enumeration of all dynamic member names. - /// - /// - /// A sequence that contains dynamic member names. - /// - public override IEnumerable GetDynamicMemberNames() - { - foreach (var key in Keys) - yield return key; - } -#endif - } -} - -namespace SimpleJson -{ - /// - /// This class encodes and decodes JSON strings. - /// Spec. details, see http://www.json.org/ - /// - /// JSON uses Arrays and Objects. These correspond here to the datatypes JsonArray(IList<object>) and JsonObject(IDictionary<string,object>). - /// All numbers are parsed to doubles. - /// - [GeneratedCode("simple-json", "1.0.0")] -#if SIMPLE_JSON_INTERNAL - internal -#else - public -#endif - static class SimpleJson - { - private const int TOKEN_NONE = 0; - private const int TOKEN_CURLY_OPEN = 1; - private const int TOKEN_CURLY_CLOSE = 2; - private const int TOKEN_SQUARED_OPEN = 3; - private const int TOKEN_SQUARED_CLOSE = 4; - private const int TOKEN_COLON = 5; - private const int TOKEN_COMMA = 6; - private const int TOKEN_STRING = 7; - private const int TOKEN_NUMBER = 8; - private const int TOKEN_TRUE = 9; - private const int TOKEN_FALSE = 10; - private const int TOKEN_NULL = 11; - private const int BUILDER_CAPACITY = 2000; - - private static readonly char[] EscapeTable; - private static readonly char[] EscapeCharacters = new char[] { '"', '\\', '\b', '\f', '\n', '\r', '\t' }; - private static readonly string EscapeCharactersString = new string(EscapeCharacters); - - static SimpleJson() - { - EscapeTable = new char[93]; - EscapeTable['"'] = '"'; - EscapeTable['\\'] = '\\'; - EscapeTable['\b'] = 'b'; - EscapeTable['\f'] = 'f'; - EscapeTable['\n'] = 'n'; - EscapeTable['\r'] = 'r'; - EscapeTable['\t'] = 't'; - } - - /// - /// Parses the string json into a value - /// - /// A JSON string. - /// An IList<object>, a IDictionary<string,object>, a double, a string, null, true, or false - public static object DeserializeObject(string json) - { - object obj; - if (TryDeserializeObject(json, out obj)) - return obj; - throw new SerializationException("Invalid JSON string"); - } - - /// - /// Try parsing the json string into a value. - /// - /// - /// A JSON string. - /// - /// - /// The object. - /// - /// - /// Returns true if successfull otherwise false. - /// - [SuppressMessage("Microsoft.Design", "CA1007:UseGenericsWhereAppropriate", Justification="Need to support .NET 2")] - public static bool TryDeserializeObject(string json, out object obj) - { - bool success = true; - if (json != null) - { - char[] charArray = json.ToCharArray(); - int index = 0; - obj = ParseValue(charArray, ref index, ref success); - } - else - obj = null; - - return success; - } - - public static object DeserializeObject(string json, Type type, IJsonSerializerStrategy jsonSerializerStrategy) - { - object jsonObject = DeserializeObject(json); - return type == null || jsonObject != null && ReflectionUtils.IsAssignableFrom(jsonObject.GetType(), type) - ? jsonObject - : (jsonSerializerStrategy ?? CurrentJsonSerializerStrategy).DeserializeObject(jsonObject, type); - } - - public static object DeserializeObject(string json, Type type) - { - return DeserializeObject(json, type, null); - } - - public static T DeserializeObject(string json, IJsonSerializerStrategy jsonSerializerStrategy) - { - return (T)DeserializeObject(json, typeof(T), jsonSerializerStrategy); - } - - public static T DeserializeObject(string json) - { - return (T)DeserializeObject(json, typeof(T), null); - } - - /// - /// Converts a IDictionary<string,object> / IList<object> object into a JSON string - /// - /// A IDictionary<string,object> / IList<object> - /// Serializer strategy to use - /// A JSON encoded string, or null if object 'json' is not serializable - public static string SerializeObject(object json, IJsonSerializerStrategy jsonSerializerStrategy) - { - StringBuilder builder = new StringBuilder(BUILDER_CAPACITY); - bool success = SerializeValue(jsonSerializerStrategy, json, builder); - return (success ? builder.ToString() : null); - } - - public static string SerializeObject(object json) - { - return SerializeObject(json, CurrentJsonSerializerStrategy); - } - - public static string EscapeToJavascriptString(string jsonString) - { - if (string.IsNullOrEmpty(jsonString)) - return jsonString; - - StringBuilder sb = new StringBuilder(); - char c; - - for (int i = 0; i < jsonString.Length; ) - { - c = jsonString[i++]; - - if (c == '\\') - { - int remainingLength = jsonString.Length - i; - if (remainingLength >= 2) - { - char lookahead = jsonString[i]; - if (lookahead == '\\') - { - sb.Append('\\'); - ++i; - } - else if (lookahead == '"') - { - sb.Append("\""); - ++i; - } - else if (lookahead == 't') - { - sb.Append('\t'); - ++i; - } - else if (lookahead == 'b') - { - sb.Append('\b'); - ++i; - } - else if (lookahead == 'n') - { - sb.Append('\n'); - ++i; - } - else if (lookahead == 'r') - { - sb.Append('\r'); - ++i; - } - } - } - else - { - sb.Append(c); - } - } - return sb.ToString(); - } - - static IDictionary ParseObject(char[] json, ref int index, ref bool success) - { - IDictionary table = new JsonObject(); - int token; - - // { - NextToken(json, ref index); - - bool done = false; - while (!done) - { - token = LookAhead(json, index); - if (token == TOKEN_NONE) - { - success = false; - return null; - } - else if (token == TOKEN_COMMA) - NextToken(json, ref index); - else if (token == TOKEN_CURLY_CLOSE) - { - NextToken(json, ref index); - return table; - } - else - { - // name - string name = ParseString(json, ref index, ref success); - if (!success) - { - success = false; - return null; - } - // : - token = NextToken(json, ref index); - if (token != TOKEN_COLON) - { - success = false; - return null; - } - // value - object value = ParseValue(json, ref index, ref success); - if (!success) - { - success = false; - return null; - } - table[name] = value; - } - } - return table; - } - - static JsonArray ParseArray(char[] json, ref int index, ref bool success) - { - JsonArray array = new JsonArray(); - - // [ - NextToken(json, ref index); - - bool done = false; - while (!done) - { - int token = LookAhead(json, index); - if (token == TOKEN_NONE) - { - success = false; - return null; - } - else if (token == TOKEN_COMMA) - NextToken(json, ref index); - else if (token == TOKEN_SQUARED_CLOSE) - { - NextToken(json, ref index); - break; - } - else - { - object value = ParseValue(json, ref index, ref success); - if (!success) - return null; - array.Add(value); - } - } - return array; - } - - static object ParseValue(char[] json, ref int index, ref bool success) - { - switch (LookAhead(json, index)) - { - case TOKEN_STRING: - return ParseString(json, ref index, ref success); - case TOKEN_NUMBER: - return ParseNumber(json, ref index, ref success); - case TOKEN_CURLY_OPEN: - return ParseObject(json, ref index, ref success); - case TOKEN_SQUARED_OPEN: - return ParseArray(json, ref index, ref success); - case TOKEN_TRUE: - NextToken(json, ref index); - return true; - case TOKEN_FALSE: - NextToken(json, ref index); - return false; - case TOKEN_NULL: - NextToken(json, ref index); - return null; - case TOKEN_NONE: - break; - } - success = false; - return null; - } - - static string ParseString(char[] json, ref int index, ref bool success) - { - StringBuilder s = new StringBuilder(BUILDER_CAPACITY); - char c; - - EatWhitespace(json, ref index); - - // " - c = json[index++]; - bool complete = false; - while (!complete) - { - if (index == json.Length) - break; - - c = json[index++]; - if (c == '"') - { - complete = true; - break; - } - else if (c == '\\') - { - if (index == json.Length) - break; - c = json[index++]; - if (c == '"') - s.Append('"'); - else if (c == '\\') - s.Append('\\'); - else if (c == '/') - s.Append('/'); - else if (c == 'b') - s.Append('\b'); - else if (c == 'f') - s.Append('\f'); - else if (c == 'n') - s.Append('\n'); - else if (c == 'r') - s.Append('\r'); - else if (c == 't') - s.Append('\t'); - else if (c == 'u') - { - int remainingLength = json.Length - index; - if (remainingLength >= 4) - { - // parse the 32 bit hex into an integer codepoint - uint codePoint; - if (!(success = UInt32.TryParse(new string(json, index, 4), NumberStyles.HexNumber, CultureInfo.InvariantCulture, out codePoint))) - return ""; - - // convert the integer codepoint to a unicode char and add to string - if (0xD800 <= codePoint && codePoint <= 0xDBFF) // if high surrogate - { - index += 4; // skip 4 chars - remainingLength = json.Length - index; - if (remainingLength >= 6) - { - uint lowCodePoint; - if (new string(json, index, 2) == "\\u" && UInt32.TryParse(new string(json, index + 2, 4), NumberStyles.HexNumber, CultureInfo.InvariantCulture, out lowCodePoint)) - { - if (0xDC00 <= lowCodePoint && lowCodePoint <= 0xDFFF) // if low surrogate - { - s.Append((char)codePoint); - s.Append((char)lowCodePoint); - index += 6; // skip 6 chars - continue; - } - } - } - success = false; // invalid surrogate pair - return ""; - } - s.Append(ConvertFromUtf32((int)codePoint)); - // skip 4 chars - index += 4; - } - else - break; - } - } - else - s.Append(c); - } - if (!complete) - { - success = false; - return null; - } - return s.ToString(); - } - - private static string ConvertFromUtf32(int utf32) - { - // http://www.java2s.com/Open-Source/CSharp/2.6.4-mono-.net-core/System/System/Char.cs.htm - if (utf32 < 0 || utf32 > 0x10FFFF) - throw new ArgumentOutOfRangeException("utf32", "The argument must be from 0 to 0x10FFFF."); - if (0xD800 <= utf32 && utf32 <= 0xDFFF) - throw new ArgumentOutOfRangeException("utf32", "The argument must not be in surrogate pair range."); - if (utf32 < 0x10000) - return new string((char)utf32, 1); - utf32 -= 0x10000; - return new string(new char[] { (char)((utf32 >> 10) + 0xD800), (char)(utf32 % 0x0400 + 0xDC00) }); - } - - static object ParseNumber(char[] json, ref int index, ref bool success) - { - EatWhitespace(json, ref index); - int lastIndex = GetLastIndexOfNumber(json, index); - int charLength = (lastIndex - index) + 1; - object returnNumber; - string str = new string(json, index, charLength); - if (str.IndexOf(".", StringComparison.OrdinalIgnoreCase) != -1 || str.IndexOf("e", StringComparison.OrdinalIgnoreCase) != -1) - { - double number; - success = double.TryParse(new string(json, index, charLength), NumberStyles.Any, CultureInfo.InvariantCulture, out number); - returnNumber = number; - } - else - { - long number; - success = long.TryParse(new string(json, index, charLength), NumberStyles.Any, CultureInfo.InvariantCulture, out number); - returnNumber = number; - } - index = lastIndex + 1; - return returnNumber; - } - - static int GetLastIndexOfNumber(char[] json, int index) - { - int lastIndex; - for (lastIndex = index; lastIndex < json.Length; lastIndex++) - if ("0123456789+-.eE".IndexOf(json[lastIndex]) == -1) break; - return lastIndex - 1; - } - - static void EatWhitespace(char[] json, ref int index) - { - for (; index < json.Length; index++) - if (" \t\n\r\b\f".IndexOf(json[index]) == -1) break; - } - - static int LookAhead(char[] json, int index) - { - int saveIndex = index; - return NextToken(json, ref saveIndex); - } - - [SuppressMessage("Microsoft.Maintainability", "CA1502:AvoidExcessiveComplexity")] - static int NextToken(char[] json, ref int index) - { - EatWhitespace(json, ref index); - if (index == json.Length) - return TOKEN_NONE; - char c = json[index]; - index++; - switch (c) - { - case '{': - return TOKEN_CURLY_OPEN; - case '}': - return TOKEN_CURLY_CLOSE; - case '[': - return TOKEN_SQUARED_OPEN; - case ']': - return TOKEN_SQUARED_CLOSE; - case ',': - return TOKEN_COMMA; - case '"': - return TOKEN_STRING; - case '0': - case '1': - case '2': - case '3': - case '4': - case '5': - case '6': - case '7': - case '8': - case '9': - case '-': - return TOKEN_NUMBER; - case ':': - return TOKEN_COLON; - } - index--; - int remainingLength = json.Length - index; - // false - if (remainingLength >= 5) - { - if (json[index] == 'f' && json[index + 1] == 'a' && json[index + 2] == 'l' && json[index + 3] == 's' && json[index + 4] == 'e') - { - index += 5; - return TOKEN_FALSE; - } - } - // true - if (remainingLength >= 4) - { - if (json[index] == 't' && json[index + 1] == 'r' && json[index + 2] == 'u' && json[index + 3] == 'e') - { - index += 4; - return TOKEN_TRUE; - } - } - // null - if (remainingLength >= 4) - { - if (json[index] == 'n' && json[index + 1] == 'u' && json[index + 2] == 'l' && json[index + 3] == 'l') - { - index += 4; - return TOKEN_NULL; - } - } - return TOKEN_NONE; - } - - static bool SerializeValue(IJsonSerializerStrategy jsonSerializerStrategy, object value, StringBuilder builder) - { - bool success = true; - string stringValue = value as string; - if (stringValue != null) - success = SerializeString(stringValue, builder); - else - { - IDictionary dict = value as IDictionary; - if (dict != null) - { - success = SerializeObject(jsonSerializerStrategy, dict.Keys, dict.Values, builder); - } - else - { - IDictionary stringDictionary = value as IDictionary; - if (stringDictionary != null) - { - success = SerializeObject(jsonSerializerStrategy, stringDictionary.Keys, stringDictionary.Values, builder); - } - else - { - IEnumerable enumerableValue = value as IEnumerable; - if (enumerableValue != null) - success = SerializeArray(jsonSerializerStrategy, enumerableValue, builder); - else if (IsNumeric(value)) - success = SerializeNumber(value, builder); - else if (value is bool) - builder.Append((bool)value ? "true" : "false"); - else if (value == null) - builder.Append("null"); - else - { - object serializedObject; - success = jsonSerializerStrategy.TrySerializeNonPrimitiveObject(value, out serializedObject); - if (success) - SerializeValue(jsonSerializerStrategy, serializedObject, builder); - } - } - } - } - return success; - } - - static bool SerializeObject(IJsonSerializerStrategy jsonSerializerStrategy, IEnumerable keys, IEnumerable values, StringBuilder builder) - { - builder.Append("{"); - IEnumerator ke = keys.GetEnumerator(); - IEnumerator ve = values.GetEnumerator(); - bool first = true; - while (ke.MoveNext() && ve.MoveNext()) - { - object key = ke.Current; - object value = ve.Current; - if (!first) - builder.Append(","); - string stringKey = key as string; - if (stringKey != null) - SerializeString(stringKey, builder); - else - if (!SerializeValue(jsonSerializerStrategy, value, builder)) return false; - builder.Append(":"); - if (!SerializeValue(jsonSerializerStrategy, value, builder)) - return false; - first = false; - } - builder.Append("}"); - return true; - } - - static bool SerializeArray(IJsonSerializerStrategy jsonSerializerStrategy, IEnumerable anArray, StringBuilder builder) - { - builder.Append("["); - bool first = true; - foreach (object value in anArray) - { - if (!first) - builder.Append(","); - if (!SerializeValue(jsonSerializerStrategy, value, builder)) - return false; - first = false; - } - builder.Append("]"); - return true; - } - - static bool SerializeString(string aString, StringBuilder builder) - { - // Happy path if there's nothing to be escaped. IndexOfAny is highly optimized (and unmanaged) - if (aString.IndexOfAny(EscapeCharacters) == -1) - { - builder.Append('"'); - builder.Append(aString); - builder.Append('"'); - - return true; - } - - builder.Append('"'); - int safeCharacterCount = 0; - char[] charArray = aString.ToCharArray(); - - for (int i = 0; i < charArray.Length; i++) - { - char c = charArray[i]; - - // Non ascii characters are fine, buffer them up and send them to the builder - // in larger chunks if possible. The escape table is a 1:1 translation table - // with \0 [default(char)] denoting a safe character. - if (c >= EscapeTable.Length || EscapeTable[c] == default(char)) - { - safeCharacterCount++; - } - else - { - if (safeCharacterCount > 0) - { - builder.Append(charArray, i - safeCharacterCount, safeCharacterCount); - safeCharacterCount = 0; - } - - builder.Append('\\'); - builder.Append(EscapeTable[c]); - } - } - - if (safeCharacterCount > 0) - { - builder.Append(charArray, charArray.Length - safeCharacterCount, safeCharacterCount); - } - - builder.Append('"'); - return true; - } - - static bool SerializeNumber(object number, StringBuilder builder) - { - if (number is long) - builder.Append(((long)number).ToString(CultureInfo.InvariantCulture)); - else if (number is ulong) - builder.Append(((ulong)number).ToString(CultureInfo.InvariantCulture)); - else if (number is int) - builder.Append(((int)number).ToString(CultureInfo.InvariantCulture)); - else if (number is uint) - builder.Append(((uint)number).ToString(CultureInfo.InvariantCulture)); - else if (number is decimal) - builder.Append(((decimal)number).ToString(CultureInfo.InvariantCulture)); - else if (number is float) - builder.Append(((float)number).ToString(CultureInfo.InvariantCulture)); - else - builder.Append(Convert.ToDouble(number, CultureInfo.InvariantCulture).ToString("r", CultureInfo.InvariantCulture)); - return true; - } - - /// - /// Determines if a given object is numeric in any way - /// (can be integer, double, null, etc). - /// - static bool IsNumeric(object value) - { - if (value is sbyte) return true; - if (value is byte) return true; - if (value is short) return true; - if (value is ushort) return true; - if (value is int) return true; - if (value is uint) return true; - if (value is long) return true; - if (value is ulong) return true; - if (value is float) return true; - if (value is double) return true; - if (value is decimal) return true; - return false; - } - - private static IJsonSerializerStrategy _currentJsonSerializerStrategy; - public static IJsonSerializerStrategy CurrentJsonSerializerStrategy - { - get - { - return _currentJsonSerializerStrategy ?? - (_currentJsonSerializerStrategy = -#if SIMPLE_JSON_DATACONTRACT - DataContractJsonSerializerStrategy -#else - PocoJsonSerializerStrategy -#endif -); - } - set - { - _currentJsonSerializerStrategy = value; - } - } - - private static PocoJsonSerializerStrategy _pocoJsonSerializerStrategy; - [EditorBrowsable(EditorBrowsableState.Advanced)] - public static PocoJsonSerializerStrategy PocoJsonSerializerStrategy - { - get - { - return _pocoJsonSerializerStrategy ?? (_pocoJsonSerializerStrategy = new PocoJsonSerializerStrategy()); - } - } - -#if SIMPLE_JSON_DATACONTRACT - - private static DataContractJsonSerializerStrategy _dataContractJsonSerializerStrategy; - [System.ComponentModel.EditorBrowsable(EditorBrowsableState.Advanced)] - public static DataContractJsonSerializerStrategy DataContractJsonSerializerStrategy - { - get - { - return _dataContractJsonSerializerStrategy ?? (_dataContractJsonSerializerStrategy = new DataContractJsonSerializerStrategy()); - } - } - -#endif - } - - [GeneratedCode("simple-json", "1.0.0")] -#if SIMPLE_JSON_INTERNAL - internal -#else - public -#endif - interface IJsonSerializerStrategy - { - [SuppressMessage("Microsoft.Design", "CA1007:UseGenericsWhereAppropriate", Justification="Need to support .NET 2")] - bool TrySerializeNonPrimitiveObject(object input, out object output); - object DeserializeObject(object value, Type type); - } - - [GeneratedCode("simple-json", "1.0.0")] -#if SIMPLE_JSON_INTERNAL - internal -#else - public -#endif - class PocoJsonSerializerStrategy : IJsonSerializerStrategy - { - internal IDictionary ConstructorCache; - internal IDictionary> GetCache; - internal IDictionary>> SetCache; - - internal static readonly Type[] EmptyTypes = new Type[0]; - internal static readonly Type[] ArrayConstructorParameterTypes = new Type[] { typeof(int) }; - - private static readonly string[] Iso8601Format = new string[] - { - @"yyyy-MM-dd\THH:mm:ss.FFFFFFF\Z", - @"yyyy-MM-dd\THH:mm:ss\Z", - @"yyyy-MM-dd\THH:mm:ssK" - }; - - public PocoJsonSerializerStrategy() - { - ConstructorCache = new ReflectionUtils.ThreadSafeDictionary(ContructorDelegateFactory); - GetCache = new ReflectionUtils.ThreadSafeDictionary>(GetterValueFactory); - SetCache = new ReflectionUtils.ThreadSafeDictionary>>(SetterValueFactory); - } - - protected virtual string MapClrMemberNameToJsonFieldName(string clrPropertyName) - { - return clrPropertyName; - } - - internal virtual ReflectionUtils.ConstructorDelegate ContructorDelegateFactory(Type key) - { - return ReflectionUtils.GetContructor(key, key.IsArray ? ArrayConstructorParameterTypes : EmptyTypes); - } - - internal virtual IDictionary GetterValueFactory(Type type) - { - IDictionary result = new Dictionary(); - foreach (PropertyInfo propertyInfo in ReflectionUtils.GetProperties(type)) - { - if (propertyInfo.CanRead) - { - MethodInfo getMethod = ReflectionUtils.GetGetterMethodInfo(propertyInfo); - if (getMethod.IsStatic || !getMethod.IsPublic) - continue; - result[MapClrMemberNameToJsonFieldName(propertyInfo.Name)] = ReflectionUtils.GetGetMethod(propertyInfo); - } - } - foreach (FieldInfo fieldInfo in ReflectionUtils.GetFields(type)) - { - if (fieldInfo.IsStatic || !fieldInfo.IsPublic) - continue; - result[MapClrMemberNameToJsonFieldName(fieldInfo.Name)] = ReflectionUtils.GetGetMethod(fieldInfo); - } - return result; - } - - internal virtual IDictionary> SetterValueFactory(Type type) - { - IDictionary> result = new Dictionary>(); - foreach (PropertyInfo propertyInfo in ReflectionUtils.GetProperties(type)) - { - if (propertyInfo.CanWrite) - { - MethodInfo setMethod = ReflectionUtils.GetSetterMethodInfo(propertyInfo); - if (setMethod.IsStatic || !setMethod.IsPublic) - continue; - result[MapClrMemberNameToJsonFieldName(propertyInfo.Name)] = new KeyValuePair(propertyInfo.PropertyType, ReflectionUtils.GetSetMethod(propertyInfo)); - } - } - foreach (FieldInfo fieldInfo in ReflectionUtils.GetFields(type)) - { - if (fieldInfo.IsInitOnly || fieldInfo.IsStatic || !fieldInfo.IsPublic) - continue; - result[MapClrMemberNameToJsonFieldName(fieldInfo.Name)] = new KeyValuePair(fieldInfo.FieldType, ReflectionUtils.GetSetMethod(fieldInfo)); - } - return result; - } - - public virtual bool TrySerializeNonPrimitiveObject(object input, out object output) - { - return TrySerializeKnownTypes(input, out output) || TrySerializeUnknownTypes(input, out output); - } - - [SuppressMessage("Microsoft.Maintainability", "CA1502:AvoidExcessiveComplexity")] - public virtual object DeserializeObject(object value, Type type) - { - if (type == null) throw new ArgumentNullException("type"); - string str = value as string; - - if (type == typeof (Guid) && string.IsNullOrEmpty(str)) - return default(Guid); - - if (value == null) - return null; - - object obj = null; - - if (str != null) - { - if (str.Length != 0) // We know it can't be null now. - { - if (type == typeof(DateTime) || (ReflectionUtils.IsNullableType(type) && Nullable.GetUnderlyingType(type) == typeof(DateTime))) - return DateTime.ParseExact(str, Iso8601Format, CultureInfo.InvariantCulture, DateTimeStyles.AssumeUniversal | DateTimeStyles.AdjustToUniversal); - if (type == typeof(DateTimeOffset) || (ReflectionUtils.IsNullableType(type) && Nullable.GetUnderlyingType(type) == typeof(DateTimeOffset))) - return DateTimeOffset.ParseExact(str, Iso8601Format, CultureInfo.InvariantCulture, DateTimeStyles.AssumeUniversal | DateTimeStyles.AdjustToUniversal); - if (type == typeof(Guid) || (ReflectionUtils.IsNullableType(type) && Nullable.GetUnderlyingType(type) == typeof(Guid))) - return new Guid(str); - if (type == typeof(Uri)) - { - bool isValid = Uri.IsWellFormedUriString(str, UriKind.RelativeOrAbsolute); - - Uri result; - if (isValid && Uri.TryCreate(str, UriKind.RelativeOrAbsolute, out result)) - return result; - - return null; - } - - if (type == typeof(string)) - return str; - - return Convert.ChangeType(str, type, CultureInfo.InvariantCulture); - } - else - { - if (type == typeof(Guid)) - obj = default(Guid); - else if (ReflectionUtils.IsNullableType(type) && Nullable.GetUnderlyingType(type) == typeof(Guid)) - obj = null; - else - obj = str; - } - // Empty string case - if (!ReflectionUtils.IsNullableType(type) && Nullable.GetUnderlyingType(type) == typeof(Guid)) - return str; - } - else if (value is bool) - return value; - - bool valueIsLong = value is long; - bool valueIsDouble = value is double; - if ((valueIsLong && type == typeof(long)) || (valueIsDouble && type == typeof(double))) - return value; - if ((valueIsDouble && type != typeof(double)) || (valueIsLong && type != typeof(long))) - { - obj = type == typeof(int) || type == typeof(long) || type == typeof(double) || type == typeof(float) || type == typeof(bool) || type == typeof(decimal) || type == typeof(byte) || type == typeof(short) - ? Convert.ChangeType(value, type, CultureInfo.InvariantCulture) - : value; - } - else - { - IDictionary objects = value as IDictionary; - if (objects != null) - { - IDictionary jsonObject = objects; - - if (ReflectionUtils.IsTypeDictionary(type)) - { - // if dictionary then - Type[] types = ReflectionUtils.GetGenericTypeArguments(type); - Type keyType = types[0]; - Type valueType = types[1]; - - Type genericType = typeof(Dictionary<,>).MakeGenericType(keyType, valueType); - - IDictionary dict = (IDictionary)ConstructorCache[genericType](); - - foreach (KeyValuePair kvp in jsonObject) - dict.Add(kvp.Key, DeserializeObject(kvp.Value, valueType)); - - obj = dict; - } - else - { - if (type == typeof(object)) - obj = value; - else - { - obj = ConstructorCache[type](); - foreach (KeyValuePair> setter in SetCache[type]) - { - object jsonValue; - if (jsonObject.TryGetValue(setter.Key, out jsonValue)) - { - jsonValue = DeserializeObject(jsonValue, setter.Value.Key); - setter.Value.Value(obj, jsonValue); - } - } - } - } - } - else - { - IList valueAsList = value as IList; - if (valueAsList != null) - { - IList jsonObject = valueAsList; - IList list = null; - - if (type.IsArray) - { - list = (IList)ConstructorCache[type](jsonObject.Count); - int i = 0; - foreach (object o in jsonObject) - list[i++] = DeserializeObject(o, type.GetElementType()); - } - else if (ReflectionUtils.IsTypeGenericeCollectionInterface(type) || ReflectionUtils.IsAssignableFrom(typeof(IList), type)) - { - Type innerType = ReflectionUtils.GetGenericListElementType(type); - list = (IList)(ConstructorCache[type] ?? ConstructorCache[typeof(List<>).MakeGenericType(innerType)])(jsonObject.Count); - foreach (object o in jsonObject) - list.Add(DeserializeObject(o, innerType)); - } - obj = list; - } - } - return obj; - } - if (ReflectionUtils.IsNullableType(type)) - return ReflectionUtils.ToNullableType(obj, type); - return obj; - } - - protected virtual object SerializeEnum(Enum p) - { - return Convert.ToDouble(p, CultureInfo.InvariantCulture); - } - - [SuppressMessage("Microsoft.Design", "CA1007:UseGenericsWhereAppropriate", Justification="Need to support .NET 2")] - protected virtual bool TrySerializeKnownTypes(object input, out object output) - { - bool returnValue = true; - if (input is DateTime) - output = ((DateTime)input).ToUniversalTime().ToString(Iso8601Format[0], CultureInfo.InvariantCulture); - else if (input is DateTimeOffset) - output = ((DateTimeOffset)input).ToUniversalTime().ToString(Iso8601Format[0], CultureInfo.InvariantCulture); - else if (input is Guid) - output = ((Guid)input).ToString("D"); - else if (input is Uri) - output = input.ToString(); - else - { - Enum inputEnum = input as Enum; - if (inputEnum != null) - output = SerializeEnum(inputEnum); - else - { - returnValue = false; - output = null; - } - } - return returnValue; - } - [SuppressMessage("Microsoft.Design", "CA1007:UseGenericsWhereAppropriate", Justification="Need to support .NET 2")] - protected virtual bool TrySerializeUnknownTypes(object input, out object output) - { - if (input == null) throw new ArgumentNullException("input"); - output = null; - Type type = input.GetType(); - if (type.FullName == null) - return false; - IDictionary obj = new JsonObject(); - IDictionary getters = GetCache[type]; - foreach (KeyValuePair getter in getters) - { - if (getter.Value != null) - obj.Add(MapClrMemberNameToJsonFieldName(getter.Key), getter.Value(input)); - } - output = obj; - return true; - } - } - -#if SIMPLE_JSON_DATACONTRACT - [GeneratedCode("simple-json", "1.0.0")] -#if SIMPLE_JSON_INTERNAL - internal -#else - public -#endif - class DataContractJsonSerializerStrategy : PocoJsonSerializerStrategy - { - public DataContractJsonSerializerStrategy() - { - GetCache = new ReflectionUtils.ThreadSafeDictionary>(GetterValueFactory); - SetCache = new ReflectionUtils.ThreadSafeDictionary>>(SetterValueFactory); - } - - internal override IDictionary GetterValueFactory(Type type) - { - bool hasDataContract = ReflectionUtils.GetAttribute(type, typeof(DataContractAttribute)) != null; - if (!hasDataContract) - return base.GetterValueFactory(type); - string jsonKey; - IDictionary result = new Dictionary(); - foreach (PropertyInfo propertyInfo in ReflectionUtils.GetProperties(type)) - { - if (propertyInfo.CanRead) - { - MethodInfo getMethod = ReflectionUtils.GetGetterMethodInfo(propertyInfo); - if (!getMethod.IsStatic && CanAdd(propertyInfo, out jsonKey)) - result[jsonKey] = ReflectionUtils.GetGetMethod(propertyInfo); - } - } - foreach (FieldInfo fieldInfo in ReflectionUtils.GetFields(type)) - { - if (!fieldInfo.IsStatic && CanAdd(fieldInfo, out jsonKey)) - result[jsonKey] = ReflectionUtils.GetGetMethod(fieldInfo); - } - return result; - } - - internal override IDictionary> SetterValueFactory(Type type) - { - bool hasDataContract = ReflectionUtils.GetAttribute(type, typeof(DataContractAttribute)) != null; - if (!hasDataContract) - return base.SetterValueFactory(type); - string jsonKey; - IDictionary> result = new Dictionary>(); - foreach (PropertyInfo propertyInfo in ReflectionUtils.GetProperties(type)) - { - if (propertyInfo.CanWrite) - { - MethodInfo setMethod = ReflectionUtils.GetSetterMethodInfo(propertyInfo); - if (!setMethod.IsStatic && CanAdd(propertyInfo, out jsonKey)) - result[jsonKey] = new KeyValuePair(propertyInfo.PropertyType, ReflectionUtils.GetSetMethod(propertyInfo)); - } - } - foreach (FieldInfo fieldInfo in ReflectionUtils.GetFields(type)) - { - if (!fieldInfo.IsInitOnly && !fieldInfo.IsStatic && CanAdd(fieldInfo, out jsonKey)) - result[jsonKey] = new KeyValuePair(fieldInfo.FieldType, ReflectionUtils.GetSetMethod(fieldInfo)); - } - // todo implement sorting for DATACONTRACT. - return result; - } - - private static bool CanAdd(MemberInfo info, out string jsonKey) - { - jsonKey = null; - if (ReflectionUtils.GetAttribute(info, typeof(IgnoreDataMemberAttribute)) != null) - return false; - DataMemberAttribute dataMemberAttribute = (DataMemberAttribute)ReflectionUtils.GetAttribute(info, typeof(DataMemberAttribute)); - if (dataMemberAttribute == null) - return false; - jsonKey = string.IsNullOrEmpty(dataMemberAttribute.Name) ? info.Name : dataMemberAttribute.Name; - return true; - } - } - -#endif - - namespace Reflection - { - // This class is meant to be copied into other libraries. So we want to exclude it from Code Analysis rules - // that might be in place in the target project. - [GeneratedCode("reflection-utils", "1.0.0")] -#if SIMPLE_JSON_REFLECTION_UTILS_PUBLIC - public -#else - internal -#endif - class ReflectionUtils - { - private static readonly object[] EmptyObjects = new object[] { }; - - public delegate object GetDelegate(object source); - public delegate void SetDelegate(object source, object value); - public delegate object ConstructorDelegate(params object[] args); - - public delegate TValue ThreadSafeDictionaryValueFactory(TKey key); - -#if SIMPLE_JSON_TYPEINFO - public static TypeInfo GetTypeInfo(Type type) - { - return type.GetTypeInfo(); - } -#else - public static Type GetTypeInfo(Type type) - { - return type; - } -#endif - - public static Attribute GetAttribute(MemberInfo info, Type type) - { -#if SIMPLE_JSON_TYPEINFO - if (info == null || type == null || !info.IsDefined(type)) - return null; - return info.GetCustomAttribute(type); -#else - if (info == null || type == null || !Attribute.IsDefined(info, type)) - return null; - return Attribute.GetCustomAttribute(info, type); -#endif - } - - public static Type GetGenericListElementType(Type type) - { - IEnumerable interfaces; -#if SIMPLE_JSON_TYPEINFO - interfaces = type.GetTypeInfo().ImplementedInterfaces; -#else - interfaces = type.GetInterfaces(); -#endif - foreach (Type implementedInterface in interfaces) - { - if (IsTypeGeneric(implementedInterface) && - implementedInterface.GetGenericTypeDefinition() == typeof (IList<>)) - { - return GetGenericTypeArguments(implementedInterface)[0]; - } - } - return GetGenericTypeArguments(type)[0]; - } - - public static Attribute GetAttribute(Type objectType, Type attributeType) - { - -#if SIMPLE_JSON_TYPEINFO - if (objectType == null || attributeType == null || !objectType.GetTypeInfo().IsDefined(attributeType)) - return null; - return objectType.GetTypeInfo().GetCustomAttribute(attributeType); -#else - if (objectType == null || attributeType == null || !Attribute.IsDefined(objectType, attributeType)) - return null; - return Attribute.GetCustomAttribute(objectType, attributeType); -#endif - } - - public static Type[] GetGenericTypeArguments(Type type) - { -#if SIMPLE_JSON_TYPEINFO - return type.GetTypeInfo().GenericTypeArguments; -#else - return type.GetGenericArguments(); -#endif - } - - public static bool IsTypeGeneric(Type type) - { - return GetTypeInfo(type).IsGenericType; - } - - public static bool IsTypeGenericeCollectionInterface(Type type) - { - if (!IsTypeGeneric(type)) - return false; - - Type genericDefinition = type.GetGenericTypeDefinition(); - - return (genericDefinition == typeof(IList<>) - || genericDefinition == typeof(ICollection<>) - || genericDefinition == typeof(IEnumerable<>) -#if SIMPLE_JSON_READONLY_COLLECTIONS - || genericDefinition == typeof(IReadOnlyCollection<>) - || genericDefinition == typeof(IReadOnlyList<>) -#endif - ); - } - - public static bool IsAssignableFrom(Type type1, Type type2) - { - return GetTypeInfo(type1).IsAssignableFrom(GetTypeInfo(type2)); - } - - public static bool IsTypeDictionary(Type type) - { -#if SIMPLE_JSON_TYPEINFO - if (typeof(IDictionary<,>).GetTypeInfo().IsAssignableFrom(type.GetTypeInfo())) - return true; -#else - if (typeof(System.Collections.IDictionary).IsAssignableFrom(type)) - return true; -#endif - if (!GetTypeInfo(type).IsGenericType) - return false; - - Type genericDefinition = type.GetGenericTypeDefinition(); - return genericDefinition == typeof(IDictionary<,>); - } - - public static bool IsNullableType(Type type) - { - return GetTypeInfo(type).IsGenericType && type.GetGenericTypeDefinition() == typeof(Nullable<>); - } - - public static object ToNullableType(object obj, Type nullableType) - { - return obj == null ? null : Convert.ChangeType(obj, Nullable.GetUnderlyingType(nullableType), CultureInfo.InvariantCulture); - } - - public static bool IsValueType(Type type) - { - return GetTypeInfo(type).IsValueType; - } - - public static IEnumerable GetConstructors(Type type) - { -#if SIMPLE_JSON_TYPEINFO - return type.GetTypeInfo().DeclaredConstructors; -#else - return type.GetConstructors(); -#endif - } - - public static ConstructorInfo GetConstructorInfo(Type type, params Type[] argsType) - { - IEnumerable constructorInfos = GetConstructors(type); - int i; - bool matches; - foreach (ConstructorInfo constructorInfo in constructorInfos) - { - ParameterInfo[] parameters = constructorInfo.GetParameters(); - if (argsType.Length != parameters.Length) - continue; - - i = 0; - matches = true; - foreach (ParameterInfo parameterInfo in constructorInfo.GetParameters()) - { - if (parameterInfo.ParameterType != argsType[i]) - { - matches = false; - break; - } - } - - if (matches) - return constructorInfo; - } - - return null; - } - - public static IEnumerable GetProperties(Type type) - { -#if SIMPLE_JSON_TYPEINFO - return type.GetRuntimeProperties(); -#else - return type.GetProperties(BindingFlags.Instance | BindingFlags.Public | BindingFlags.NonPublic | BindingFlags.Static); -#endif - } - - public static IEnumerable GetFields(Type type) - { -#if SIMPLE_JSON_TYPEINFO - return type.GetRuntimeFields(); -#else - return type.GetFields(BindingFlags.Instance | BindingFlags.Public | BindingFlags.NonPublic | BindingFlags.Static); -#endif - } - - public static MethodInfo GetGetterMethodInfo(PropertyInfo propertyInfo) - { -#if SIMPLE_JSON_TYPEINFO - return propertyInfo.GetMethod; -#else - return propertyInfo.GetGetMethod(true); -#endif - } - - public static MethodInfo GetSetterMethodInfo(PropertyInfo propertyInfo) - { -#if SIMPLE_JSON_TYPEINFO - return propertyInfo.SetMethod; -#else - return propertyInfo.GetSetMethod(true); -#endif - } - - public static ConstructorDelegate GetContructor(ConstructorInfo constructorInfo) - { -#if SIMPLE_JSON_NO_LINQ_EXPRESSION - return GetConstructorByReflection(constructorInfo); -#else - return GetConstructorByExpression(constructorInfo); -#endif - } - - public static ConstructorDelegate GetContructor(Type type, params Type[] argsType) - { -#if SIMPLE_JSON_NO_LINQ_EXPRESSION - return GetConstructorByReflection(type, argsType); -#else - return GetConstructorByExpression(type, argsType); -#endif - } - - public static ConstructorDelegate GetConstructorByReflection(ConstructorInfo constructorInfo) - { - return delegate(object[] args) { return constructorInfo.Invoke(args); }; - } - - public static ConstructorDelegate GetConstructorByReflection(Type type, params Type[] argsType) - { - ConstructorInfo constructorInfo = GetConstructorInfo(type, argsType); - return constructorInfo == null ? null : GetConstructorByReflection(constructorInfo); - } - -#if !SIMPLE_JSON_NO_LINQ_EXPRESSION - - public static ConstructorDelegate GetConstructorByExpression(ConstructorInfo constructorInfo) - { - ParameterInfo[] paramsInfo = constructorInfo.GetParameters(); - ParameterExpression param = Expression.Parameter(typeof(object[]), "args"); - Expression[] argsExp = new Expression[paramsInfo.Length]; - for (int i = 0; i < paramsInfo.Length; i++) - { - Expression index = Expression.Constant(i); - Type paramType = paramsInfo[i].ParameterType; - Expression paramAccessorExp = Expression.ArrayIndex(param, index); - Expression paramCastExp = Expression.Convert(paramAccessorExp, paramType); - argsExp[i] = paramCastExp; - } - NewExpression newExp = Expression.New(constructorInfo, argsExp); - Expression> lambda = Expression.Lambda>(newExp, param); - Func compiledLambda = lambda.Compile(); - return delegate(object[] args) { return compiledLambda(args); }; - } - - public static ConstructorDelegate GetConstructorByExpression(Type type, params Type[] argsType) - { - ConstructorInfo constructorInfo = GetConstructorInfo(type, argsType); - return constructorInfo == null ? null : GetConstructorByExpression(constructorInfo); - } - -#endif - - public static GetDelegate GetGetMethod(PropertyInfo propertyInfo) - { -#if SIMPLE_JSON_NO_LINQ_EXPRESSION - return GetGetMethodByReflection(propertyInfo); -#else - return GetGetMethodByExpression(propertyInfo); -#endif - } - - public static GetDelegate GetGetMethod(FieldInfo fieldInfo) - { -#if SIMPLE_JSON_NO_LINQ_EXPRESSION - return GetGetMethodByReflection(fieldInfo); -#else - return GetGetMethodByExpression(fieldInfo); -#endif - } - - public static GetDelegate GetGetMethodByReflection(PropertyInfo propertyInfo) - { - MethodInfo methodInfo = GetGetterMethodInfo(propertyInfo); - return delegate(object source) { return methodInfo.Invoke(source, EmptyObjects); }; - } - - public static GetDelegate GetGetMethodByReflection(FieldInfo fieldInfo) - { - return delegate(object source) { return fieldInfo.GetValue(source); }; - } - -#if !SIMPLE_JSON_NO_LINQ_EXPRESSION - - public static GetDelegate GetGetMethodByExpression(PropertyInfo propertyInfo) - { - MethodInfo getMethodInfo = GetGetterMethodInfo(propertyInfo); - ParameterExpression instance = Expression.Parameter(typeof(object), "instance"); - UnaryExpression instanceCast = (!IsValueType(propertyInfo.DeclaringType)) ? Expression.TypeAs(instance, propertyInfo.DeclaringType) : Expression.Convert(instance, propertyInfo.DeclaringType); - Func compiled = Expression.Lambda>(Expression.TypeAs(Expression.Call(instanceCast, getMethodInfo), typeof(object)), instance).Compile(); - return delegate(object source) { return compiled(source); }; - } - - public static GetDelegate GetGetMethodByExpression(FieldInfo fieldInfo) - { - ParameterExpression instance = Expression.Parameter(typeof(object), "instance"); - MemberExpression member = Expression.Field(Expression.Convert(instance, fieldInfo.DeclaringType), fieldInfo); - GetDelegate compiled = Expression.Lambda(Expression.Convert(member, typeof(object)), instance).Compile(); - return delegate(object source) { return compiled(source); }; - } - -#endif - - public static SetDelegate GetSetMethod(PropertyInfo propertyInfo) - { -#if SIMPLE_JSON_NO_LINQ_EXPRESSION - return GetSetMethodByReflection(propertyInfo); -#else - return GetSetMethodByExpression(propertyInfo); -#endif - } - - public static SetDelegate GetSetMethod(FieldInfo fieldInfo) - { -#if SIMPLE_JSON_NO_LINQ_EXPRESSION - return GetSetMethodByReflection(fieldInfo); -#else - return GetSetMethodByExpression(fieldInfo); -#endif - } - - public static SetDelegate GetSetMethodByReflection(PropertyInfo propertyInfo) - { - MethodInfo methodInfo = GetSetterMethodInfo(propertyInfo); - return delegate(object source, object value) { methodInfo.Invoke(source, new object[] { value }); }; - } - - public static SetDelegate GetSetMethodByReflection(FieldInfo fieldInfo) - { - return delegate(object source, object value) { fieldInfo.SetValue(source, value); }; - } - -#if !SIMPLE_JSON_NO_LINQ_EXPRESSION - - public static SetDelegate GetSetMethodByExpression(PropertyInfo propertyInfo) - { - MethodInfo setMethodInfo = GetSetterMethodInfo(propertyInfo); - ParameterExpression instance = Expression.Parameter(typeof(object), "instance"); - ParameterExpression value = Expression.Parameter(typeof(object), "value"); - UnaryExpression instanceCast = (!IsValueType(propertyInfo.DeclaringType)) ? Expression.TypeAs(instance, propertyInfo.DeclaringType) : Expression.Convert(instance, propertyInfo.DeclaringType); - UnaryExpression valueCast = (!IsValueType(propertyInfo.PropertyType)) ? Expression.TypeAs(value, propertyInfo.PropertyType) : Expression.Convert(value, propertyInfo.PropertyType); - Action compiled = Expression.Lambda>(Expression.Call(instanceCast, setMethodInfo, valueCast), new ParameterExpression[] { instance, value }).Compile(); - return delegate(object source, object val) { compiled(source, val); }; - } - - public static SetDelegate GetSetMethodByExpression(FieldInfo fieldInfo) - { - ParameterExpression instance = Expression.Parameter(typeof(object), "instance"); - ParameterExpression value = Expression.Parameter(typeof(object), "value"); - Action compiled = Expression.Lambda>( - Assign(Expression.Field(Expression.Convert(instance, fieldInfo.DeclaringType), fieldInfo), Expression.Convert(value, fieldInfo.FieldType)), instance, value).Compile(); - return delegate(object source, object val) { compiled(source, val); }; - } - - public static BinaryExpression Assign(Expression left, Expression right) - { -#if SIMPLE_JSON_TYPEINFO - return Expression.Assign(left, right); -#else - MethodInfo assign = typeof(Assigner<>).MakeGenericType(left.Type).GetMethod("Assign"); - BinaryExpression assignExpr = Expression.Add(left, right, assign); - return assignExpr; -#endif - } - - private static class Assigner - { - public static T Assign(ref T left, T right) - { - return (left = right); - } - } - -#endif - - public sealed class ThreadSafeDictionary : IDictionary - { - private readonly object _lock = new object(); - private readonly ThreadSafeDictionaryValueFactory _valueFactory; - private Dictionary _dictionary; - - public ThreadSafeDictionary(ThreadSafeDictionaryValueFactory valueFactory) - { - _valueFactory = valueFactory; - } - - private TValue Get(TKey key) - { - if (_dictionary == null) - return AddValue(key); - TValue value; - if (!_dictionary.TryGetValue(key, out value)) - return AddValue(key); - return value; - } - - private TValue AddValue(TKey key) - { - TValue value = _valueFactory(key); - lock (_lock) - { - if (_dictionary == null) - { - _dictionary = new Dictionary(); - _dictionary[key] = value; - } - else - { - TValue val; - if (_dictionary.TryGetValue(key, out val)) - return val; - Dictionary dict = new Dictionary(_dictionary); - dict[key] = value; - _dictionary = dict; - } - } - return value; - } - - public void Add(TKey key, TValue value) - { - throw new NotImplementedException(); - } - - public bool ContainsKey(TKey key) - { - return _dictionary.ContainsKey(key); - } - - public ICollection Keys - { - get { return _dictionary.Keys; } - } - - public bool Remove(TKey key) - { - throw new NotImplementedException(); - } - - public bool TryGetValue(TKey key, out TValue value) - { - value = this[key]; - return true; - } - - public ICollection Values - { - get { return _dictionary.Values; } - } - - public TValue this[TKey key] - { - get { return Get(key); } - set { throw new NotImplementedException(); } - } - - public void Add(KeyValuePair item) - { - throw new NotImplementedException(); - } - - public void Clear() - { - throw new NotImplementedException(); - } - - public bool Contains(KeyValuePair item) - { - throw new NotImplementedException(); - } - - public void CopyTo(KeyValuePair[] array, int arrayIndex) - { - throw new NotImplementedException(); - } - - public int Count - { - get { return _dictionary.Count; } - } - - public bool IsReadOnly - { - get { throw new NotImplementedException(); } - } - - public bool Remove(KeyValuePair item) - { - throw new NotImplementedException(); - } - - public IEnumerator> GetEnumerator() - { - return _dictionary.GetEnumerator(); - } - - System.Collections.IEnumerator System.Collections.IEnumerable.GetEnumerator() - { - return _dictionary.GetEnumerator(); - } - } - - } - } -} -// ReSharper restore LoopCanBeConvertedToQuery -// ReSharper restore RedundantExplicitArrayCreation -// ReSharper restore SuggestUseVarKeywordEvident \ No newline at end of file diff --git a/RestSharp/Validation/Require.cs b/RestSharp/Validation/Require.cs deleted file mode 100644 index 077f792ca..000000000 --- a/RestSharp/Validation/Require.cs +++ /dev/null @@ -1,41 +0,0 @@ -#region License - -// Copyright 2010 John Sheehan -// -// Licensed under the Apache License, Version 2.0 (the "License"); -// you may not use this file except in compliance with the License. -// You may obtain a copy of the License at -// -// http://www.apache.org/licenses/LICENSE-2.0 -// -// Unless required by applicable law or agreed to in writing, software -// distributed under the License is distributed on an "AS IS" BASIS, -// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -// See the License for the specific language governing permissions and -// limitations under the License. - -#endregion - -using System; - -namespace RestSharp.Validation -{ - /// - /// Helper methods for validating required values - /// - public class Require - { - /// - /// Require a parameter to not be null - /// - /// Name of the parameter - /// Value of the parameter - public static void Argument(string argumentName, object argumentValue) - { - if (argumentValue == null) - { - throw new ArgumentException("Argument cannot be null.", argumentName); - } - } - } -} diff --git a/RestSharp/Validation/Validate.cs b/RestSharp/Validation/Validate.cs deleted file mode 100644 index d6ee14ae7..000000000 --- a/RestSharp/Validation/Validate.cs +++ /dev/null @@ -1,60 +0,0 @@ -#region License - -// Copyright 2010 John Sheehan -// -// Licensed under the Apache License, Version 2.0 (the "License"); -// you may not use this file except in compliance with the License. -// You may obtain a copy of the License at -// -// http://www.apache.org/licenses/LICENSE-2.0 -// -// Unless required by applicable law or agreed to in writing, software -// distributed under the License is distributed on an "AS IS" BASIS, -// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -// See the License for the specific language governing permissions and -// limitations under the License. - -#endregion - -using System; - -namespace RestSharp.Validation -{ - /// - /// Helper methods for validating values - /// - public class Validate - { - /// - /// Validate an integer value is between the specified values (exclusive of min/max) - /// - /// Value to validate - /// Exclusive minimum value - /// Exclusive maximum value - public static void IsBetween(int value, int min, int max) - { - if (value < min || value > max) - { - throw new ArgumentException(string.Format("Value ({0}) is not between {1} and {2}.", value, min, max)); - } - } - - /// - /// Validate a string length - /// - /// String to be validated - /// Maximum length of the string - public static void IsValidLength(string value, int maxSize) - { - if (value == null) - { - return; - } - - if (value.Length > maxSize) - { - throw new ArgumentException(string.Format("String is longer than max allowed size ({0}).", maxSize)); - } - } - } -} diff --git a/agents.md b/agents.md new file mode 100644 index 000000000..5093f99f8 --- /dev/null +++ b/agents.md @@ -0,0 +1,671 @@ +### RestSharp – Developer Notes (agents.md) + +#### Scope +This document captures project-specific knowledge to speed up advanced development and maintenance of RestSharp. It focuses on build, configuration, testing details, source generation, and conventions unique to this repository. + +--- + +## Solution Structure + +### Projects and Organization + +The solution (`RestSharp.sln`) is organized into the following structure: + +**Core Library:** +- `src/RestSharp/` - Main library targeting multiple frameworks + +**Serializer Extensions:** +- `src/RestSharp.Serializers.NewtonsoftJson/` - Newtonsoft.Json serializer +- `src/RestSharp.Serializers.Xml/` - XML serializer +- `src/RestSharp.Serializers.CsvHelper/` - CSV serializer + +**Source Generator:** +- `gen/SourceGenerator/` - Incremental source generator for code generation (see dedicated section below) + +**Test Projects:** +- `test/RestSharp.Tests/` - Core unit tests +- `test/RestSharp.Tests.Integrated/` - Integration tests using WireMock +- `test/RestSharp.Tests.Serializers.Json/` - JSON serializer tests +- `test/RestSharp.Tests.Serializers.Xml/` - XML serializer tests +- `test/RestSharp.Tests.Serializers.Csv/` - CSV serializer tests +- `test/RestSharp.Tests.Shared/` - Shared test utilities +- `test/RestSharp.InteractiveTests/` - Interactive/manual tests + +**Performance:** +- `benchmarks/RestSharp.Benchmarks/` - BenchmarkDotNet performance tests + +--- + +## Build and Configuration + +### Multi-Targeting + +**Library Targets** (`src/Directory.Build.props`): +- `netstandard2.0` - .NET Standard 2.0 for broad compatibility +- `net471` - .NET Framework 4.7.1 +- `net48` - .NET Framework 4.8 +- `net8.0` - .NET 8 +- `net9.0` - .NET 9 +- `net10.0` - .NET 10 + +**Test Targets** (`test/Directory.Build.props`): +- `net48` - .NET Framework 4.8 (Windows only) +- `net8.0` - .NET 8 +- `net9.0` - .NET 9 +- `net10.0` - .NET 10 + +**Source Generator Target:** +- `netstandard2.0` - Required for source generators to work across all compiler versions + +### Build Properties Hierarchy + +The build system uses a hierarchical props structure: + +1. **`props/Common.props`** - Root properties imported by all projects: + - Sets `RepoRoot` variable + - Configures assembly signing (`RestSharp.snk`) + - Sets `LangVersion=preview` and `ImplicitUsings=enable` + - Enables nullable reference types (`Nullable=enable`) + - Adds global `using System.Net.Http;` + +2. **`src/Directory.Build.props`** - Source project properties: + - Imports `Common.props` + - Defines multi-targeting for libraries + - Configures NuGet package metadata (icon, license, description) + - Enables SourceLink for debugging + - Uses MinVer for versioning + - Conditionally adds polyfills for older frameworks + - Generates XML documentation files + +3. **`test/Directory.Build.props`** - Test project properties: + - Imports `Common.props` + - Sets `IsTestProject=true` and `IsPackable=false` + - Configures test result output: `test-results//.trx` + - Disables nullable (`Nullable=disable` for tests) + - Adds global usings for xUnit, FluentAssertions, AutoFixture + - Suppresses warnings: `xUnit1033`, `CS8002` + +4. **`Directory.Packages.props`** - Central Package Management: + - All package versions defined centrally + - TFM-specific version overrides (e.g., `System.Text.Json` for .NET 10) + - Separate sections for runtime, compile, and testing dependencies + +### Framework-Specific Considerations + +**Legacy Framework Support (.NET Framework 4.7.1/4.8, netstandard2.0):** +- `System.Text.Json` is added as a package reference (newer frameworks have it built-in) +- Polyfills are enabled via `Nullable` package for nullable reference type attributes +- Reference assemblies provided by `Microsoft.NETFramework.ReferenceAssemblies.net472` + +**Modern .NET (8/9/10):** +- Native support for most features +- Conditional compilation using `#if NET` +- Platform-specific attributes like `[UnsupportedOSPlatform("browser")]` + +### Assembly Signing + +All assemblies are strong-named using `RestSharp.snk` (configured in `Common.props`). + +--- + +## Source Generator + +RestSharp includes a custom incremental source generator located in `gen/SourceGenerator/` that automates boilerplate code generation. + +### Generator Architecture + +**Project Configuration:** +- Targets: `netstandard2.0` (required for source generators) +- Language: C# preview features enabled +- Output: Not included in build output (`IncludeBuildOutput=false`) +- Analyzer rules: Extended analyzer rules enforced +- Referenced as analyzer in main project: `OutputItemType="Analyzer"` + +**Dependencies:** +- `Microsoft.CodeAnalysis.Analyzers` - Analyzer SDK +- `Microsoft.CodeAnalysis.CSharp` - Roslyn C# APIs + +**Global Usings:** +```csharp +using System.Text; +using Microsoft.CodeAnalysis; +using Microsoft.CodeAnalysis.CSharp; +using Microsoft.CodeAnalysis.CSharp.Syntax; +using Microsoft.CodeAnalysis.Text; +``` + +### Generator Components + +#### 1. ImmutableGenerator (`ImmutableGenerator.cs`) + +**Purpose:** Generates immutable (read-only) wrapper classes from mutable classes. + +**Trigger Attribute:** `[GenerateImmutable]` + +**How It Works:** +1. Scans compilation for classes annotated with `[GenerateImmutable]` +2. Identifies all properties with `set` accessors (excluding those marked with `[Exclude]`) +3. Generates a `ReadOnly{ClassName}` partial class with: + - Read-only properties (getters only) + - Constructor accepting the mutable class instance + - Partial method `CopyAdditionalProperties` for extensibility + - Preserves XML documentation comments + +**Example Usage:** +```csharp +[GenerateImmutable] +public class RestClientOptions { + public Uri? BaseUrl { get; set; } + public string? UserAgent { get; set; } + [Exclude] // This property won't be in the immutable version + public List Interceptors { get; set; } +} +``` + +**Generated Output:** `ReadOnlyRestClientOptions.cs` with immutable properties and a constructor that copies values from `RestClientOptions`. + +**Location:** Generated files appear in `obj///generated/SourceGenerator/SourceGenerator.ImmutableGenerator/` + +#### 2. InheritedCloneGenerator (`InheritedCloneGenerator.cs`) + +**Purpose:** Generates static factory methods to clone objects from base types to derived types. + +**Trigger Attribute:** `[GenerateClone(BaseType = typeof(BaseClass), Name = "MethodName")]` + +**How It Works:** +1. Finds classes with `[GenerateClone]` attribute +2. Extracts `BaseType` and `Name` from attribute parameters +3. Analyzes properties from the base type and its inheritance chain +4. Generates a static factory method that: + - Takes the base type as parameter + - Creates a new instance of the derived type + - Copies all properties from base to derived + - Uses constructor parameters where applicable + +**Example Usage:** +```csharp +[GenerateClone(BaseType = typeof(RestResponse), Name = "FromResponse")] +public partial class RestResponse : RestResponse { + public T? Data { get; set; } +} +``` + +**Generated Output:** `RestResponse.Clone.g.cs` with a static `FromResponse` method that creates `RestResponse` from `RestResponse`. + +**Location:** Generated files appear in `obj///generated/SourceGenerator/SourceGenerator.InheritedCloneGenerator/` + +#### 3. Extensions (`Extensions.cs`) + +**Purpose:** Helper extension methods for the generators using C# extension types. + +**Key Methods:** +- `FindClasses(predicate)` - Finds classes matching a predicate across all syntax trees +- `FindAnnotatedClasses(attributeName, strict)` - Finds classes with specific attributes +- `GetBaseTypesAndThis()` - Traverses type hierarchy to get all base types + +### Attribute Definitions + +Located in `src/RestSharp/Extensions/GenerateImmutableAttribute.cs`: + +```csharp +[AttributeUsage(AttributeTargets.Class)] +class GenerateImmutableAttribute : Attribute; + +[AttributeUsage(AttributeTargets.Class)] +class GenerateCloneAttribute : Attribute { + public Type? BaseType { get; set; } + public string? Name { get; set; } +} + +[AttributeUsage(AttributeTargets.Property)] +class Exclude : Attribute; // Excludes properties from immutable generation +``` + +### Integration with Main Project + +In `src/RestSharp/RestSharp.csproj`: +```xml + + true + + + + + +``` + +### Debugging Generated Code + +Generated files are emitted to the `obj` directory when `EmitCompilerGeneratedFiles=true`. To view: +```bash +# Example path for net8.0 Debug build +ls src/RestSharp/obj/Debug/net8.0/generated/SourceGenerator/ +``` + +--- + +## Testing + +### Test Framework and Helpers + +**Primary Framework:** xUnit + +**Assertion Library:** FluentAssertions + +**Test Data:** AutoFixture + +**Mocking:** +- `Moq` - General mocking +- `RichardSzalay.MockHttp` - HTTP message handler mocking +- `WireMock.Net` - HTTP server mocking for integration tests + +**Global Usings** (configured in `test/Directory.Build.props`): +```csharp +using Xunit; +using Xunit.Abstractions; +using FluentAssertions; +using FluentAssertions.Extensions; +using AutoFixture; +``` + +These are automatically available in all test files without explicit `using` statements. + +### Test Project Organization + +**Unit Tests (`RestSharp.Tests`):** +- Tests for core functionality +- Uses mocking for HTTP interactions +- Example: `UrlBuilderTests`, `ObjectParserTests` +- Organized with partial classes for large test suites (e.g., `UrlBuilderTests.Get.cs`, `UrlBuilderTests.Post.cs`) + +**Integration Tests (`RestSharp.Tests.Integrated`):** +- Uses `WireMockServer` for realistic HTTP scenarios +- Tests actual HTTP behavior without external dependencies +- Example: `DownloadFileTests` spins up WireMock server in constructor, disposes in `IDisposable.Dispose` +- Asset files stored in `Assets/` directory + +**Serializer Tests:** +- Separate projects for each serializer (JSON, XML, CSV) +- Test serialization/deserialization behavior + +### Running Tests + +**All tests for entire solution:** +```bash +dotnet test RestSharp.sln -c Debug +``` + +**Specific test project:** +```bash +dotnet test test/RestSharp.Tests/RestSharp.Tests.csproj +``` + +**Single target framework:** +```bash +dotnet test test/RestSharp.Tests/RestSharp.Tests.csproj -f net8.0 +``` + +**Single test by fully-qualified name (recommended for precision):** +```bash +dotnet test test/RestSharp.Tests/RestSharp.Tests.csproj \ + --filter "FullyQualifiedName=RestSharp.Tests.UrlBuilderTests_Get.Should_build_url_with_query" \ + -f net8.0 +``` + +**Filter by namespace or class:** +```bash +dotnet test test/RestSharp.Tests/RestSharp.Tests.csproj \ + --filter "RestSharp.Tests.UrlBuilderTests" +``` + +**With verbose output:** +```bash +dotnet test -v n +``` + +### Test Results and Logging + +**Output Location:** `test-results//.trx` + +**Configuration** (in `test/Directory.Build.props`): +```xml +trx%3bLogFileName=$(MSBuildProjectName).trx +$(RepoRoot)/test-results/$(TargetFramework) +``` + +Results are written per target framework, making it easy to identify TFM-specific failures. + +### Code Coverage + +**Tool:** coverlet.collector (data-collector based) + +**Generate coverage report:** +```bash +dotnet test test/RestSharp.Tests/RestSharp.Tests.csproj \ + -f net8.0 \ + --collect:"XPlat Code Coverage" \ + -- DataCollectionRunSettings.DataCollectors.DataCollector.Configuration.Format=cobertura +``` + +Coverage output is placed in the test results directory. + +### Adding New Tests + +**Best Practices:** +1. Co-locate tests by feature area +2. Use partial classes for large test suites (link via `` in `.csproj`) +3. For HTTP tests, prefer `WireMockServer` over live endpoints +4. Use FluentAssertions for readable assertions: `result.Should().Be(expected)` +5. Avoid time-sensitive or locale-sensitive assertions; pin formats when needed +6. Use `#if NET8_0_OR_GREATER` for TFM-specific APIs + +**Example Test Structure:** +```csharp +public class MyFeatureTests { + [Fact] + public void Should_do_something() { + // Arrange + var fixture = new Fixture(); + var input = fixture.Create(); + + // Act + var result = MyFeature.Process(input); + + // Assert + result.Should().NotBeNull(); + } +} +``` + +--- + +## Continuous Integration + +### CI Workflows + +**Location:** `.github/workflows/` + +#### 1. Pull Request Workflow (`pull-request.yml`) + +**Triggers:** Pull requests (excluding `docs/**` changes) + +**Test Matrix:** +- **Windows:** Tests against `net48`, `net8.0`, `net9.0`, `net10.0` +- **Linux:** Tests against `net8.0`, `net9.0`, `net10.0` (no .NET Framework) + +**SDK Setup:** +```yaml +dotnet-version: | + 8.0.x + 9.0.x + 10.0.x +``` + +**Test Command:** +```bash +dotnet test -c Debug -f ${{ matrix.dotnet }} +``` + +**Artifacts:** Test results uploaded for each TFM and OS combination + +#### 2. Build and Deploy Workflow (`build-dev.yml`) + +**Triggers:** +- Push to `dev` branch +- Tags (for releases) + +**SDK:** .NET 10.0.x (for packaging) + +**Steps:** +1. Checkout with full history (`git fetch --prune --unshallow` for MinVer) +2. NuGet login using OIDC (`NuGet/login@v1`) +3. Pack: `dotnet pack -c Release -o nuget -p:IncludeSymbols=true -p:SymbolPackageFormat=snupkg` +4. Push to NuGet.org with `--skip-duplicate` + +**Permissions:** Requires `id-token: write` for OIDC authentication + +#### 3. Test Results Workflow (`test-results.yml`) + +Publishes test results as GitHub checks. + +### Local CI Simulation + +To replicate CI behavior locally: + +**Windows (all TFMs):** +```bash +dotnet test -c Debug -f net48 +dotnet test -c Debug -f net8.0 +dotnet test -c Debug -f net9.0 +dotnet test -c Debug -f net10.0 +``` + +**Linux/macOS (no .NET Framework):** +```bash +dotnet test -c Debug -f net8.0 +dotnet test -c Debug -f net9.0 +dotnet test -c Debug -f net10.0 +``` + +--- + +## Versioning and Packaging + +### Versioning Strategy + +**Tool:** MinVer (Git-based semantic versioning) + +**Configuration** (in `src/Directory.Build.props`): +```xml + +``` + +**Custom Version Target:** +```xml + + + $(MinVerMajor).$(MinVerMinor).$(MinVerPatch) + $(MinVerMajor).$(MinVerMinor).$(MinVerPatch) + + +``` + +Version is determined from Git tags and commit history. Requires unshallow clone for accurate versioning. + +### Package Configuration + +**NuGet Metadata:** +- Icon: `restsharp.png` +- License: Apache-2.0 +- Project URL: https://restsharp.dev +- Repository: https://github.com/restsharp/RestSharp.git +- README: Included in package + +**Symbol Packages:** `.snupkg` format for debugging + +**SourceLink:** Enabled for source debugging + +### Local Packaging + +```bash +dotnet pack src/RestSharp/RestSharp.csproj -c Release -o nuget \ + -p:IncludeSymbols=true -p:SymbolPackageFormat=snupkg +``` + +Output: `nuget/RestSharp..nupkg` and `RestSharp..snupkg` + +--- + +## Code Organization and Conventions + +### File Organization + +**Partial Classes:** Large classes are split using partial classes with `` in `.csproj`: +```xml + + RestClient.cs + +``` + +Examples: +- `RestClient.cs` with `RestClient.Async.cs`, `RestClient.Extensions.*.cs` +- `PropertyCache.cs` with `PropertyCache.Populator.cs`, `PropertyCache.Populator.RequestProperty.cs` + +### Code Style + +- `.editorconfig` is used for code formatting and style rules +- All source files in `/src` must have a license header: + ```text + // Copyright (c) .NET Foundation and Contributors + // + // Licensed under the Apache License, Version 2.0 (the "License"); + // you may not use this file except in compliance with the License. + // You may obtain a copy of the License at + // + // http://www.apache.org/licenses/LICENSE-2.0 + // + // Unless required by applicable law or agreed to in writing, software + // distributed under the License is distributed on an "AS IS" BASIS, + // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + // See the License for the specific language governing permissions and + // limitations under the License. + // + // Adapted from Rebus + ``` +- Test files (all projects located in `/test`) don't need the license header + +**Nullable Reference Types:** +- Enabled in source projects (`Nullable=enable`) +- Disabled in test projects (`Nullable=disable`) + +**Language Version:** `preview` - allows use of latest C# features + +**Implicit Usings:** Enabled globally + +**Warnings:** +- XML documentation warnings suppressed in source (`NoWarn=1591`) +- Test-specific warnings suppressed (`xUnit1033`, `CS8002`) + +### Platform-Specific Code + +Use conditional compilation and attributes: + +```csharp +#if NET +[UnsupportedOSPlatform("browser")] +#endif +public ICredentials? Credentials { get; set; } +``` + +```csharp +#if NET8_0_OR_GREATER +await using var stream = ... +#else +using var stream = ... +#endif +``` + +--- + +## Common Development Tasks + +### Building the Solution + +**Debug build:** +```bash +dotnet build RestSharp.sln -c Debug +``` + +**Release build:** +```bash +dotnet build RestSharp.sln -c Release +``` + +### Working with Source Generator + +**View generated files:** +```bash +# After building +find src/RestSharp/obj -name "*.g.cs" -o -name "ReadOnly*.cs" +``` + +**Debug generator:** +1. Set `true` in project +2. Build project +3. Check `obj///generated/SourceGenerator/` + +**Add new generator:** +1. Create new class implementing `IIncrementalGenerator` +2. Add `[Generator(LanguageNames.CSharp)]` attribute +3. Implement `Initialize` method +4. Register source output + +### Multi-TFM Development + +**Build for specific TFM:** +```bash +dotnet build src/RestSharp/RestSharp.csproj -f net8.0 +``` + +**Check TFM-specific behavior:** +- Use `#if` directives for conditional compilation +- Test against all supported TFMs before committing +- Be aware of API differences (e.g., `Stream.ReadExactly` in .NET 8+) + +### Troubleshooting + +**Issue:** Tests fail on specific TFM +- **Solution:** Run with `-f ` to isolate, check for TFM-specific APIs + +**Issue:** Source generator not running +- **Solution:** Clean and rebuild, check `EmitCompilerGeneratedFiles` setting + +**Issue:** .NET Framework tests fail on non-Windows +- **Solution:** Expected behavior; run with `-f net8.0` or higher on Linux/macOS + +**Issue:** MinVer version incorrect +- **Solution:** Ensure full Git history with `git fetch --prune --unshallow` + +--- + +## Quick Reference Commands + +```bash +# Build solution +dotnet build RestSharp.sln -c Release + +# Run all tests for a single TFM +dotnet test test/RestSharp.Tests/RestSharp.Tests.csproj -f net8.0 + +# Run a single test by FQN +dotnet test test/RestSharp.Tests/RestSharp.Tests.csproj \ + --filter "FullyQualifiedName=RestSharp.Tests.ObjectParserTests.ShouldUseRequestProperty" \ + -f net8.0 + +# Pack locally +dotnet pack src/RestSharp/RestSharp.csproj -c Release -o nuget \ + -p:IncludeSymbols=true -p:SymbolPackageFormat=snupkg + +# Generate code coverage +dotnet test test/RestSharp.Tests/RestSharp.Tests.csproj -f net8.0 \ + --collect:"XPlat Code Coverage" \ + -- DataCollectionRunSettings.DataCollectors.DataCollector.Configuration.Format=cobertura + +# View generated source files +find src/RestSharp/obj/Debug -name "*.g.cs" -o -name "ReadOnly*.cs" + +# Clean all build artifacts +dotnet clean RestSharp.sln +rm -rf src/*/bin src/*/obj test/*/bin test/*/obj gen/*/bin gen/*/obj +``` + +--- + +## Additional Resources + +- **Main Documentation:** https://restsharp.dev +- **Repository:** https://github.com/restsharp/RestSharp +- **NuGet Package:** https://www.nuget.org/packages/RestSharp +- **License:** Apache-2.0 diff --git a/appveyor.yml b/appveyor.yml deleted file mode 100644 index 78258997a..000000000 --- a/appveyor.yml +++ /dev/null @@ -1,44 +0,0 @@ -- - branches: - only: - - master - - artifacts: - path: 'RestSharp\bin\Release\*.nupkg' - - configuration: Release - - image: Visual Studio 2017 - - build_script: - - build.bat - - skip_tags: true - -- - branches: - only: - - develop - - artifacts: - path: 'RestSharp\bin\Debug\*.nupkg' - - configuration: Debug - - image: Visual Studio 2017 - - build_script: - - build.bat - - skip_tags: true - -- - configuration: Debug - - image: Visual Studio 2017 - - build_script: - - build.bat - - skip_tags: true - diff --git a/benchmarks/RestSharp.Benchmarks/Program.cs b/benchmarks/RestSharp.Benchmarks/Program.cs new file mode 100644 index 000000000..6dedaf57e --- /dev/null +++ b/benchmarks/RestSharp.Benchmarks/Program.cs @@ -0,0 +1,4 @@ +using System.Reflection; +using BenchmarkDotNet.Running; + +BenchmarkSwitcher.FromAssembly(Assembly.GetExecutingAssembly()).Run(args); \ No newline at end of file diff --git a/benchmarks/RestSharp.Benchmarks/Requests/AddObjectToRequestParametersBenchmarks.cs b/benchmarks/RestSharp.Benchmarks/Requests/AddObjectToRequestParametersBenchmarks.cs new file mode 100644 index 000000000..355667196 --- /dev/null +++ b/benchmarks/RestSharp.Benchmarks/Requests/AddObjectToRequestParametersBenchmarks.cs @@ -0,0 +1,31 @@ +using BenchmarkDotNet.Attributes; +using BenchmarkDotNet.Order; +using System.Globalization; + +namespace RestSharp.Benchmarks.Requests; + +[MemoryDiagnoser, RankColumn, Orderer(SummaryOrderPolicy.FastestToSlowest)] +public class AddObjectToRequestParametersBenchmarks { + Data _data; + + [GlobalSetup] + public void GlobalSetup() { + const string @string = "random string"; + const int arraySize = 10_000; + var strings = new string[arraySize]; + Array.Fill(strings, @string); + var ints = new int[arraySize]; + Array.Fill(ints, int.MaxValue); + + Thread.CurrentThread.CurrentCulture = CultureInfo.InvariantCulture; + var dateTime = DateTime.Parse("01/01/2013 03:03:12"); + + _data = new(@string, int.MaxValue, strings, ints, dateTime, strings); + } + + [Benchmark(Baseline = true)] + public void AddObject() => new RestRequest().AddObject(_data); + + [Benchmark] + public void AddObjectStatic() => new RestRequest().AddObjectStatic(_data); +} \ No newline at end of file diff --git a/benchmarks/RestSharp.Benchmarks/Requests/Data.cs b/benchmarks/RestSharp.Benchmarks/Requests/Data.cs new file mode 100644 index 000000000..48be615a7 --- /dev/null +++ b/benchmarks/RestSharp.Benchmarks/Requests/Data.cs @@ -0,0 +1,9 @@ +namespace RestSharp.Benchmarks.Requests; + +sealed record Data( + string String, + [property: RequestProperty(Name = "PropertyName")] int Int32, + string[] Strings, + [property: RequestProperty(Format = "00000", ArrayQueryType = RequestArrayQueryType.ArrayParameters)] int[] Ints, + [property: RequestProperty(Name = "DateTime", Format = "hh:mm tt")] object DateTime, + object StringArray); \ No newline at end of file diff --git a/benchmarks/RestSharp.Benchmarks/RestSharp.Benchmarks.csproj b/benchmarks/RestSharp.Benchmarks/RestSharp.Benchmarks.csproj new file mode 100644 index 000000000..3d939e0fb --- /dev/null +++ b/benchmarks/RestSharp.Benchmarks/RestSharp.Benchmarks.csproj @@ -0,0 +1,25 @@ + + + Exe + net9.0 + false + preview + enable + $([MSBuild]::GetDirectoryNameOfFileAbove($(MSBuildProjectDirectory), 'RestSharp.sln')) + + + + + + + + + + + + + + + + + diff --git a/benchmarks/RestSharp.Benchmarks/Serializers/JsonNetSerializeBenchmarks.cs b/benchmarks/RestSharp.Benchmarks/Serializers/JsonNetSerializeBenchmarks.cs new file mode 100644 index 000000000..7a8e40cdc --- /dev/null +++ b/benchmarks/RestSharp.Benchmarks/Serializers/JsonNetSerializeBenchmarks.cs @@ -0,0 +1,22 @@ +using AutoFixture; +using BenchmarkDotNet.Attributes; +using RestSharp.Serializers.NewtonsoftJson; + +namespace RestSharp.Benchmarks.Serializers; + +[MemoryDiagnoser] +public class JsonNetSerializeBenchmarks +{ + readonly JsonNetSerializer _serializer = new(); + + List _fakeData; + + [Params(1, 10, 20)] + public int N { get; set; } + + [GlobalSetup] + public void GlobalSetup() => _fakeData = new Fixture().CreateMany(N).ToList(); + + [Benchmark(Baseline = true)] + public string Serialize() => _serializer.Serialize(_fakeData); +} \ No newline at end of file diff --git a/benchmarks/RestSharp.Benchmarks/Serializers/TestClass.cs b/benchmarks/RestSharp.Benchmarks/Serializers/TestClass.cs new file mode 100644 index 000000000..7345517ab --- /dev/null +++ b/benchmarks/RestSharp.Benchmarks/Serializers/TestClass.cs @@ -0,0 +1,14 @@ +// ReSharper disable UnusedMember.Global +namespace RestSharp.Benchmarks.Serializers; + +public class TestClass { + public string SimpleString { get; set; } + public int SimpleInt { get; set; } + public List List { get; set; } + public Subclass Sub { get; set; } + + public class Subclass { + public string Thing { get; set; } + public int AnotherThing { get; set; } + } +} \ No newline at end of file diff --git a/build.bat b/build.bat deleted file mode 100644 index 1064763f7..000000000 --- a/build.bat +++ /dev/null @@ -1,4 +0,0 @@ -msbuild.exe /t:restore -msbuild.exe /t:build -dotnet test --no-build -msbuild.exe /t:pack /p:Version=106.0.0 \ No newline at end of file diff --git a/docs/.gitignore b/docs/.gitignore new file mode 100644 index 000000000..b2d6de306 --- /dev/null +++ b/docs/.gitignore @@ -0,0 +1,20 @@ +# Dependencies +/node_modules + +# Production +/build + +# Generated files +.docusaurus +.cache-loader + +# Misc +.DS_Store +.env.local +.env.development.local +.env.test.local +.env.production.local + +npm-debug.log* +yarn-debug.log* +yarn-error.log* diff --git a/docs/.idea/.gitignore b/docs/.idea/.gitignore new file mode 100644 index 000000000..13566b81b --- /dev/null +++ b/docs/.idea/.gitignore @@ -0,0 +1,8 @@ +# Default ignored files +/shelf/ +/workspace.xml +# Editor-based HTTP Client requests +/httpRequests/ +# Datasource local storage ignored files +/dataSources/ +/dataSources.local.xml diff --git a/docs/.idea/GitLink.xml b/docs/.idea/GitLink.xml new file mode 100644 index 000000000..009597cc2 --- /dev/null +++ b/docs/.idea/GitLink.xml @@ -0,0 +1,6 @@ + + + + + \ No newline at end of file diff --git a/docs/.idea/docs.iml b/docs/.idea/docs.iml new file mode 100644 index 000000000..24643cc37 --- /dev/null +++ b/docs/.idea/docs.iml @@ -0,0 +1,12 @@ + + + + + + + + + + + + \ No newline at end of file diff --git a/docs/.idea/material_theme_project_new.xml b/docs/.idea/material_theme_project_new.xml new file mode 100644 index 000000000..8cde3b428 --- /dev/null +++ b/docs/.idea/material_theme_project_new.xml @@ -0,0 +1,18 @@ + + + + + + + \ No newline at end of file diff --git a/docs/.idea/modules.xml b/docs/.idea/modules.xml new file mode 100644 index 000000000..6049cfe01 --- /dev/null +++ b/docs/.idea/modules.xml @@ -0,0 +1,8 @@ + + + + + + + + \ No newline at end of file diff --git a/docs/.idea/vcs.xml b/docs/.idea/vcs.xml new file mode 100644 index 000000000..6c0b86358 --- /dev/null +++ b/docs/.idea/vcs.xml @@ -0,0 +1,6 @@ + + + + + + \ No newline at end of file diff --git a/docs/README.md b/docs/README.md new file mode 100644 index 000000000..80e81477a --- /dev/null +++ b/docs/README.md @@ -0,0 +1,26 @@ +# Website + +This is a RestSharp documentation website built using [Docusaurus](https://docusaurus.io/), a modern static website generator. + +### Installation + +``` +$ yarn +``` + +### Local Development + +``` +$ yarn start +``` + +This command starts a local development server and opens up a browser window. Most changes are reflected live without having to restart the server. + +### Build + +``` +$ yarn build +``` + +This command generates static content into the `build` directory and can be served using any static contents hosting service. + diff --git a/docs/babel.config.js b/docs/babel.config.js new file mode 100644 index 000000000..e00595dae --- /dev/null +++ b/docs/babel.config.js @@ -0,0 +1,3 @@ +module.exports = { + presets: [require.resolve('@docusaurus/core/lib/babel/preset')], +}; diff --git a/docs/docs/advanced/_category_.json b/docs/docs/advanced/_category_.json new file mode 100644 index 000000000..f395bdfe4 --- /dev/null +++ b/docs/docs/advanced/_category_.json @@ -0,0 +1,7 @@ +{ + "label": "Advanced topics", + "position": 4, + "link": { + "type": "generated-index" + } +} diff --git a/docs/docs/advanced/authenticators.md b/docs/docs/advanced/authenticators.md new file mode 100644 index 000000000..14196d97c --- /dev/null +++ b/docs/docs/advanced/authenticators.md @@ -0,0 +1,185 @@ +# Authenticators + +RestSharp includes authenticators for basic HTTP, OAuth1 and token-based (JWT and OAuth2). + +There are two ways to set the authenticator: client-wide or per-request. + +Set the client-wide authenticator by assigning the `Authenticator` property of `RestClientOptions`: + +```csharp +var options = new RestClientOptions("https://example.com") { + Authenticator = new HttpBasicAuthenticator("username", "password") +}; +var client = new RestClient(options); +``` + +To set the authenticator per-request, assign the `Authenticator` property of `RestRequest`: + +```csharp +var request = new RestRequest("/api/users/me") { + Authenticator = new HttpBasicAuthenticator("username", "password") +}; +var response = await client.ExecuteAsync(request, cancellationToken); +``` + +## Basic authentication + +The `HttpBasicAuthenticator` allows you pass a username and password as a basic `Authorization` header using a base64 encoded string. + +```csharp +var options = new RestClientOptions("https://example.com") { + Authenticator = new HttpBasicAuthenticator("username", "password") +}; +var client = new RestClient(options); +``` + +## OAuth1 + +For OAuth1 authentication the `OAuth1Authenticator` class provides static methods to help generate an OAuth authenticator. +OAuth1 authenticator will add the necessary OAuth parameters to the request, including signature. + +The authenticator will use `HMAC SHA1` to create a signature by default. +Each static function to create the authenticator allows you to override the default and use another method to generate the signature. + +### Request token + +Getting a temporary request token is the usual first step in the 3-legged OAuth1 flow. +Use `OAuth1Authenticator.ForRequestToken` function to get the request token authenticator. +This method requires a `consumerKey` and `consumerSecret` to authenticate. + +```csharp +var options = new RestClientOptions("https://api.twitter.com") { + Authenticator = OAuth1Authenticator.ForRequestToken(consumerKey, consumerSecret) +}; +var client = new RestClient(options); +var request = new RestRequest("oauth/request_token"); +``` + +The response should contain the token and the token secret, which can then be used to complete the authorization process. +If you need to provide the callback URL, assign the `CallbackUrl` property of the authenticator to the callback destination. + +### Access token + +Getting an access token is the usual third step in the 3-legged OAuth1 flow. +This method retrieves an access token when provided `consumerKey`, `consumerSecret`, `oauthToken`, and `oauthTokenSecret`. +If you don't have a token for this call, you need to make a call to get the request token as described above. + +```csharp +var authenticator = OAuth1Authenticator.ForAccessToken( + consumerKey, consumerSecret, oauthToken, oauthTokenSecret +); +var options = new RestClientOptions("https://api.twitter.com") { + Authenticator = authenticator +}; +var client = new RestClient(options); +var request = new RestRequest("oauth/access_token"); +``` + +If the second step in 3-leg OAuth1 flow returned a verifier value, you can use another overload of `ForAccessToken`: + +```csharp +var authenticator = OAuth1Authenticator.ForAccessToken( + consumerKey, consumerSecret, oauthToken, oauthTokenSecret, verifier +); +``` + +The response should contain the access token that can be used to make calls to protected resources. + +For refreshing access tokens, use one of the two overloads of `ForAccessToken` that accept `sessionHandle`. + +### Protected resource + +When the access token is available, use `ForProtectedResource` function to get the authenticator for accessing protected resources. + +```csharp +var authenticator = OAuth1Authenticator.ForAccessToken( + consumerKey, consumerSecret, accessToken, accessTokenSecret +); +var options = new RestClientOptions("https://api.twitter.com/1.1") { + Authenticator = authenticator +}; +var client = new RestClient(options); +var request = new RestRequest("statuses/update.json", Method.Post) + .AddParameter("status", "Hello Ladies + Gentlemen, a signed OAuth request!") + .AddParameter("include_entities", "true"); +``` + +### xAuth + +xAuth is a simplified version of OAuth1. It allows sending the username and password as `x_auth_username` and `x_auth_password` request parameters and directly get the access token. xAuth is not widely supported, but RestSharp still allows using it. + +Create an xAuth authenticator using `OAuth1Authenticator.ForClientAuthentication` function: + +```csharp +var authenticator = OAuth1Authenticator.ForClientAuthentication( + consumerKey, consumerSecret, username, password +); +``` + +### 0-legged OAuth + +The access token authenticator can be used in 0-legged OAuth scenarios by providing `null` for the `consumerSecret`. + +```csharp +var authenticator = OAuth1Authenticator.ForAccessToken( + consumerKey, null, oauthToken, oauthTokenSecret +); +``` + +## OAuth2 + +RestSharp has two very simple authenticators to send the access token as part of the request. + +`OAuth2UriQueryParameterAuthenticator` accepts the access token as the only constructor argument, and it will send the provided token as a query parameter `oauth_token`. + +`OAuth2AuthorizationRequestHeaderAuthenticator` has two constructors. One only accepts a single argument, which is the access token. The other constructor also allows you to specify the token type. The authenticator will then add an `Authorization` header using the specified token type or `OAuth` as the default token type, and the token itself. + +For example: + +```csharp +var authenticator = new OAuth2AuthorizationRequestHeaderAuthenticator( + token, "Bearer" +); +var options = new RestClientOptions("https://example.com") { + Authenticator = authenticator +}; +var client = new RestClient(options); +``` + +The code above will tell RestSharp to send the bearer token with each request as a header. Essentially, the code above does the same as the sample for `JwtAuthenticator` below. + +As those authenticators don't do much to get the token itself, you might be interested in looking at our [sample OAuth2 authenticator](../usage/example.md#authenticator), which requests the token on its own. + +## JWT + +The JWT authentication can be supported by using `JwtAuthenticator`. It is a very simple class that can be constructed like this: + +```csharp +var authenticator = new JwtAuthenticator(myToken); +var options = new RestClientOptions("https://example.com") { + Authenticator = authenticator +}; +var client = new RestClient(options); +``` + +For each request, it will add an `Authorization` header with the value `Bearer `. + +As you might need to refresh the token from, you can use the `SetBearerToken` method to update the token. + +## Custom authenticator + +You can write your own implementation by implementing `IAuthenticator` and +registering it with your RestClient: + +```csharp +var authenticator = new SuperAuthenticator(); // implements IAuthenticator +var options = new RestClientOptions("https://example.com") { + Authenticator = authenticator +}; +var client = new RestClient(options); +``` + +The `Authenticate` method is the very first thing called upon calling `RestClient.Execute` or `RestClient.Execute`. +It gets the `RestRequest` currently being executed giving you access to every part of the request data (headers, parameters, etc.) + +You can find an example of a custom authenticator that fetches and uses an OAuth2 bearer token [here](../usage/example.md#authenticator). diff --git a/docs/docs/advanced/configuration.md b/docs/docs/advanced/configuration.md new file mode 100644 index 000000000..69b9fa875 --- /dev/null +++ b/docs/docs/advanced/configuration.md @@ -0,0 +1,277 @@ +--- +title: Configuration +description: Learn how to configure RestClient for non-trivial use cases. +sidebar_position: 1 +--- + +# Configuring RestClient + +This page describes how to create and configure `RestClient`. + +## Basic configuration + +The primary `RestClient` constructor accepts an instance of `RestClientOptions`. Most of the time, default option values don't need to be changed. However, in some cases, you'd want to configure the client differently, so you'd need to change some of the options in your code. The constructor also contains a few optional parameters for additional configuration that is not covered by client options. Here's the constructor signature: + +```csharp +public RestClient( + RestClientOptions options, + ConfigureHeaders? configureDefaultHeaders = null, + ConfigureSerialization? configureSerialization = null, + bool useClientFactory = false +) +``` + +Constructor parameters are: + +| Name | Description | Mandatory | +|-------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------| +| options | Client options | Yes | +| configureDefaultHeaders | Function to configure headers. Allows to configure default headers for `HttpClient`. Most of the time you'd prefer using `client.AddDefaultHeader` instead. | No | +| configureSerialization | Function to configure client serializers with non-default options or to use a different serializer ([learn more](serialization.md)) | No | +| useClientFactory | Instructs the client to use `SimpleFactory` ([learn more](../usage/client.md#simple-factory)) to get an `HttpClient` instance | No | + +Here's an example of how to create a client using client options: + +```csharp +var options = new RestClientOptions("https://localhost:5000/api") { + DisableCharset = true +}; +var client = new RestClient(options); +``` + +When you only need to set the base URL, you can use a simplified constructor: + +```csharp +var client = new RestClient("https://localhost:5000/api"); +``` + +The simplified constructor will create an instance of client options and set the base URL provided as the constructor argument. + +Finally, you can override properties of default options using a configuration function. Here's the constructor signature that supports this method: + +```csharp +public RestClient( + ConfigureRestClient? configureRestClient = null, + ConfigureHeaders? configureDefaultHeaders = null, + ConfigureSerialization? configureSerialization = null, + bool useClientFactory = false +) +``` + +For example: + +```csharp +var client = new RestClient(options => { + options.BaseUrl = new Url("https://localhost:5000/api"), + options.DisableCharset = true +}); +``` + +You can also provide the base URL as a constructor argument like this: + +```csharp +var client = new RestClient("https://localhost:5000/api", options => { + options.DisableCharset = true +}); +``` + +## Using custom HttpClient + +By default, RestSharp creates an instance of `HttpClient` configured using the client options, and keeps it during the lifetime of the client. When the `RestClient` instance gets disposed, it also disposes the `HttpClient` instance. + +There might be a case when you need to provide your own `HttpClient`. For example, you would want to use `HttpClient` created by HTTP client factory. RestSharp allows you to do it by using additional constructors. These constructors are: + +```csharp +// Create a client using an existing HttpClient and RestClientOptions (optional) +public RestClient( + HttpClient httpClient, + RestClientOptions? options, + bool disposeHttpClient = false, + ConfigureSerialization? configureSerialization = null +) + +// Create a client using an existing HttpClient and optional RestClient configuration function +public RestClient( + HttpClient httpClient, + bool disposeHttpClient = false, + ConfigureRestClient? configureRestClient = null, + ConfigureSerialization? configureSerialization = null +) +``` + +The `disposeHttpClient` argument tells the client to dispose `HttpClient` when the client itself gets disposed. It's set to `false` by default as when the `HttpClient` is provided from the outside, it should normally be disposed on the outside as well. + +## Using custom message handler + +Unless you use an external instance of `HttpClient`, the `RestClient` creates one when being constructed, and it will use the default HTTP message handler, configured using `RestClientOptions`. Normally, you'd get a `SocketHttpHandler` with modern .NET, and `WinHttpHandler` with .NET Framework. + +There might be a case when you need to configure the HTTP message handler. For example, you want to add a delegating message handler. RestSharp allows you to do it by using additional constructors. There's one constructor that allows you to pass the custom `HttpMessageHandler`: + +```csharp +public RestClient( + HttpMessageHandler handler, + bool disposeHandler = true, + ConfigureRestClient? configureRestClient = null, + ConfigureSerialization? configureSerialization = null +) +``` + +This constructor will create a new `HttpClient` instance using the provided message handler. As RestSharp will dispose the `HttpClient` instance when the `RestClient` instance gets disposed, the handler will be disposed as well. If you want to change that and keep the handler, set the `disposeHandler` parameter to `false`. + +:::note +When using a custom message handler, RestSharp **will not** configure it with client options, which are normally used to configure the handler created by RestSharp. +::: + +Another way to customize the message handler is to allow RestSharp to create a handler, but then configure it, or wrap it in a delegating handler. It can be done by using the `RestClientOptions.ConfigureMessageHandler` property. It can be set to a function that receives the handler created by RestSharp and returned either the same handler with different settings, or a new handler. + +For example, if you want to use `MockHttp` and its handler for testing, you can do it like this: + +```csharp +var mockHttp = new MockHttpMessageHandler(); +// Configure the MockHttp handler to do the checks +... + +var options = new RestClientOptions(Url) { + ConfigureMessageHandler = _ => mockHttp +}; +using var client = new RestClient(options); +``` + +In this example, we are reassigning the handler to MockHttp, so the handler created by RestSharp isn't used. In other cases you want to use delegating handlers as middleware, so you'd pass the handler created by RestSharp to the delegating handler: + +```csharp +var options = new RestClientOptions(Url) { + ConfigureMessageHandler = handler => new MyDelegatingHandler(handler) +}; +using var client = new RestClient(options); +``` + +## Client options + +RestSharp allows configuring `RestClient` using client options, as mentioned at the beginning of this page. Below, you find more details about available options. + +| Option | Description | +|----------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| `BaseUrl` | Client base URL. It can also be provided as the `RestClientOptions` constructor argument. | +| `ConfigureMessageHandler` | Configures the HTTP message handler (see above). | +| `CalculateResponseStatus` | Function to calculate a different response status from `HttpResponseMessage`. By default, the request is considered as complete if it returns a successful status code or 404. | +| `Authenticator` | Client-level authenticator. Read more about authenticators [here](authenticators.md). | +| `Interceptors` | A collector of interceptors. Read more about interceptors [here](interceptors.md). | +| `Credentials` | Instance of `ICredentials` used for NTLM or Kerberos authentication. Not supported in browsers. | +| `UseDefaultCredentials` | Whether to use default OS credentials for NTLM or Kerberos authentication. Not supported in browsers. | +| `DisableCharset` | When set to `true`, the `Content-Type` header won't have the `charset` portion. Some older web servers don't understand the `charset` portion in the header and fail to process the request. | +| `AutomaticDecompression` | Allows customizing supported decompression methods. Default is `All` except for .NET Framework that only support `GZip`. Not supported in browsers. | +| `MaxRedirects` | The number of redirects to follow. Not supported in browsers. | +| `ClientCertificates` | A collection of X.509 client certificates to be used for authentication. Not supported in browsers. | +| `Proxy` | Can be used if the client needs to use an explicit, non-default proxy. Not supported in browsers, on iOS and tvOS. | +| `CachePolicy` | Shortcut for setting the default value for `Cache-Control` header. | +| `FollowRedirects` | Instructs the client to follow redirects. Default is `true`. | +| `Expect100Continue` | Gets or sets a value that indicates if the `Expect` header for an HTTP request contains `Continue`. | +| `UserAgent` | Allows overriding the default value for `User-Agent` header, which is `RestSharp/{version}`. | +| `PreAuthenticate` | Gets or sets a value that indicates whether the client sends an `Authorization` header with the request. Not supported in browsers. | +| `RemoteCertificateValidationCallback` | Custom function to validate the server certificate. Normally, it's used when the server uses a certificate that isn't trusted by default. | +| `BaseHost` | Value for the `Host` header sent with each request. | +| `CookieContainer` | Custom cookie container that will be shared among all calls made by the client. Normally not required as RestSharp handles cookies without using a client-level cookie container. | +| `Timeout` | Client-level timeout as `TimeSpan`. Default is 100 seconds. See [Configuring Timeouts](#configuring-timeouts) for details on timeout behavior. | +| `Encoding` | Default request encoding. Override it only if you don't use UTF-8. | +| `ThrowOnDeserializationError` | Forces the client to throw if it fails to deserialize the response. Remember that not all deserialization issues forces the serializer to throw. Default is `false`, so the client will return a `RestResponse` with deserialization exception details. Only relevant for `Execute...` functions. | +| `FailOnDeserializationError` | When set to `true`, if the client fails to deserialize the response, the response object will have status `Failed`, although the HTTP calls might have been successful. Default is `true`. | +| `ThrowOnAnyError` | When set to `true`, the client will re-throw any exception from `HttpClient`. Default is `false`. Only applies for `Execute...` functions. | +| `AllowMultipleDefaultParametersWithSameName` | By default, adding parameters with the same name is not allowed. You can override this behaviour by setting this property to `true`. | +| `Encode` | A function to encode URLs, the default is a custom RestSharp function based on `Uri.EscapeDataString()`. Set it if you need a different way to do the encoding. | +| `EncodeQuery` | A function to encode URL query parameters. The default is the same function as for `Encode` property. | + +Some of the options are used by RestSharp code, but some are only used to configure the `HttpMessageHandler`. These options are: +- `Credentials` +- `UseDefaultCredentials` +- `AutomaticDecompression` +- `PreAuthenticate` +- `MaxRedirects` +- `RemoteCertificateValidationCallback` +- `ClientCertificates` +- `FollowRedirects` +- `Proxy` + +:::note +If setting these options to non-default values produce no desirable effect, check if your framework and platform supports them. RestSharp doesn't change behaviour based on values of those options. +::: + +The `IRestClient` interface exposes the `Options` property, so any option can be inspected at runtime. However, RestSharp converts the options object provided to the client constructor to an immutable object. Therefore, no client option can be changed after the client is instantiated. It's because changing client options at runtime can produce issues in concurrent environments, effectively rendering the client as not thread-safe. Apart from that, changing the options that are used to create the message handler would require re-creating the handler, and also `HttpClient`, which should not be done at runtime. + +## Configuring requests + +Client options apply to all requests made by the client. Sometimes, you want to fine-tune particular requests, so they execute with custom configuration. It's possible to do using properties of `RestRequest`, described below. + +| Name | Description | +|------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| `AlwaysMultipartFormData` | When set to `true`, the request will be sent as a multipart form, even though it's not required. By default, RestSharp only sends requests with multiple attachments as multipart forms. Default is `false`. | +| `AlwaysSingleFileAsContent` | When set to true, the request with file attachment will not be sent as a multipart form, but as plain content. Default is `false`. It cannot be set to `true` when `AlwaysMultipartFormData` is set to `true`, or when the request has `POST` parameters. | +| `MultipartFormQuoteBoundary` | Default is `true`, which means that the form boundary string will be wrapped in quotes. If the server has an issue with that, setting this to `false` will remove quotes around the boundary. | +| `FormBoundary` | Allows specifying a custom multipart form boundary instead of using the default random string. | +| `RequestParameters` | Collection of request parameters. Normally, you won't need to use it as parameters are added to the request using `Add...` functions. | +| `CookieContainer` | Custom request-level cookie container. Default is `null`. You can still set request cookies using `AddCookie` and get response cookies from the response object without using cooking container. | +| `Authenticator` | Overrides the client-level authenticator. | +| `Files` | Collection of file parameters, read-only. Use `AddFile` for adding files to the request. | +| `Method` | Request HTTP method, default is `GET`. Only needed when using `Execute` or `ExecuteAsync` as other functions like `ExecutePostAsync` will override the request method. | +| `Timeout` | Request-level timeout override. See [Configuring Timeouts](#configuring-timeouts) for details on timeout behavior. | +| `Resource` | Resource part of the remote endpoint URL. For example, when using the client-level base URL `https://localhost:5000/api` and `Resource` set to `weather`, the request will be sent to `https://localhost:5000/api/weather`. It can container resource placeholders to be used in combination with `AddUrlSegment` | +| `RequestFormat` | Identifies the request as JSON, XML, binary, or none. Rarely used because the client will set the request format based on the body type if functions like `AddJsonBody` or `AddXmlBody` are used. | +| `RootElement` | Used by the default deserializers to determine where to start deserializing from. Only supported for XML responses. Does not apply to requests. | +| `OnBeforeDeserialization` | **Obsolete** A function to be called before the response is deserializer. Allows changing the content before calling the deserializer. Use [interceptors](interceptors.md) instead. | +| `OnBeforeRequest` | **Obsolete** A function to be called right before the request is executed by `HttpClient`. It receives an instance of `HttpRequestMessage`. Use [interceptors](interceptors.md) instead. | +| `OnAfterRequest` | **Obsolete** A function to be called right after the request is executed by `HttpClient`. It receives an instance of `HttpResponseMessage`. Use [interceptors](interceptors.md) instead. | +| `Attempts` | When the request is being resent to retry, the property value increases by one. | +| `CompletionOption` | Instructs the client on when it should consider the request to be completed. The default is `ResponseContentRead`. It is automatically changed to `ResponseHeadersRead` when using async download functions or streaming. | +| `CachePolicy` | Overrides the client cache policy. | +| `ResponseWriter` | Allows custom handling of the response stream. The function gets the raw response stream and returns another stream or `null`. Cannot be used in combination with `AdvancedResponseWriter`. | +| `AdvancedResponseWriter` | Allows custom handling of the response. The function gets an instance of `HttpResponseMessage` and an instance of `RestRequest`. It must return an instance of `RestResponse`, so it effectively overrides RestSharp default functionality for creating responses. | +| `Interceptors` | Allows adding interceptors to the request. Both client-level and request-level interceptors will be called. | + +The table below contains all configuration properties of `RestRequest`. To learn more about adding request parameters, check the [usage page](../usage/request.md) page about creating requests with parameters. + +## Configuring Timeouts + +RestSharp provides flexible timeout configuration at both the client and request levels. The timeout determines how long RestSharp will wait for a response before canceling the request. + +:::note Migration from MaxTimeout +In older versions of RestSharp, the `MaxTimeout` property (measured in milliseconds) was used. This has been replaced by the `Timeout` property, which uses `TimeSpan` for more intuitive and type-safe timeout configuration. +::: + +### Timeout Resolution + +When making a request, RestSharp uses the following priority order to determine the timeout: +1. `RestRequest.Timeout` (if set) +2. `RestClientOptions.Timeout` (if set) +3. Default timeout of 100 seconds + +### Timeout Values + +The `Timeout` property accepts a `TimeSpan?` value and supports the following behaviors: + +| Value | Behavior | +|-------|----------| +| `null` (not set) | Uses the next level timeout (client timeout, then default 100 seconds) | +| Positive `TimeSpan` | Request times out after the specified duration (e.g., `TimeSpan.FromSeconds(30)`) | +| `Timeout.InfiniteTimeSpan` or `TimeSpan.FromMilliseconds(-1)` | No timeout - request will wait indefinitely for a response | +| `TimeSpan.Zero` | Request is canceled immediately (effectively no time allowed for the request) | +| Other negative values | Throws `ArgumentOutOfRangeException` when the request is executed | + +### Examples + +```csharp +// Client-level timeout of 30 seconds +var options = new RestClientOptions("https://api.example.com") { + Timeout = TimeSpan.FromSeconds(30) +}; +var client = new RestClient(options); + +// Request-level timeout override +var request = new RestRequest("resource") { + Timeout = TimeSpan.FromSeconds(60) // This request gets 60 seconds +}; + +// Infinite timeout (no timeout) +var longRunningRequest = new RestRequest("long-operation") { + Timeout = Timeout.InfiniteTimeSpan +}; +``` diff --git a/docs/docs/advanced/error-handling.md b/docs/docs/advanced/error-handling.md new file mode 100644 index 000000000..80e822dcc --- /dev/null +++ b/docs/docs/advanced/error-handling.md @@ -0,0 +1,71 @@ +# Error handling + +If there is a network transport error (network is down, failed DNS lookup, etc.), or any kind of server error (except 404), `RestResponse.ResponseStatus` will be set to `ResponseStatus.Error`, otherwise it will be `ResponseStatus.Completed`. + +If an API returns a 404, `ResponseStatus` will still be `Completed`. If you need access to the HTTP status code returned, you will find it at `RestResponse.StatusCode`. +The `Status` property is an indicator of completion independent of the API error handling. + +Normally, RestSharp doesn't throw an exception if the request fails. + +However, it is possible to configure RestSharp to throw in different situations when it normally doesn't throw +in favor of giving you the error as a property. + +| Property | Behavior | +|-------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| `FailOnDeserializationError` | Changes the default behavior when failed deserialization results in a successful response with an empty `Data` property of the response. Setting this property to `true` will tell RestSharp to consider failed deserialization as an error and set the `ResponseStatus` to `Error` accordingly. | +| `ThrowOnDeserializationError` | Changes the default behavior when failed deserialization results in empty `Data` property of the response. Setting this property to `true` will tell RestSharp to throw when deserialization fails. | +| `ThrowOnAnyError` | Setting this property to `true` changes the default behavior and forces RestSharp to throw if any errors occurs when making a request or during deserialization. | + +Those properties are available for the `RestClientOptions` and will be used for all request made with the client instance. + +For example, you can configure the client to throw an exception if any error occurs when making a request or when a request returns a non-successful HTTP status code: + +```csharp +var options = new RestClientOptions(url) { + ThrowOnAnyError = true +}; +var client = new RestClient(options); +var request = new RestRequest("resource/{id}").AddUrlSegment("id", 123); + +// 👇 will throw if the request fails +var deserialized = await client.GetAsync(request); + +// 👇 will NOT throw if the request fails, inspect the response to find out what happened +var response = await client.ExecuteGetAsync(request); +``` + +:::warning +Please be aware that deserialization failures will only work if the serializer throws an exception when deserializing the response. +Many serializers don't throw by default, and just return a `null` result. RestSharp is unable to figure out why `null` is returned, so it won't fail in this case. +Check the serializer documentation to find out if it can be configured to throw on deserialization error. +::: + +There are also slight differences on how different overloads handle exceptions. + +Asynchronous generic methods `GetAsync`, `PostAsync` and so on, which aren't a part of `RestClient` API (those methods are extension methods) return `Task`. It means that there's no `RestResponse` to set the response status to error. We decided to throw an exception when such a request fails. It is a trade-off between the API consistency and usability of the library. Usually, you only need the content of `RestResponse` instance to diagnose issues and most of the time the exception would tell you what's wrong. + +Below, you can find how different extensions deal with errors. Note that functions, which don't throw by default, will throw exceptions when `ThrowOnAnyError` is set to `true`. + +| Function | Throws on errors | +|:----------------------|:-----------------| +| `ExecuteAsync` | No | +| `ExecuteGetAsync` | No | +| `ExecuteGetAsync` | No | +| `ExecutePostAsync` | No | +| `ExecutePostAsync` | No | +| `ExecutePutAsync` | No | +| `ExecutePutAsync` | No | +| `GetAsync` | Yes | +| `GetAsync` | Yes | +| `PostAsync` | Yes | +| `PostAsync` | Yes | +| `PatchAsync` | Yes | +| `PatchAsync` | Yes | +| `DeleteAsync` | Yes | +| `DeleteAsync` | Yes | +| `OptionsAsync` | Yes | +| `OptionsAsync` | Yes | +| `HeadAsync` | Yes | +| `HeadAsync` | Yes | + +In addition, all the functions for JSON requests, like `GetJsonAsync` and `PostJsonAsync` throw an exception if the HTTP call fails. diff --git a/docs/docs/advanced/interceptors.md b/docs/docs/advanced/interceptors.md new file mode 100644 index 000000000..a3bf7a9bc --- /dev/null +++ b/docs/docs/advanced/interceptors.md @@ -0,0 +1,84 @@ +--- +title: Interceptors +--- + +## Intercepting requests and responses + +Interceptors are a powerful feature of RestSharp that allows you to modify requests and responses before they are sent or received. You can use interceptors to add headers, modify the request body, or even cancel the request. You can also use interceptors to modify the response before it is returned to the caller. + +### Implementing an interceptor + +To implement an interceptor, you need to create a class that inherits the `Interceptor` base class. The base class implements all interceptor methods as virtual, so you can override them in your derived class. + +Methods that you can override are: +- `BeforeRequest(RestRequest request, CancellationToken cancellationToken)` +- `AfterRequest(RestResponse response, CancellationToken cancellationToken)` +- `BeforeHttpRequest(HttpRequestMessage requestMessage, CancellationToken cancellationToken)` +- `AfterHttpRequest(HttpResponseMessage responseMessage, CancellationToken cancellationToken)` +- `BeforeDeserialization(RestResponse response, CancellationToken cancellationToken)` + +All those functions must return a `ValueTask` instance. + +Here's an example of an interceptor that adds a header to a request: + +```csharp +// This interceptor adds a header to the request +// You'd not normally use this interceptor, as RestSharp already has a method +// to add headers to the request +class HeaderInterceptor(string headerName, string headerValue) : Interceptors.Interceptor { + public override ValueTask BeforeHttpRequest(HttpRequestMessage requestMessage, CancellationToken cancellationToken) { + requestMessage.Headers.Add(headerName, headerValue); + return ValueTask.CompletedTask; + } +} +``` + +Because interceptor functions return `ValueTask`, you can use `async` and `await` inside them. + +### Using an interceptor + +It's possible to add as many interceptors as you want, both to the client and to the request. The interceptors are executed in the order they were added. + +Adding interceptors to the client is done via the client options: + +```csharp +var options = new RestClientOptions("https://api.example.com") { + Interceptors = [new HeaderInterceptor("Authorization", token)] +}; +var client = new RestClient(options); +``` + +When you add an interceptor to the client, it will be executed for every request made by that client. + +You can also add an interceptor to a specific request: + +```csharp +var request = new RestRequest("resource") { + Interceptors = [new HeaderInterceptor("Authorization", token)] +}; +``` + +In this case, the interceptor will only be executed for that specific request. + +### Deprecation notice + +Interceptors aim to replace the existing request hooks available in RestSharp prior to version 111.0. Those hooks are marked with `Obsolete` attribute and will be removed in the future. If you are using those hooks, we recommend migrating to interceptors as soon as possible. + +To make the migration easier, RestSharp provides a class called `CompatibilityInterceptor`. It has properties for the hooks available in RestSharp 110.0 and earlier. You can use it to migrate your code to interceptors without changing the existing logic. + +For example, a code that uses `OnBeforeRequest` hook: + +```csharp +var request = new RestRequest("success"); +request.OnBeforeDeserialization += _ => throw new Exception(exceptionMessage); +``` + +Can be migrated to interceptors like this: + +```csharp +var request = new RestRequest("success") { + Interceptors = [new CompatibilityInterceptor { + OnBeforeDeserialization = _ => throw new Exception(exceptionMessage) + }] +}; +``` \ No newline at end of file diff --git a/docs/docs/advanced/serialization.md b/docs/docs/advanced/serialization.md new file mode 100644 index 000000000..b7092519a --- /dev/null +++ b/docs/docs/advanced/serialization.md @@ -0,0 +1,148 @@ +# Serialization + +One of the most common reasons to choose RestSharp over plain `HttpClient` is its rich build-in serialization support. RestSharp allows adding complex objects as request body to be serialized when making a call to an API endpoint, and deserializing the response to a given .NET type. RestSharp supports JSON and XML serialization and deserialization by default. In addition, you can use a CSV serializer or write your own. + +In contrast to `System.Net.Http.Json` package that contains `HttpClient` extensions to make `GET` or `POST` calls using JSON, RestSharp support JSON responses for all HTTP methods, not just for `GET`. + +## Configuration + +:::tip +The default behavior of RestSharp is to swallow deserialization errors and return `null` in the `Data` +property of the response. Read more about it in the [Error Handling](error-handling.md). +::: + +You can tell RestSharp to use a custom serializer by using the `configureSerialization` constructor parameter: + +```csharp +var client = new RestClient( + options, + configureSerialization: s => s.UseSerializer(() => new CustomSerializer()); +); +``` + +All RestSharp serializers implement the `IRestSerializer` interface. Among other things, the interface requires implementing the `AcceptedContentTypes` property, which must return a collection of content types supported by the serializer. Being configured to use certain serializers, RestSharp populates the `Accept` header accordingly, so it doesn't need to be set manually. + +When making a call, RestSharp sets the request content type according to the request body type. For example, when you use `AddJsonBody`, the content type is set to `application/json`. Normally, you won't need to set the `Content-Type` header manually. If you need to set a custom content type for a JSON call, you can use the optional `contentType` argument of `AddJsonBody`, for example: + +```csharp +request.AddJsonBody(data, "text/json"); +``` + +## JSON + +The default JSON serializer uses `System.Text.Json`, which is a part of .NET since .NET 6. For earlier versions, it is added as a dependency. There are also a few serializers provided as additional packages. + +By default, RestSharp will use `JsonSerializerDefaults.Web` configuration. If necessary, you can specify your own options: + +```csharp +var client = new RestClient( + options, + configureSerialization: s => s.UseSystemTextJson(new JsonSerializerOptions {...}) +); +``` + +## XML + +The default XML serializer is `DotNetXmlSerializer`, which uses `System.Xml.Serialization` library from .NET. + +In previous versions of RestSharp, the default XML serializer was a custom RestSharp XML serializer. To make the code library size smaller, that serializer is now available as a separate package [`RestSharp.Serializers.Xml`](https://www.nuget.org/packages/RestSharp.Serializers.Xml). +You can add it back if necessary by installing the package and adding it to the client: + +```csharp +var client = new RestClient( + options, + configureSerialization: s => s.UseXmlSerializer() +); +``` + +As before, you can supply three optional arguments for a custom namespace, custom root element, and if you want to use `SerializeAs` and `DeserializeAs` attributed. + +## NewtonsoftJson (aka Json.Net) + +The `NewtonsoftJson` package is the most popular JSON serializer for .NET. It handles all possible scenarios and is very configurable. Such a flexibility comes with the cost of performance. If you need speed, keep the default JSON serializer. + +RestSharp support Json.Net serializer via a separate package [`RestSharp.Serializers.NewtonsoftJson`](https://www.nuget.org/packages/RestSharp.Serializers.NewtonsoftJson). + +:::warning +Please note that `RestSharp.Newtonsoft.Json` package is not provided by RestSharp, is marked as obsolete on NuGet, and no longer supported by its creator. +::: + +Use the extension method provided by the package to configure the client: + +```csharp +var client = new RestClient( + options, + configureSerialization: s => s.UseNewtonsoftJson() +); +``` + +The serializer configures some options by default: + +```csharp +JsonSerializerSettings DefaultSettings = new JsonSerializerSettings { + ContractResolver = new CamelCasePropertyNamesContractResolver(), + DefaultValueHandling = DefaultValueHandling.Include, + TypeNameHandling = TypeNameHandling.None, + NullValueHandling = NullValueHandling.Ignore, + Formatting = Formatting.None, + ConstructorHandling = ConstructorHandling.AllowNonPublicDefaultConstructor +}; +``` + +If you need to use different settings, you can supply your instance of +`JsonSerializerSettings` as a parameter for the extension method. + +## CSV + +A separate package `RestSharp.Serializers.CsvHelper` provides a CSV serializer for RestSharp. It is based on the +`CsvHelper` library. + +Use the extension method provided by the package to configure the client: + +```csharp +var client = new RestClient( + options, + configureSerialization: s => s.UseCsvHelper() +); +``` + +You can also supply your instance of `CsvConfiguration` as a parameter for the extension method. + +```csharp +var client = new RestClient( + options, + configureSerialization: s => s.UseCsvHelper( + new CsvConfiguration(CultureInfo.InvariantCulture) {...} + ) +); +``` + +## Custom + +You can also implement your custom serializer. To support both serialization and +deserialization, you must implement the `IRestSerializer` interface. + +Here is an example of a custom serializer that uses `System.Text.Json`: + +```csharp +public class SimpleJsonSerializer : IRestSerializer { + public string? Serialize(object? obj) => obj == null ? null : JsonSerializer.Serialize(obj); + + public string? Serialize(Parameter bodyParameter) => Serialize(bodyParameter.Value); + + public T? Deserialize(RestResponse response) => JsonSerializer.Deserialize(response.Content!); + + public ContentType ContentType { get; set; } = ContentType.Json; + + public ISerializer Serializer => this; + public IDeserializer Deserializer => this; + public DataFormat DataFormat => DataFormat.Json; + public string[] AcceptedContentTypes => ContentType.JsonAccept; + public SupportsContentType SupportsContentType + => contentType => contentType.Value.EndsWith("json", StringComparison.InvariantCultureIgnoreCase); +} +``` + +The `SupportedContentTypes` function will be used to check if the serializer is able to deserialize the response based on the `Content-Type` response header. + +The `ContentType` property will be used when making a request so the server knows how to handle the payload. diff --git a/docs/docs/changelog.md b/docs/docs/changelog.md new file mode 100644 index 000000000..f637a8f51 --- /dev/null +++ b/docs/docs/changelog.md @@ -0,0 +1,19 @@ +--- +title: What's new +description: List of changes for the current major version +sidebar_position: 1 +--- + +# Changelog + +For release notes of previous versions, please check the [Releases page](https://github.com/restsharp/RestSharp/releases) in RestSharp GitHub repository. + +Changes between major versions are documented in the documentation for each version on this website. + +# v112.0 + +* Security fix for [CVE-2024-45302](https://github.com/restsharp/RestSharp/security/advisories/GHSA-4rr6-2v9v-wcpc). Header values cannot contain `CRLF`. + +## v112.1 + +* Follow up on v112.0 security fix: remove `\t` from the list of forbidden characters in headers. diff --git a/docs/docs/intro.md b/docs/docs/intro.md new file mode 100644 index 000000000..961c5350a --- /dev/null +++ b/docs/docs/intro.md @@ -0,0 +1,112 @@ +--- +sidebar_position: 2 +title: Quick start +--- + +## Introduction + +:::warning +RestSharp v107+ changes the library API surface and its behaviour significantly. We advise looking at [migration](/migration) docs to understand how to migrate to the latest version of RestSharp. +::: + +The main purpose of RestSharp is to make synchronous and asynchronous calls to remote resources over HTTP. As the name suggests, the main audience of RestSharp are developers who use REST APIs. However, RestSharp can call any API over HTTP, as long as you have the resource URI and request parameters that you want to send comply with W3C HTTP standards. + +One of the main challenges of using HTTP APIs for .NET developers is to work with requests and responses of different kinds and translate them to complex C# types. RestSharp can take care of serializing the request body to JSON or XML and deserialize the response. It can also form a valid request URI based on different parameter kinds: path, query, form or body. + +## Getting Started + +Before you can use RestSharp in your application, you need to add the NuGet package. You can do it using your IDE or the command line: + +``` +dotnet add package RestSharp +``` + +### Basic Usage + +If you only have a small number of one-off API requests to perform, you can use RestSharp like this: + +```csharp +using RestSharp; +using RestSharp.Authenticators; + +var options = new RestClientOptions("https://api.twitter.com/1.1") { + Authenticator = new HttpBasicAuthenticator("username", "password") +}; +var client = new RestClient(options); +var request = new RestRequest("statuses/home_timeline.json"); +// The cancellation token comes from the caller. You can still make a call without it. +var response = await client.GetAsync(request, cancellationToken); +``` + +It will return a `RestResponse` back, which contains all the information returned from the remote server. +You have access to the headers, content, HTTP status and more. + +You can also use generic overloads like `Get` to automatically deserialize the response into a .NET class. + +For example: + +```csharp +using RestSharp; +using RestSharp.Authenticators; + +var options = new RestClientOptions("https://api.twitter.com/1.1") { + Authenticator = new HttpBasicAuthenticator("username", "password") +}; +var client = new RestClient(options); + +var request = new RestRequest("statuses/home_timeline.json"); + +// The cancellation token comes from the caller. You can still make a call without it. +var timeline = await client.GetAsync(request, cancellationToken); +``` + +Both snippets above use the `GetAsync` extension, which is a wrapper about `ExecuteGetAsync`, which, in turn, is a wrapper around `ExecuteAsync`. +All `ExecuteAsync` overloads and return the `RestResponse` or `RestResponse`. + +The most important difference is that async methods named after HTTP methods (like `GetAsync` or `PostAsync`) return `Task` instead of `Task>`. It means that you won't get an error response if the request fails as those methods throw an exception for unsuccessful HTTP calls. For keeping the API consistent, non-generic functions like `GetAsync` or `PostAsync` also throw an exception if the request fails, although they return the `Task`. + +Read [here](advanced/error-handling.md) about how RestSharp handles exceptions. + +RestSharp also offers simple ways to call APIs that accept and return JSON payloads. You can use the `GetJsonAsync` and `PostJsonAsync` extension methods, which will automatically serialize the request body to JSON and deserialize the response to the specified type. + +```csharp +var client = new RestClient(options); +var timeline = await client.GetJsonAsync("statuses/home_timeline.json", cancellationToken); +``` + +Read [here](usage/execute.md#json-requests) about making JSON calls without preparing a request object. + +### Content type + +RestSharp supports sending XML or JSON body as part of the request. To add a body to the request, simply call `AddJsonBody` or `AddXmlBody` method of the `RestRequest` object. + +There is no need to set the `Content-Type` or add the `DataFormat` parameter to the request when using those methods, RestSharp will do it for you. + +RestSharp will also handle both XML and JSON responses and perform all necessary deserialization tasks, depending on the server response type. Therefore, you only need to add the `Accept` header if you want to deserialize the response manually. + +For example, only you'd only need these lines to make a request with JSON body: + +```csharp +var request = new RestRequest("address/update").AddJsonBody(updatedAddress); +var response = await client.PostAsync(request); +``` + +It's also possible to make the same call using `PostAsync` shorter syntax: + +```csharp +var response = await PostJsonAsync( + "address/update", request, cancellationToken +); +``` + +Read more about serialization and deserialization [here](advanced/serialization.md). + +### Response + +When you use `ExecuteAsync`, you get an instance of `RestResponse` back. The response object has the `Content` property, which contains the response as string. You can find other useful properties there, like `StatusCode`, `ContentType` and so on. If the request wasn't successful, you'd get a response back with `IsSuccessful` property set to `false` and the error explained in the `ErrorException` and `ErrorMessage` properties. + +When using typed `ExecuteAsync`, you get an instance of `RestResponse` back, which is identical to `RestResponse` but also contains the `T Data` property with the deserialized response. + +None of `ExecuteAsync` overloads throw if the remote server returns an error. You can inspect the response and find the status code, error message, and, potentially, an exception. + +Extensions like `GetAsync` will not return the whole `RestResponse` but just a deserialized response. These extensions will throw an exception if the remote server returns an error. The exception details contain the status code returned by the server. diff --git a/docs/docs/usage/_category_.json b/docs/docs/usage/_category_.json new file mode 100644 index 000000000..bd2045cd6 --- /dev/null +++ b/docs/docs/usage/_category_.json @@ -0,0 +1,7 @@ +{ + "label": "Using RestSharp", + "position": 3, + "link": { + "type": "generated-index" + } +} diff --git a/docs/docs/usage/basics.md b/docs/docs/usage/basics.md new file mode 100644 index 000000000..6bbb5594a --- /dev/null +++ b/docs/docs/usage/basics.md @@ -0,0 +1,23 @@ +--- +sidebar_position: 2 +--- + +# RestSharp basics + +This page describes some of the essential properties and features of RestSharp. + +## What RestSharp does + +Essentially, RestSharp is a wrapper around `HttpClient` that allows you to do the following: +- Add default parameters of any kind (not just headers) to the client, once +- Add parameters of any kind to each request (query, URL segment, form, attachment, serialized body, header) in a straightforward way +- Serialize the payload to JSON or XML if necessary +- Set the correct content headers (content type, disposition, length, etc.) +- Handle the remote endpoint response +- Deserialize the response from JSON or XML if necessary + +## API client + +The best way to call an external HTTP API is to create a typed client, which encapsulates RestSharp calls and doesn't expose the `RestClient` instance in public. + +You can find an example of a Twitter API client on the [Example](example.md) page. diff --git a/docs/docs/usage/client.md b/docs/docs/usage/client.md new file mode 100644 index 000000000..e84b955f4 --- /dev/null +++ b/docs/docs/usage/client.md @@ -0,0 +1,115 @@ +--- +sidebar_position: 3 +title: Creating the client +--- + +## Constructors + +A RestSharp client can be instantiated by one of its constructors. Two most commonly used constructors are: + +#### Only specify the base URL + +You can create an instance of `RestClient` with only a single parameter: the base URL. Even that isn't required as base URL can be left empty. In that case, you'd need to specify the absolute path for each call. When the base URL is set, you can use both relative and absolute path. + +```csharp +// Creates a client with default options to call a given base URL +var client = new RestClient("https://localhost:5000"); +``` + +#### Provide client options + +The most common way to create a client is to use the constructor with options. The options object has the type of `RestClientOptions`. +Here's an example of how to create a client using the same base path as in the previous sample, but with a couple additional settings: + +```csharp +// Creates a client using the options object +var options = new RestClientOptions("https://localhost:5000") { + MaxTimeout = 1000 +}; +var client = new RestClient(options); +``` + +#### Advanced configuration + +RestSharp can be configured with more tweaks, including default request options, how it should handle responses, how serialization works, etc. You can also provide your own instance of `HttpClient` or `HttpMessageHandler`. + +Read more about the advanced configuration of RestSharp on a [dedicated page](../advanced/configuration.md). + +## Simple factory + +Another way to create the client instance is to use a simple client factory. The factory will use the `BaseUrl` property of the client options to cache `HttpClient` instances. Every distinct base URL will get its own `HttpClient` instance. Other options don't affect the caching. Therefore, if you use different options for the same base URL, you'll get the same `HttpClient` instance, which will not be configured with the new options. Options that aren't applied _after_ the first client instance is created are: + +* `Credentials` +* `UseDefaultCredentials` +* `AutomaticDecompression` +* `PreAuthenticate` +* `FollowRedirects` +* `RemoteCertificateValidationCallback` +* `ClientCertificates` +* `MaxRedirects` +* `MaxTimeout` +* `UserAgent` +* `Expect100Continue` + +Constructor parameters to configure the `HttpMessageHandler` and default `HttpClient` headers configuration are also ignored for the cached instance as the factory only configures the handler once. + +You need to set the `useClientFactory` parameter to `true` in the `RestClient` constructor to enable the factory. + +```csharp +var options = new RestClientOptions("https://api.twitter.com/2"); +var client = new RestClient(options, useClientFactory: true); +``` + +## Reusing HttpClient + +RestSharp uses `HttpClient` internally to make HTTP requests. It's possible to reuse the same `HttpClient` instance for multiple `RestClient` instances. This is useful when you want to share the same connection pool between multiple `RestClient` instances. + +One way of doing it is to use `RestClient` constructors that accept an instance of `HttpClient` or `HttpMessageHandler` as an argument. Note that in that case not all the options provided via `RestClientOptions` will be used. Here is the list of options that will work: + +- `BaseAddress` is be used to set the base address of the `HttpClient` instance if base address is not set there already. +- `MaxTimeout` is used to cancel the call using the cancellation token source, so +- `UserAgent` will be added to the `RestClient.DefaultParameters` list as a HTTP header. This will be added to each request made by the `RestClient`, and the `HttpClient` instance will not be modified. This is to allow the `HttpClient` instance to be reused for scenarios where different `User-Agent` headers are required. +- `Expect100Continue` + +Another option is to use a simple HTTP client factory as described [above](#simple-factory). + +## Blazor support + +Inside a Blazor webassembly app, you can make requests to external API endpoints. Microsoft examples show how to do it with `HttpClient`, and it's also possible to use RestSharp for the same purpose. + +You need to remember that webassembly has some platform-specific limitations. Therefore, you won't be able to instantiate `RestClient` using all of its constructors. In fact, you can only use `RestClient` constructors that accept `HttpClient` or `HttpMessageHandler` as an argument. If you use the default parameterless constructor, it will call the option-based constructor with default options. The options-based constructor will attempt to create an `HttpMessageHandler` instance using the options provided, and it will fail with Blazor, as some of those options throw thw "Unsupported platform" exception. + +Here is an example how to register the `RestClient` instance globally as a singleton: + +```csharp +builder.Services.AddSingleton(new RestClient(new HttpClient())); +``` + +Then, on a page you can inject the instance: + +```html +@page "/fetchdata" +@using RestSharp +@inject RestClient _restClient +``` + +And then use it: + +```csharp +@code { + private WeatherForecast[]? forecasts; + + protected override async Task OnInitializedAsync() { + forecasts = await _restClient.GetJsonAsync("http://localhost:5104/weather"); + } + + public class WeatherForecast { + public DateTime Date { get; set; } + public int TemperatureC { get; set; } + public string? Summary { get; set; } + public int TemperatureF => 32 + (int)(TemperatureC / 0.5556); + } +} +``` + +In this case, the call will be made to a WebAPI server hosted at `http://localhost:5104/weather`. Remember that if the WebAPI server is not hosting the webassembly itself, it needs to have a CORS policy configured to allow the webassembly origin to access the API endpoint from the browser. diff --git a/docs/docs/usage/example.md b/docs/docs/usage/example.md new file mode 100644 index 000000000..6182d8ff3 --- /dev/null +++ b/docs/docs/usage/example.md @@ -0,0 +1,152 @@ +--- +sidebar_position: 1 +--- + +# Example + +RestSharp works best as the foundation for a proxy class for your API. Each API would most probably require different settings for `RestClient`. Hence, a dedicated API class (and its interface) gives you sound isolation between different `RestClient` instances and make them testable. + +For example, let's look at a simple Twitter API v2 client, which uses OAuth2 machine-to-machine authentication. For it to work, you would need to have access to the Twitter Developers portal, a project, and an approved application inside the project with OAuth2 enabled. + +## Client model + +Before implementing an API client, we need to have a model for it. The model includes an abstraction for the client, which has functions for the API calls we are interested to implement. In addition, the client model would include the necessary request and response models. Usually those are simple classes or records without logic, which are often referred to as DTOs (data transfer objects). + +This example starts with a single function that retrieves one Twitter user. Lets being by defining the API client interface: + +```csharp +public interface ITwitterClient { + Task GetUser(string user); +} +``` + +As the function returns a `TwitterUser` instance, we need to define it as a model: + +```csharp +public record TwitterUser(string Id, string Name, string Username); +``` + +## Client implementation + +When that is done, we can implement the interface and add all the necessary code blocks to get a working API client. + +The client class needs the following: +- A constructor for passing API credentials +- A wrapped `RestClient` instance with the Twitter API base URI pre-configured +- An authenticator to support authorizing the client using Twitter OAuth2 authentication +- The actual function to get the user (to implement the `ITwitterClient` interface) + +Creating an authenticator is described [below](#authenticator). + +Here's how the client implementation could look like: + +```csharp +public class TwitterClient : ITwitterClient, IDisposable { + readonly RestClient _client; + + public TwitterClient(string apiKey, string apiKeySecret) { + var options = new RestClientOptions("https://api.twitter.com/2"); + _client = new RestClient(options); + } + + public async Task GetUser(string user) { + var response = await _client.GetAsync>( + "users/by/username/{user}", + new { user } + ); + return response!.Data; + } + + record TwitterSingleObject(T Data); + + public void Dispose() { + _client?.Dispose(); + GC.SuppressFinalize(this); + } +} +``` + +It is also possible to use ASP.NET Core Options for configuring the client, instead of passing the credentials as strings. For example, we can add a class for Twitter client options, and use it in a constructor: + +```csharp +public class TwitterClientOptions(string ApiKey, string ApiSecret); + +public TwitterClient(IOptions options) { + var opt = new RestClientOptions("https://api.twitter.com/2"); + _client = new RestClient(options); +} +``` + +Then, you can register and configure the client using ASP.NET Core dependency injection container. + +Right now, the client won't really work as Twitter API requires authentication. It's covered in the next section. + +## Authenticator + +Before we can call the API itself, we need to get a bearer token. Twitter exposes an endpoint `https://api.twitter.com/oauth2/token`. As it follows the OAuth2 conventions, the code can be used to create an authenticator for some other vendors. + +First, we need a model for deserializing the token endpoint response. OAuth2 uses snake case for property naming, so we need to decorate model properties with `JsonPropertyName` attribute: + +```csharp +record TokenResponse { + [JsonPropertyName("token_type")] + public string TokenType { get; init; } + [JsonPropertyName("access_token")] + public string AccessToken { get; init; } +} +``` + +Next, we create the authenticator itself. It needs the API key and API key secret to call the token endpoint using basic HTTP authentication. In addition, we can extend the list of parameters with the base URL to convert it to a more generic OAuth2 authenticator. + +The easiest way to create an authenticator is to inherit from the `AuthenticatorBase` base class: + +```csharp +public class TwitterAuthenticator : AuthenticatorBase { + readonly string _baseUrl; + readonly string _clientId; + readonly string _clientSecret; + + public TwitterAuthenticator(string baseUrl, string clientId, string clientSecret) : base("") { + _baseUrl = baseUrl; + _clientId = clientId; + _clientSecret = clientSecret; + } + + protected override async ValueTask GetAuthenticationParameter(string accessToken) { + Token = string.IsNullOrEmpty(Token) ? await GetToken() : Token; + return new HeaderParameter(KnownHeaders.Authorization, Token); + } +} +``` + +During the first call made by the client using the authenticator, it will find out that the `Token` property is empty. It will then call the `GetToken` function to get the token once and reuse the token going forward. + +Now, we need to implement the `GetToken` function in the class: + +```csharp +async Task GetToken() { + var options = new RestClientOptions(_baseUrl){ + Authenticator = new HttpBasicAuthenticator(_clientId, _clientSecret), + }; + using var client = new RestClient(options); + + var request = new RestRequest("oauth2/token") + .AddParameter("grant_type", "client_credentials"); + var response = await client.PostAsync(request); + return $"{response!.TokenType} {response!.AccessToken}"; +} +``` + +As we need to make a call to the token endpoint, we need our own short-lived instance of `RestClient`. Unlike the actual Twitter client, it will use the `HttpBasicAuthenticator` to send the API key and secret as the username and password. The client then gets disposed as we only use it once. + +Here we add a POST parameter `grant_type` with `client_credentials` as its value. At the moment, it's the only supported value. + +The POST request will use the `application/x-www-form-urlencoded` content type by default. + +::: note +Sample code provided on this page is a production code. For example, the authenticator might produce undesired side effect when multiple requests are made at the same time when the token hasn't been obtained yet. It can be solved rather than simply using semaphores or synchronized invocation. +::: + +## Final words + +This page demonstrates how an API client can be implemented as a typed, configurable client with its own interface. Usage of the client in applications is not covered here as different application types and target frameworks have their own idiomatic ways to use HTTP clients. \ No newline at end of file diff --git a/docs/docs/usage/execute.md b/docs/docs/usage/execute.md new file mode 100644 index 000000000..36343f793 --- /dev/null +++ b/docs/docs/usage/execute.md @@ -0,0 +1,172 @@ +--- +sidebar_position: 5 +title: Making calls +--- + +## Executing requests + +Once you've added all the parameters to your `RestRequest`, you are ready to make a request. + +`RestClient` has a single function for this: + +```csharp +public async Task ExecuteAsync( + RestRequest request, + CancellationToken cancellationToken = default +) +``` + +You can also avoid setting the request method upfront and use one of the overloads: + +```csharp +Task ExecuteGetAsync(RestRequest request, CancellationToken cancellationToken) +Task ExecutePostAsync(RestRequest request, CancellationToken cancellationToken) +Task ExecutePutAsync(RestRequest request, CancellationToken cancellationToken) +Task ExecuteDeleteAsync(RestRequest request, CancellationToken cancellationToken) +Task ExecuteHeadAsync(RestRequest request, CancellationToken cancellationToken) +Task ExecuteOptionsAsync(RestRequest request, CancellationToken cancellationToken) +``` + +When using any of those methods, you will get the response content as string in `response.Content`. + +RestSharp can deserialize the response for you. To use that feature, use one of the generic overloads: + +```csharp +Task> ExecuteAsync(RestRequest request, CancellationToken cancellationToken) +Task> ExecuteGetAsync(RestRequest request, CancellationToken cancellationToken) +Task> ExecutePostAsync(RestRequest request, CancellationToken cancellationToken) +Task> ExecutePutAsync(RestRequest request, CancellationToken cancellationToken) +Task> ExecuteDeleteAsync(RestRequest request, CancellationToken cancellationToken) +Task> ExecuteHeadAsync(RestRequest request, CancellationToken cancellationToken) +Task> ExecuteOptionsAsync(RestRequest request, CancellationToken cancellationToken) +``` + +:::note Beware of errors +All the overloads with names starting with `Execute` don't throw an exception if the server returns an error. Read more about it [here](../advanced/error-handling.md). +It allows you to inspect responses and handle remote server errors gracefully. Overloads without `Execute` prefix throw exceptions in case of any error, so you'd need to ensure to handle exceptions properly. +::: + +If you just need a deserialized response, you can use one of the extensions: + +```csharp +Task GetAsync(RestRequest request, CancellationToken cancellationToken) +Task PostAsync(RestRequest request, CancellationToken cancellationToken) +Task PutAsync(RestRequest request, CancellationToken cancellationToken) +Task PatchAsync(RestRequest request, CancellationToken cancellationToken) +Task DeleteAsync(RestRequest request, CancellationToken cancellationToken) +Task HeadAsync(RestRequest request, CancellationToken cancellationToken) +Task OptionsAsync(RestRequest request, CancellationToken cancellationToken) +``` + +Those extensions will throw an exception if the server returns an error, as there's no other way to float the error back to the caller. + +The `IRestClient` interface also has extensions for making requests without deserialization, which throw an exception if the server returns an error even if the client is configured to not throw exceptions. + +```csharp +Task GetAsync(RestRequest request, CancellationToken cancellationToken) +Task PostAsync(RestRequest request, CancellationToken cancellationToken) +Task PutAsync(RestRequest request, CancellationToken cancellationToken) +Task PatchAsync(RestRequest request, CancellationToken cancellationToken) +Task DeleteAsync(RestRequest request, CancellationToken cancellationToken) +Task HeadAsync(RestRequest request, CancellationToken cancellationToken) +Task OptionsAsync(RestRequest request, CancellationToken cancellationToken) +``` + +### Sync calls + +The preferred way for making requests is to execute them asynchronously as HTTP calls are IO-bound operations. +If you are unable to make async calls, all the functions about have sync overloads, which have the same names without `Async` suffix. +For example, for making a sync `GET` call you can use `ExecuteGet(request)` or `Get`, etc. + +## Requests without body + +Some HTTP methods don't suppose to be used with request body. For those methods, RestSharp supports making simplified calls without using `RestRequest`. All you need is to provide the resource path as a string. + +For example, you can make a `DELETE` call like this: + +```csharp +var response = await client.ExecuteDeleteAsync($"order/delete/{orderId}", cancellationToken); +``` + +Similarly, you can make `GET` calls with or without deserialization of the response using `ExecuteGetAsync(resource)`, `GetAsync(resource)`, `ExecuteGetAsync(resource)`, and `GetAsync(resource)` (see below). + +## JSON requests + +RestSharp provides an easier API for making calls to endpoints that accept and return JSON. + +### GET calls + +To make a simple `GET` call and get a deserialized JSON response with a pre-formed resource string, use this: + +```csharp +var response = await client.GetAsync("endpoint?foo=bar", cancellationToken); +``` + +:::note +In v111, `GetJsonAsync` is renamed to `GetAsync`. +::: + +You can also use a more advanced extension that uses an object to compose the resource string: + +```csharp +var client = new RestClient("https://example.org"); +var args = new { + id = "123", + foo = "bar" +}; +// Will make a call to https://example.org/endpoint/123?foo=bar +var response = await client.GetAsync("endpoint/{id}", args, cancellationToken); +``` + +It will search for the URL segment parameters matching any of the object properties and replace them with values. All the other properties will be used as query parameters. + +One note about `GetAsync` is that it will deserialize the response with any supported content type, not only JSON. + +### POST calls + +Similar things are available for `POST` requests. + +```csharp +var request = new CreateOrder("123", "foo", 10100); +// Will post the request object as JSON to "orders" and returns a +// JSON response deserialized to OrderCreated +var result = client.PostJsonAsync("orders", request, cancellationToken); +``` + +```csharp +var request = new CreateOrder("123", "foo", 10100); +// Will post the request object as JSON to "orders" and returns a +// status code, not expecting any response body +var statusCode = client.PostJsonAsync("orders", request, cancellationToken); +``` + +The same two extensions also exist for `PUT` requests (`PutJsonAsync`); + +## Downloading binary data + +There are two functions that allow you to download binary data from the remote API. + +First, there's `DownloadDataAsync`, which returns `Task`. This function allows you to open a stream reader and asynchronously stream large responses to memory or disk. + +## JSON streaming + +For HTTP API endpoints that stream the response data (like [Twitter search stream](https://developer.twitter.com/en/docs/twitter-api/tweets/filtered-stream/api-reference/get-tweets-search-stream)) you can use RestSharp with `StreamJsonAsync`, which returns an `IAsyncEnumerable`: + +```csharp +public async IAsyncEnumerable SearchStream( + [EnumeratorCancellation] CancellationToken cancellationToken = default +) { + var response = _client.StreamJsonAsync>( + "tweets/search/stream", cancellationToken + ); + + await foreach (var item in response.WithCancellation(cancellationToken)) { + yield return item.Data; + } +} +``` + +The main limitation of this function is that it expects each JSON object to be returned as a single line. It is unable to parse the response by combining multiple lines into a JSON string. + diff --git a/docs/docs/usage/request.md b/docs/docs/usage/request.md new file mode 100644 index 000000000..76343b347 --- /dev/null +++ b/docs/docs/usage/request.md @@ -0,0 +1,356 @@ +--- +sidebar_position: 4 +title: Preparing requests +--- + +## Create a request + +Before making a request using `RestClient`, you need to create a request instance: + +```csharp +var request = new RestRequest(resource); // resource is the sub-path of the client base path +``` + +The default request type is `GET` and you can override it by setting the `Method` property. You can also set the method using the constructor overload: + +```csharp +var request = new RestRequest(resource, Method.Post); +``` + +After you've created a `RestRequest`, you can add parameters to it. Below, you can find all the parameter types supported by RestSharp. + +## Request headers + +Adds the header parameter as an HTTP header that is sent along with the request. The header name is the parameter's name and the header value is the value. + +You can use one of the following request methods to add a header parameter: + +```csharp +AddHeader(string name, string value); +AddHeader(string name, T value); // value will be converted to string +AddOrUpdateHeader(string name, string value); // replaces the header if it already exists +``` + +For example: + +```csharp +var request = new RestRequest("/path").AddHeader("X-Key", someKey); +``` + +You can also add header parameters to the client, and they will be added to every request made by the client. This is useful for adding authentication headers, for example. + +```csharp +client.AddDefaultHeader(string name, string value); +``` + +:::warning Avoid setting Content-Type header +RestSharp will use the correct content type by default. Avoid adding the `Content-Type` header manually to your requests unless you are absolutely sure it is required. You can add a custom content type to the [body parameter](#request-body) itself. +::: + +## Get or Post parameters + +The default RestSharp parameter type is `GetOrPostParameter`. You can add `GetOrPost` parameter to the request using the `AddParameter` function: + +```csharp +request + .AddParameter("name1", "value1") + .AddParameter("name2", "value2"); +``` + +`GetOrPost` behaves differently based on the HTTP method. If you execute a `GET` call, RestSharp will append the parameters to the URL in the form `url?name1=value1&name2=value2`. + +On a `POST` or `PUT` requests, it depends on whether you have files attached to a request. +If not, the parameters will be sent as the body of the request in the form `name1=value1&name2=value2`. Also, the request will be sent as `application/x-www-form-urlencoded`. + +In both cases, name and value will automatically be URL-encoded, unless specified otherwise: + +```csharp +request.AddParameter("name", "Væ üé", false); // don't encode the value +``` + +If you have files, RestSharp will send a `multipart/form-data` request. Your parameters will be part of this request in the form: + +``` +Content-Type: text/plain; charset=utf-8 +Content-Disposition: form-data; name="parameterName" + +ParameterValue +``` + +Sometimes, you need to override the default content type for the parameter when making a multipart form call. It's possible to do by setting the `ContentType` property of the parameter object. As an example, the code below will create a POST parameter with JSON value, and set the appropriate content type: + +```csharp +var parameter = new GetOrPostParameter("someJson", "{\"attributeFormat\":\"pdf\"}") { + ContentType = "application/json" +}; +request.AddParameter(parameter); +``` + +When the request is set to use multipart content, the parameter will be sent as part of the request with the specified content type: + +``` +Content-Type: application/json; charset=utf-8 +Content-Disposition: form-data; name="someJson" + +{"attributeFormat":"pdf"} +``` + +You can also add `GetOrPost` parameter as a default parameter to the client. This will add the parameter to every request made by the client. + +```csharp +client.AddDefaultParameter("foo", "bar"); +``` + +It will work the same way as request parameters, except that it will be added to every request. + +## Query string + +`QueryString` works like `GetOrPost`, except that it always appends the parameters to the url in the form `url?name1=value1&name2=value2`, regardless of the request method. + +Example: + +```csharp +var client = new RestClient("https://search.me"); +var request = new RestRequest("search") + .AddParameter("foo", "bar"); +var response = await client.GetAsync(request); +``` + +It will send a `GET` request to `https://search.me/search?foo=bar`. + +For `POST`-style requests you need to add the query string parameter explicitly: + +```csharp +request.AddQueryParameter("foo", "bar"); +``` + +In some cases, you might need to prevent RestSharp from encoding the query string parameter. +To do so, set the `encode` argument to `false` when adding the parameter: + +```csharp +request.AddQueryParameter("foo", "bar/fox", false); +``` + +You can also add a query string parameter as a default parameter to the client. This will add the parameter to every request made by the client. + +```csharp +client.AddDefaultQueryParameter("foo", "bar"); +``` + +The line above will result in all the requests made by that client instance to have `foo=bar` in the query string for all the requests made by that client. + +## Using AddObject + +You can avoid calling `AddParameter` multiple times if you collect all the parameters in an object, and then use `AddObject`. +For example, this code: + +```csharp +var params = new { + status = 1, + priority = "high", + ids = new [] { "123", "456" } +}; +request.AddObject(params); +``` + +is equivalent to: + +```csharp +request.AddParameter("status", 1); +request.AddParameter("priority", "high"); +request.AddParameter("ids", "123,456"); +``` + +Remember that `AddObject` only works if your properties have primitive types. It also works with collections of primitive types as shown above. + +If you need to override the property name or format, you can do it using the `RequestProperty` attribute. For example: + +```csharp +public class RequestModel { + // override the name and the format + [RequestProperty(Name = "from_date", Format = "d")] + public DateTime FromDate { get; set; } +} + +// add it to the request +request.AddObject(new RequestModel { FromDate = DateTime.Now }); +``` + +In this case, the request will get a GET or POST parameter named `from_date` and its value would be the current date in short date format. + +## Using AddObjectStatic + +Request function `AddObjectStatic(...)` allows using pre-compiled expressions for getting property values. Compared to `AddObject` that uses reflections for each call, `AddObjectStatic` caches functions to retrieve properties from an object of type `T`, so it works much faster. + +You can instruct `AddObjectStatic` to use custom parameter names and formats, as well as supply the list of properties than need to be used as parameters. The last option could be useful if the type `T` has properties that don't need to be sent with HTTP call. + +To use custom parameter name or format, use the `RequestProperty` attribute. For example: + +```csharp +class TestObject { + [RequestProperty(Name = "some_data")] + public string SomeData { get; set; } + + [RequestProperty(Format = "d")] + public DateTime SomeDate { get; set; } + + [RequestProperty(Name = "dates", Format = "d")] + public DateTime[] DatesArray { get; set; } + + public int Plain { get; set; } + public DateTime[] PlainArray { get; set; } +} +``` + +## URL segment parameter + +Unlike `GetOrPost`, URL segment parameter replaces placeholder values in the request URL: + +```csharp +var request = new RestRequest("health/{entity}/status") + .AddUrlSegment("entity", "s2"); +``` + +When the request executes, RestSharp will try to match any `{placeholder}` with a parameter of that name (without the `{}`) and replace it with the value. So the above code results in `health/s2/status` being the URL. + +You can also add `UrlSegment` parameter as a default parameter to the client. This will add the parameter to every request made by the client. + +```csharp +client.AddDefaultUrlSegment("foo", "bar"); +``` + +## Cookies + +You can add cookies to a request using the `AddCookie` method: + +```csharp +request.AddCookie("foo", "bar"); +``` + +The simple two-parameter form defers domain resolution until execution time — the cookie domain is inferred from the request URL. If you need to specify the path and domain explicitly, use the four-parameter overload: + +```csharp +request.AddCookie("foo", "bar", "/path", "example.com"); +``` + +RestSharp will add cookies from the request as cookie headers and then extract the matching cookies from the response. You can observe and extract response cookies using the `RestResponse.Cookies` properties, which has the `CookieCollection` type. + +There is a `CookieContainer` instance on the request level. You can either assign the pre-populated container to `request.CookieContainer`, or let the container be created automatically at execution time. The four-parameter `AddCookie` overload populates the container immediately, while the two-parameter form stores cookies in `PendingCookies` until the request is executed. The container is used to extract all the cookies from it and create cookie headers for the request instead of using the container directly. It's because the cookie container is normally configured on the `HttpClientHandler` level and cookies are shared between requests made by the same client. In most of the cases this behaviour can be harmful. + +If your use case requires sharing cookies between requests made by the client instance, you can use the client-level `CookieContainer`, which you must provide as the options' property. You can add cookies to the container using the container API. No response cookies, however, would be auto-added to the container, but you can do it in code by getting cookies from the `Cookies` property of the response and adding them to the client-level container available via `IRestClient.Options.CookieContainer` property. + +## Request Body + +RestSharp supports multiple ways to add a request body: +- `AddJsonBody` for JSON payloads +- `AddXmlBody` for XML payloads +- `AddStringBody` for pre-serialized payloads + +We recommend using `AddJsonBody` or `AddXmlBody` methods instead of `AddParameter` with type `BodyParameter`. Those methods will set the proper request type and do the serialization work for you. + +When you make a `POST`, `PUT` or `PATCH` request and added `GetOrPost` [parameters](#get-or-post-parameters), RestSharp will send them as a URL-encoded form request body by default. When a request also has files, it will send a `multipart/form-data` request. You can also instruct RestSharp to send the body as `multipart/form-data` by setting the `AlwaysMultipartFormData` property to `true`. + +You can specify a custom body content type if necessary. The `contentType` argument is available in all the overloads that add a request body. + +It is not possible to add client-level default body parameters. + +### String body + +If you have a pre-serialized payload like a JSON string, you can use `AddStringBody` to add it as a body parameter. You need to specify the content type, so the remote endpoint knows what to do with the request body. For example: + +```csharp +const json = "{ data: { foo: \"bar\" } }"; +request.AddStringBody(json, ContentType.Json); +``` + +### JSON body + +When you call `AddJsonBody`, it does the following for you: + +- Instructs the RestClient to serialize the object parameter as JSON when making a request +- Sets the content type to `application/json` +- Sets the internal data type of the request body to `DataType.Json` + +Here is the example: + +```csharp +var param = new MyClass { IntData = 1, StringData = "test123" }; +request.AddJsonBody(param); +``` + +It is possible to override the default content type by supplying the `contentType` argument. For example: + +```csharp +request.AddJsonBody(param, "text/x-json"); +``` + +If you use a pre-serialized string with `AddJsonBody`, it will be sent as-is. The `AddJsonBody` will detect if the parameter is a string and will add it as a string body with JSON content type. +Essentially, it means that top-level strings won't be serialized as JSON when you use `AddJsonBody`. To overcome this issue, you can use an overload of `AddJsonBody`, which allows you to tell RestSharp to serialize the string as JSON: + +```csharp +const string payload = @" +""requestBody"": { + ""content"": { + ""application/json"": { + ""schema"": { + ""type"": ""string"" + } + } + } +},"; +request.AddJsonBody(payload, forceSerialize: true); // the string will be serialized +request.AddJsonBody(payload); // the string will NOT be serialized and will be sent as-is +``` + +### XML body + +When you call `AddXmlBody`, it does the following for you: + +- Instructs the RestClient to serialize the object parameter as XML when making a request +- Sets the content type to `application/xml` +- Sets the internal data type of the request body to `DataType.Xml` + +:::warning +Do not send XML string to `AddXmlBody`; it won't work! +::: + +## Uploading files + +To add a file to the request you can use the `RestRequest` function called `AddFile`. The main function accepts the `FileParameter` argument: + +```csharp +request.AddFile(fileParameter); +``` + +You can instantiate the file parameter using `FileParameter.Create` that accepts a bytes array, or `FileParameter.FromFile`, which will load the file from disk. + +There are also extension functions that wrap the creation of `FileParameter` inside: + +```csharp +// Adds a file from disk +AddFile(parameterName, filePath, contentType); + +// Adds an array of bytes +AddFile(parameterName, bytes, fileName, contentType); + +// Adds a stream returned by the getFile function +AddFile(parameterName, getFile, fileName, contentType); +``` + +Remember that `AddFile` will set all the necessary headers, so please don't try to set content headers manually. + +You can also provide file upload options to the `AddFile` call. The options are: +- `DisableFilenameEncoding` (default `false`): if set to `true`, RestSharp will not encode the file name in the `Content-Disposition` header +- `DisableFilenameStar` (default `true`): if set to `true`, RestSharp will not add the `filename*` parameter to the `Content-Disposition` header + +Example of using the options: + +```csharp +var options = new FileParameterOptions { + DisableFilenameEncoding = true, + DisableFilenameStar = false +}; +request.AddFile("file", filePath, options: options); +``` + +The options specified in the snippet above usually help when you upload files with non-ASCII characters in their names. diff --git a/docs/docs/usage/response.md b/docs/docs/usage/response.md new file mode 100644 index 000000000..43745ec39 --- /dev/null +++ b/docs/docs/usage/response.md @@ -0,0 +1,49 @@ +--- +sidebar_position: 6 +title: Handling responses +--- + +All `Execute{Method}Async` functions return an instance of `RestResponse`. Similarly, `Execute{Method}Async` return a generic instance of `RestResponse` where `T` is the response object type. + +Response object contains the following properties: + +| Property | Type | Description | +|--------------------------|-----------------------------------------------------|------------------------------------------------------------------------------------------| +| `Request` | `RestRequest` | Request instance that was used to get the response. | +| `ContentType` | `string?` | Response content type. `Null` if response has no content. | +| `ContentLength` | `long?` | Response content length. `Null` if response has no content. | +| `ContentEncoding` | `ICollection` | Content encoding collection. Empty if response has no content. | +| `Content` | `string?` | Response content as string. `Null` if response has no content. | +| `IsSuccessfulStatusCode` | `bool` | Indicates if response was successful, so no errors were reported by the server. | +| `ResponseStatus` | `None`, `Completed`, `Error`, `TimedOut`, `Aborted` | Response completion status. Note that completed responses might still return errors. | +| `IsSuccessful` | `bool` | `True` when `IsSuccessfulStatusCode` is `true` and `ResponseStatus` is `Completed`. | +| `StatusDescription` | `string?` | Response status description, if available. | +| `RawBytes` | `byte[]?` | Response content as byte array. `Null` if response has no content. | +| `ResponseUri` | `Uri?` | URI of the response, which might be different from request URI in case of redirects. | +| `Server` | `string?` | Server header value of the response. | +| `Cookies` | `CookieCollection?` | Collection of cookies received with the response, if any. | +| `Headers` | Collection of `HeaderParameter` | Response headers. | +| `ContentHeaders` | Collection of `HeaderParameter` | Response content headers. | +| `ErrorMessage` | `string?` | Transport or another non-HTTP error generated while attempting request. | +| `ErrorException` | `Exception?` | Exception thrown when executing the request, if any. | +| `Version` | `Version?` | HTTP protocol version of the request. | +| `RootElement` | `string?` | Root element of the serialized response content, only works if deserializer supports it. | +| `MergedParameters` | `ParametersCollection` | Combined view of request parameters and client default parameters at execution time. | + +### Merged parameters + +The `MergedParameters` property provides a combined view of the request's own parameters and the client's [default parameters](request.md#request-headers) as they were at execution time. This is useful for logging or debugging the full set of parameters that were applied to a request, since `Request.Parameters` only contains the parameters added directly to the request. + +```csharp +var response = await client.ExecuteAsync(request); + +foreach (var param in response.MergedParameters) { + Console.WriteLine($"{param.Name} = {param.Value} ({param.Type})"); +} +``` + +In addition, `RestResponse` has one additional property: + +| Property | Type | Description | +|----------|------|-----------------------------------------------------------------------------------------------------------------------------------------------------------| +| `Data` | `T?` | Deserialized response object. `Null` if there's no content in the response, deserializer failed to understand the response content, or if request failed. | diff --git a/docs/docusaurus.config.ts b/docs/docusaurus.config.ts new file mode 100644 index 000000000..1000950fa --- /dev/null +++ b/docs/docusaurus.config.ts @@ -0,0 +1,138 @@ +import type {Config} from "@docusaurus/types"; +import type * as Preset from "@docusaurus/preset-classic"; +import {themes} from "prism-react-renderer"; + +const config: Config = { + title: "RestSharp", + tagline: "Simple REST and HTTP API Client for .NET", + favicon: "img/favicon.ico", + url: "https://restsharp.dev", + baseUrl: "/", + onBrokenLinks: "throw", + i18n: { + defaultLocale: "en", + locales: ["en"], + }, + markdown: { + hooks: { + onBrokenMarkdownLinks: "warn", + } + }, + plugins: [ + [ + '@docusaurus/plugin-client-redirects', + { + redirects: [ + { + from: '/v107', + to: '/migration', + }, + ], + }, + ], + ], + + presets: [[ + "classic", { + docs: { + editUrl: "https://github.com/RestSharp/RestSharp/tree/dev/docs", + sidebarPath: "./sidebars.ts", + includeCurrentVersion: true, + versions: { + "v111": { + label: "v111" + }, + "v110": { + label: "v110" + } + } + }, + theme: { + customCss: "./src/css/custom.css", + }, + } satisfies Preset.Options, + ]], + + themeConfig: { + navbar: { + title: "RestSharp", + logo: { + alt: "RestSharp Logo", + src: "img/restsharp.png", + }, + items: [ + { + type: "docSidebar", + sidebarId: "tutorialSidebar", + position: "left", + label: "Documentation", + }, + { + href: "/migration", + label: "Migration from v106" + }, + { + href: "/support", + label: "Support", + }, + { + type: "docsVersionDropdown", + position: "right", + }, + { + href: 'https://github.com/RestSharp/RestSharp', + label: "GitHub", + position: "right", + }, + ], + }, + footer: { + style: "dark", + links: [ + { + title: "Docs", + items: [ + { + label: "Documentation", + to: "/docs/intro", + }, + ], + }, + { + title: "Community", + items: [ + { + label: "Stack Overflow", + href: "https://stackoverflow.com/questions/tagged/restsharp", + }, + { + label: "Discord", + href: "https://discordapp.com/invite/docusaurus", + }, + { + label: "Twitter", + href: "https://twitter.com/RestSharp", + }, + ], + }, + { + title: "More", + items: [ + { + label: "GitHub", + href: "https://github.com/RestSharp/RestSharp", + }, + ], + }, + ], + copyright: `Copyright © ${new Date().getFullYear()} .NET Foundation. Built with Docusaurus.`, + }, + prism: { + theme: themes.vsLight, + darkTheme: themes.vsDark, + additionalLanguages: ['csharp'], + }, + } satisfies Preset.ThemeConfig, +}; + +export default config; diff --git a/docs/package.json b/docs/package.json new file mode 100644 index 000000000..ff37c28c3 --- /dev/null +++ b/docs/package.json @@ -0,0 +1,46 @@ +{ + "name": "docs", + "version": "0.0.0", + "private": true, + "scripts": { + "docusaurus": "docusaurus", + "start": "docusaurus start", + "build": "docusaurus build", + "swizzle": "docusaurus swizzle", + "deploy": "docusaurus deploy", + "clear": "docusaurus clear", + "serve": "docusaurus serve", + "write-translations": "docusaurus write-translations", + "write-heading-ids": "docusaurus write-heading-ids", + "typecheck": "tsc" + }, + "dependencies": { + "@docusaurus/core": "^3.9.2", + "@docusaurus/plugin-client-redirects": "^3.9.2", + "@docusaurus/preset-classic": "^3.9.2", + "@mdx-js/react": "^3.1.1", + "clsx": "^2.1.1", + "prism-react-renderer": "^2.4.1", + "react": "^19.2.0", + "react-dom": "^19.2.0" + }, + "devDependencies": { + "@docusaurus/module-type-aliases": "^3.9.2", + "@docusaurus/tsconfig": "^3.9.2", + "@docusaurus/types": "^3.9.2", + "typescript": "~5.9.3" + }, + "browserslist": { + "production": [ + ">0.5%", + "not dead", + "not op_mini all" + ], + "development": [ + "last 3 chrome version", + "last 3 firefox version", + "last 5 safari version" + ] + }, + "packageManager": "pnpm@10.10.0" +} diff --git a/docs/sidebars.ts b/docs/sidebars.ts new file mode 100644 index 000000000..431ed961b --- /dev/null +++ b/docs/sidebars.ts @@ -0,0 +1,21 @@ +import type {SidebarsConfig} from '@docusaurus/plugin-content-docs'; + +const sidebars: SidebarsConfig = { + // By default, Docusaurus generates a sidebar from the docs folder structure + tutorialSidebar: [{type: 'autogenerated', dirName: '.'}], + + // But you can create a sidebar manually + /* + tutorialSidebar: [ + 'intro', + 'hello', + { + type: 'category', + label: 'Tutorial', + items: ['tutorial-basics/create-a-document'], + }, + ], + */ +}; + +export default sidebars; diff --git a/docs/src/components/HomepageFeatures/index.tsx b/docs/src/components/HomepageFeatures/index.tsx new file mode 100644 index 000000000..fd953b7c6 --- /dev/null +++ b/docs/src/components/HomepageFeatures/index.tsx @@ -0,0 +1,70 @@ +import clsx from "clsx"; +import Heading from "@theme/Heading"; +import styles from "./styles.module.css"; + +type FeatureItem = { + title: string; + // Svg: React.ComponentType>; + description: JSX.Element; +}; + +const FeatureList: FeatureItem[] = [ + { + title: "Serialization", + // Svg: require('@site/static/img/undraw_docusaurus_mountain.svg').default, + description: ( + <> + Make calls using XML or JSON body, and receive XML or JSON responses. + RestSharp takes care of serializing requests and deserializing responses, as well as adding the correct content type. + + ), + }, + { + title: "Fully async", + // Svg: require('@site/static/img/undraw_docusaurus_tree.svg').default, + description: ( + <> + RestSharp API has an extensive number of async functions to make all sort of HTTP calls. + It still provides sync overloads to allow using RestSharp in legacy applications or non-async environments. + + ), + }, + { + title: "Parameters", + // Svg: require('@site/static/img/undraw_docusaurus_react.svg').default, + description: ( + <> + Whether you want to add a query, a URL, or URL-encoded form parameters, RestSharp allows doing it with one line of code. + The same applies to sending files and using multipart forms. + + ), + }, +]; + +function Feature({ title, description }: FeatureItem) { + return ( +
+ {/*
*/} + {/* */} + {/*
*/} +
+ {title} +

{description}

+
+
+ ); +} + +export default function HomepageFeatures(): JSX.Element { + return ( +
+
+
+ {FeatureList.map((props, idx) => ( + + ))} +
+
+
+ ); +} diff --git a/docs/src/components/HomepageFeatures/styles.module.css b/docs/src/components/HomepageFeatures/styles.module.css new file mode 100644 index 000000000..b248eb2e5 --- /dev/null +++ b/docs/src/components/HomepageFeatures/styles.module.css @@ -0,0 +1,11 @@ +.features { + display: flex; + align-items: center; + padding: 2rem 0; + width: 100%; +} + +.featureSvg { + height: 200px; + width: 200px; +} diff --git a/docs/src/css/custom.css b/docs/src/css/custom.css new file mode 100644 index 000000000..2bc6a4cfd --- /dev/null +++ b/docs/src/css/custom.css @@ -0,0 +1,30 @@ +/** + * Any CSS included here will be global. The classic template + * bundles Infima by default. Infima is a CSS framework designed to + * work well for content-centric websites. + */ + +/* You can override the default Infima variables here. */ +:root { + --ifm-color-primary: #2e8555; + --ifm-color-primary-dark: #29784c; + --ifm-color-primary-darker: #277148; + --ifm-color-primary-darkest: #205d3b; + --ifm-color-primary-light: #33925d; + --ifm-color-primary-lighter: #359962; + --ifm-color-primary-lightest: #3cad6e; + --ifm-code-font-size: 95%; + --docusaurus-highlighted-code-line-bg: rgba(0, 0, 0, 0.1); +} + +/* For readability concerns, you should choose a lighter palette in dark mode. */ +[data-theme='dark'] { + --ifm-color-primary: #25c2a0; + --ifm-color-primary-dark: #21af90; + --ifm-color-primary-darker: #1fa588; + --ifm-color-primary-darkest: #1a8870; + --ifm-color-primary-light: #29d5b0; + --ifm-color-primary-lighter: #32d8b4; + --ifm-color-primary-lightest: #4fddbf; + --docusaurus-highlighted-code-line-bg: rgba(0, 0, 0, 0.3); +} diff --git a/docs/src/pages/index.module.css b/docs/src/pages/index.module.css new file mode 100644 index 000000000..9f71a5da7 --- /dev/null +++ b/docs/src/pages/index.module.css @@ -0,0 +1,23 @@ +/** + * CSS files with the .module.css suffix will be treated as CSS modules + * and scoped locally. + */ + +.heroBanner { + padding: 4rem 0; + text-align: center; + position: relative; + overflow: hidden; +} + +@media screen and (max-width: 996px) { + .heroBanner { + padding: 2rem; + } +} + +.buttons { + display: flex; + align-items: center; + justify-content: center; +} diff --git a/docs/src/pages/index.tsx b/docs/src/pages/index.tsx new file mode 100644 index 000000000..0374fc9ac --- /dev/null +++ b/docs/src/pages/index.tsx @@ -0,0 +1,43 @@ +import clsx from 'clsx'; +import Link from '@docusaurus/Link'; +import useDocusaurusContext from '@docusaurus/useDocusaurusContext'; +import Layout from '@theme/Layout'; +import HomepageFeatures from '@site/src/components/HomepageFeatures'; +import Heading from '@theme/Heading'; + +import styles from './index.module.css'; + +function HomepageHeader() { + const {siteConfig} = useDocusaurusContext(); + return ( +
+
+ RestSharp logo + + {siteConfig.title} + +

{siteConfig.tagline}

+
+ + Get Started + +
+
+
+ ); +} + +export default function Home(): JSX.Element { + const {siteConfig} = useDocusaurusContext(); + return ( + + +
+ +
+ + ); +} diff --git a/docs/src/pages/markdown-page.md b/docs/src/pages/markdown-page.md new file mode 100644 index 000000000..9756c5b66 --- /dev/null +++ b/docs/src/pages/markdown-page.md @@ -0,0 +1,7 @@ +--- +title: Markdown page example +--- + +# Markdown page example + +You don't need React to write simple standalone pages. diff --git a/docs/src/pages/migration.md b/docs/src/pages/migration.md new file mode 100644 index 000000000..902472ed7 --- /dev/null +++ b/docs/src/pages/migration.md @@ -0,0 +1,339 @@ +--- +title: Migration from v106 and earlier +--- + +## New RestSharp + +RestSharp got a major upgrade in v107, which contains quite a few breaking changes. + +The most important change is that RestSharp stop using the legacy `HttpWebRequest` class, and uses well-known `HttpClient` instead. +This move solves lots of issues, like hanging connections due to improper `HttpClient` instance cache, updated protocols support, and many other problems. + +Another big change is that `SimpleJson` is retired completely from the code base. Instead, RestSharp uses `JsonSerializer` from the `System.Text.Json` package, which is the default serializer for ASP.NET Core. + +Finally, most of the interfaces are now gone. + +## Brief migration guide + +### RestClient and options + +The `IRestClient` interface is deprecated in v107, but brought back in v109. The new interface, however, has a much smaller API compared to previous versions. You will be using the `RestClient` class instance. + +Most of the client options are moved to `RestClientOptions`. If you can't find the option you used to set on `IRestClient`, check the options; it's probably there. + +This is how you can instantiate the client using the simplest possible way: + +```csharp +var client = new RestClient("https://api.myorg.com"); +``` + +For customizing the client, use `RestClientOptions`: + +```csharp +var options = new RestClientOptions("https://api.myorg.com") { + ThrowOnAnyError = true, + Timeout = TimeSpan.FromSeconds(1) +}; +var client = new RestClient(options); +``` + +You can still change serializers and add default parameters to the client. + +::: +Note that client options cannot be changed after the client is instantiated. +It's because the client constructor either uses those options to configure its internal `HttpClient`, `HttpMessageHandler` or for making requests. +Even though options that are used for making requests can be changed in theory, making those options mutable would make `RestClient` not thread-safe. +::: + +### RestClient lifecycle + +Do not instantiate `RestClient` for each HTTP call. RestSharp creates a new instance of `HttpClient` internally, and you will get lots of hanging connections, and eventually exhaust the connection pool. + +If you use a dependency-injection container, register your API client as a singleton. + +### Body parameters + +Beware that most of the code generators, like Postman C# code gen, generate code for RestSharp before v107, and that code is broken. Such code worked mostly due to the obscurity of previous RestSharp versions API. For example, Postman-generated code tells you to add the content-type header, and the accept header, which in many cases is an anti-pattern. It also posts JSON payload as string, where RestSharp provides you with serialization and deserialization of JSON out of the box. + +Therefore, please read the [current version](/docs/intro/) documentation and follow our guidelines when using RestSharp v107+. + +Some of the points to be aware of: +- `AddParameter("application/json", ..., ParameterType.RequestBody)` won't work, use `AddBody` instead, or better, `AddJsonBody`. +- `AddJsonBody("{ foo: 'bar' }")` won't work (and it never worked), use `AddStringBody`. `AddJsonBody` is for serializable objects, not for strings. +- If your `AddParameter(something, something, ParameterType.RequestBody)` doesn't work, try `AddBody` as it will do its best to figure out what kind of body you're adding. + +### Headers + +Lots of code out there that uses RestSharp has lines like: + +```csharp +request.AddHeader("Content-Type", "application/json"); +request.AddHeader("Accept", "application/json"); +``` + +This is **completely unnecessary**, and often harmful. The `Content-Type` header is the content header, not the request header. It might be different per individual part of the body when using multipart-form data, for example. RestSharp sets the correct content-type header automatically, based on your body format, so don't override it. +The `Accept` header is set by RestSharp automatically based on registered serializers. By default, both XML and JSON are supported. Only change the `Accept` header if you need something else, like binary streams, or plain text. + +### Making requests + +The `IRestRequest` interface is deprecated. You will be using the `RestRequest` class instance. + +You can still create a request as before: + +```csharp +var request = new RestRequest(); +``` + +Adding parameters hasn't changed much, except you cannot add cookie parameters to the request. It's because cookies are added to the `HttpMessageHandler` cookie container, which is not accessible inside the request class. + +```csharp +var request = new RestRequest() + .AddQueryParameter("foo", "bar") + .AddJsonBody(someObject); +``` + +Quite a few options previously available via `IRestRequest` are now in `RestClientOptions`. It's also because changing those options forced us to use a different HTTP message handler, and it caused hanging connections, etc. + +When you got a request instance, you can make a call: + +```csharp +var request = new RestRequest() + .AddQueryParameter("foo", "bar") + .AddJsonBody(someObject); +var response = await client.PostAsync(request, cancellationToken); +``` + +The `IRestResponse` interface is deprecated. You get an instance of `RestResponse` or `RestResponse` in return. + +You can also use a simplified API for making POST and PUT requests: + +```csharp +var request = new MyRequest { Data = "foo" }; +var response = await client.PostAsync(request, cancellationToken); +// response will be of type TResponse +``` + +This way you avoid instantiating `RestRequest` explicitly. + +### Using your own HttpClient + +`RestClient` class has two constructors, which accept either `HttpClient` or `HttpMessageHandler` instance. + +This way you can use a pre-configured `HttpClient` or `HttpMessageHandler`, customized for your needs. + +### Default serializers + +For JSON, RestSharp will use `JsonSerializer` from the `System.Text.Json` package. This package is now referenced by default, and it is the only dependency of the RestSharp NuGet package. + +The `Utf8` serializer package is deprecated as the package is not being updated. + +For XML requests and responses RestSharp uses `DotNetXmlSerializer` and `DotNetXmlDeserializer`. +Previously used default `XmlSerializer`, `XmlDeserializer`, and `XmlAttrobuteDeserializer` are moved to a separate package `RestSharp.Serializers.Xml`. + +### NTLM authentication + +The `NtlmAuthenticator` is deprecated. + +NTLM authenticator was doing nothing more than telling `WebRequest` to use certain credentials. Now with RestSharp, the preferred way would be to set the `Credentials` or `UseDefaultCredentials` property in `RestClientOptions`. + +The reason to remove it was that all other authenticators use `AuthenticatorBase`, which must return a parameter. In general, any authenticator is given a request before its made, so it can do something with it. NTLM doesn't work this way, it needs some settings to be provided for `HttpClientHandler`, which is set up before the `HttpClient` instance is created, and it happens once per RestClient instance, and it cannot be changed per request. + +### Delegating handlers + +You can easily build your own request/response pipeline, as you would with `HttpClient`. RestClient will create an `HttpMessageHandler` instance for its own use, using the options provided. You can, of course, provide your own instance of `HttpMessageHandler` as `RestSharpClient` has a constructor that accepts a custom handler and uses it to create an `HttpClient` instance. However, you'll be on your own with the handler configuration in this case. + +If you want to build a _pipeline_, use [delegating handlers](https://docs.microsoft.com/en-us/aspnet/web-api/overview/advanced/httpclient-message-handlers). For example, you can use `HttpTracer` to [debug your HTTP calls](https://github.com/BSiLabs/HttpTracer) like this: + +```csharp +var options = new RestClientOptions(_server.Url) { + ConfigureMessageHandler = handler => + new HttpTracerHandler(handler, new ConsoleLogger(), HttpMessageParts.All) +}; +var client = new RestClient(options); +``` + +## Recommended usage + +`RestClient` should be thread-safe. It holds an instance of `HttpClient` and `HttpMessageHandler` inside. +Do not instantiate the client for a single call, otherwise you get issues with hanging connections and connection pooling won't be possible. + +Do create typed API clients for your use cases. Use a single instance of `RestClient` internally in such an API client for making calls. +It would be similar to using typed clients using `HttpClient`, for example: + +```csharp +public class GitHubClient { + readonly RestClient _client; + + public GitHubClient() { + _client = new RestClient("https://api.github.com/") + .AddDefaultHeader(KnownHeaders.Accept, "application/vnd.github.v3+json"); + } + + public Task GetRepos() + => _client.GetJsonAsync("users/aspnet/repos"); +} +``` + +Do not use one instance of `RestClient` across different API clients. + +This documentation contains the complete example of a [Twitter API client](/docs/intro), which you can use as a reference. + +## Presumably solved issues + +The next RestSharp version presumably solves the following issues: +- Connection pool starvation +- Hanging open TCP connections +- Improper handling of async calls +- Various `SimpleJson` serialization quirks +- HTTP/2 support +- Intermediate certificate issue +- Uploading large files (use file parameters with `Stream`) +- Downloading large files (use `DownloadFileStreamAsync`) + +## Deprecated interfaces + +The following interfaces are removed from RestSharp: +- `IRestRequest` +- `IRestResponse` +- `IHttp` + +### Mocking + +Mocking an infrastructure component like RestSharp (or HttpClient) is not the best idea. Even if you check that all the parameters are added correctly to the request, your "unit test" will only give you a false sense of safety that your code actually works. But, you have no guarantee that the remote server will accept your request, or if you can handle the actual response correctly. + +However, since v109 you can still mock the `IRestClient` interface, but you only need to implement the `ExecuteAsync` method. The `ExecuteAsync` method is the only one that actually makes a call to the remote server. All other methods are just wrappers around it. + +The best way to test HTTP calls is to make some, using the actual service you call. However, you might still want to check if your API client forms requests in a certain way. You might also be sure about what the remote server responds to your calls with, so you can build a set of JSON (or XML) responses, so you can simulate remote calls. + +It is perfectly doable without using interfaces. As RestSharp uses `HttpClient` internally, it certainly uses `HttpMessageHandler`. Features like delegating handlers allow you to intercept the request pipeline, inspect the request, and substitute the response. You can do it yourself, or use a library like [MockHttp](https://github.com/richardszalay/mockhttp). They have an example provided in the repository README, so we have changed it for RestClient here: + +```csharp +var mockHttp = new MockHttpMessageHandler(); + +// Setup a respond for the user api (including a wildcard in the URL) +mockHttp.When("http://localhost/api/user/*") + .Respond("application/json", "{'name' : 'Test McGee'}"); // Respond with JSON + +// Instantiate the client normally, but replace the message handler +var client = new RestClient(new RestClientOptions { ConfigureMessageHandler = _ => mockHttp }); + +var request = new RestRequest("http://localhost/api/user/1234"); +var response = await client.GetAsync(request); + +// No network connection required +Console.Write(response.Content); // {'name' : 'Test McGee'} +``` + +### Reference + +Below, you can find members of `IRestClient` and `IRestRequest` with their corresponding status and location in the new API. + +| `IRestClient` member | Where is it now? | +|:------------------------------------------------------------------------------------------------|:----------------------------------------| +| `CookieContainer` | `RestClientOptions`, `RestRequest` | +| `AutomaticDecompression` | `RestClientOptions`, changed type | +| `MaxRedirects` | `RestClientOptions` | +| `UserAgent` | `RestClientOptions` | +| `Timeout` | `RestClientOptions`, `RestRequest` | +| `Authenticator` | `RestClientOptions`, `RestRequest` | +| `BaseUrl` | `RestClientOptions` | +| `Encoding` | `RestClientOptions` | +| `ThrowOnDeserializationError` | `RestClientOptions` | +| `FailOnDeserializationError` | `RestClientOptions` | +| `ThrowOnAnyError` | `RestClientOptions` | +| `PreAuthenticate` | `RestClientOptions` | +| `BaseHost` | `RestClientOptions` | +| `AllowMultipleDefaultParametersWithSameName` | `RestClientOptions` | +| `ClientCertificates` | `RestClientOptions` | +| `Proxy` | `RestClientOptions` | +| `CachePolicy` | `RestClientOptions`, changed type | +| `FollowRedirects` | `RestClientOptions` | +| `RemoteCertificateValidationCallback` | `RestClientOptions` | +| `Pipelined` | Not supported | +| `UnsafeAuthenticatedConnectionSharing` | Not supported | +| `ConnectionGroupName` | Not supported | +| `ReadWriteTimeout` | Not supported | +| `UseSynchronizationContext` | Not supported | +| `DefaultParameters` | `RestClient` | +| `Deserialize(IRestResponse response)` | `RestSerializers` | +| `BuildUri(IRestRequest request)` | Extension | +| `ExecuteAsync(IRestRequest request, CancellationToken cancellationToken)` | `RestClient` | +| `ExecuteAsync(IRestRequest request, Method httpMethod, CancellationToken cancellationToken)` | Extension | +| `ExecuteAsync(IRestRequest request, Method httpMethod, CancellationToken cancellationToken)` | Extension | +| `ExecuteAsync(IRestRequest request, CancellationToken cancellationToken)` | Extension | +| `ExecuteGetAsync(IRestRequest request, CancellationToken cancellationToken)` | Extension | +| `ExecutePostAsync(IRestRequest request, CancellationToken cancellationToken)` | Extension | +| `ExecuteGetAsync(IRestRequest request, CancellationToken cancellationToken)` | Extension | +| `ExecutePostAsync(IRestRequest request, CancellationToken cancellationToken)` | Extension | +| `Execute(IRestRequest request)` | Extension (since v108) | +| `Execute(IRestRequest request, Method httpMethod)` | Extension (since v108) | +| `Execute(IRestRequest request)` | Extension (since v108) | +| `Execute(IRestRequest request, Method httpMethod)` | Extension (since v108) | +| `DownloadData(IRestRequest request)` | Extension (since v108) | +| `ExecuteAsGet(IRestRequest request, string httpMethod)` | Extension `ExecuteGetA` (since v108) | +| `ExecuteAsPost(IRestRequest request, string httpMethod)` | Extension `ExecutePost` (since v108) | +| `ExecuteAsGet(IRestRequest request, string httpMethod)` | Extension `ExecuteGet` (since v108) | +| `ExecuteAsPost(IRestRequest request, string httpMethod)` | Extension `ExecutePost` (since v108) | +| `BuildUriWithoutQueryParameters(IRestRequest request)` | Extension | +| `ConfigureWebRequest(Action configurator)` | Removed | +| `AddHandler(string contentType, Func deserializerFactory)` | Removed | +| `RemoveHandler(string contentType)` | Removed | +| `ClearHandlers()` | Removed | + +| `IRestRequest` member | Where is it now? | +|:-------------------------------------------------------------------------------------------------------|:---------------------------------| +| `AlwaysMultipartFormData` | `RestRequest` | +| `JsonSerializer` | Deprecated | +| `XmlSerializer` | Deprecated | +| `AdvancedResponseWriter` | `RestRequest`, changed signature | +| `ResponseWriter` | `RestRequest`, changed signature | +| `Parameters` | `RestRequest` | +| `Files` | `RestRequest` | +| `Method` | `RestRequest` | +| `Resource` | `RestRequest` | +| `RequestFormat` | `RestRequest` | +| `RootElement` | `RestRequest` | +| `DateFormat` | `XmlRequest` | +| `XmlNamespace` | `XmlRequest` | +| `Credentials` | Removed, use `RestClientOptions` | +| `Timeout` | `RestRequest` | +| `ReadWriteTimeout` | Not supported | +| `Attempts` | `RestRequest` | +| `UseDefaultCredentials` | Removed, use `RestClientOptions` | +| `AllowedDecompressionMethods` | Removed, use `RestClientOptions` | +| `OnBeforeDeserialization` | `RestRequest` | +| `OnBeforeRequest` | `RestRequest`, changed signature | +| `Body` | Removed, use `Parameters` | +| `AddParameter(Parameter p)` | `RestRequest` | +| `AddFile(string name, string path, string contentType)` | Extension | +| `AddFile(string name, byte[] bytes, string fileName, string contentType)` | Extension | +| `AddFile(string name, Action writer, string fileName, long contentLength, string contentType)` | Extension | +| `AddFileBytes(string name, byte[] bytes, string filename, string contentType)` | Extension `AddFile` | +| `AddBody(object obj, string xmlNamespace)` | Deprecated | +| `AddBody(object obj)` | Extension | +| `AddJsonBody(object obj)` | Extension | +| `AddJsonBody(object obj, string contentType)` | Extension | +| `AddXmlBody(object obj)` | Extension | +| `AddXmlBody(object obj, string xmlNamespace)` | Extension | +| `AddObject(object obj, params string[] includedProperties)` | Extension | +| `AddObject(object obj)` | Extension | +| `AddParameter(string name, object value)` | Extension | +| `AddParameter(string name, object value, ParameterType type)` | Extension | +| `AddParameter(string name, object value, string contentType, ParameterType type)` | Extension | +| `AddOrUpdateParameter(Parameter parameter)` | Extension | +| `AddOrUpdateParameters(IEnumerable parameters)` | Extension | +| `AddOrUpdateParameter(string name, object value)` | Extension | +| `AddOrUpdateParameter(string name, object value, ParameterType type)` | Extension | +| `AddOrUpdateParameter(string name, object value, string contentType, ParameterType type)` | Extension | +| `AddHeader(string name, string value)` | Extension | +| `AddOrUpdateHeader(string name, string value)` | Extension | +| `AddHeaders(ICollection> headers)` | Extension | +| `AddOrUpdateHeaders(ICollection> headers)` | Extension | +| `AddCookie(string name, string value)` | Extension | +| `AddUrlSegment(string name, string value)` | Extension | +| `AddUrlSegment(string name, string value, bool encode)` | Extension | +| `AddUrlSegment(string name, object value)` | Extension | +| `AddQueryParameter(string name, string value)` | Extension | +| `AddQueryParameter(string name, string value, bool encode)` | Extension | +| `AddDecompressionMethod(DecompressionMethods decompressionMethod)` | Not supported | +| `IncreaseNumAttempts()` | Made internal | diff --git a/docs/src/pages/support.md b/docs/src/pages/support.md new file mode 100644 index 000000000..922293894 --- /dev/null +++ b/docs/src/pages/support.md @@ -0,0 +1,129 @@ +--- +id: "support" +--- + +# Get help + +Got issues, questions, suggestions? Please read this page carefully to understand how you can get help working with RestSharp. + +:::tip +You can also support maintainers and motivate them by contributing via [GitHub Sponsors](https://github.com/sponsors/restsharp). +::: + +## Questions + +The most effective way to resolve questions about using RestSharp is StackOverflow. + +RestSharp has a large user base. Tens of thousands of projects and hundreds of thousands of developers +use RestSharp on a daily basis. So, asking questions on **StackOverflow** with [restsharp](https://stackoverflow.com/questions/tagged/restsharp) tag +would most definitely lead you to a solution. + +:::warning +Please do not use GitHub issues to ask question about using RestSharp. +::: + +## Discussions + +We have a [mail list](http://groups.google.com/group/restsharp) at Google Groups dedicated to discussions about +using RestSharp, feature proposals and similar topics. It is perfectly fine to +ask questions about using RestSharp at that group too. + +Please check the group and engage with the community if you feel a need +to discuss things that you struggle with or want to improve. + +## Bugs and issues + +The last resort to get help when you experience some unexpected behaviour, +a crash or anything else that you consider a bug, is submitting an issue +at our GitHub repository. + +:::warning +**Do not ignore our contribution guidelines**, otherwise you risk your issue to be +closed without being considered. Respect the maintainers, be specific and provide +as many details about the issue as you can. +::: + +Ensure you provide the following in the issue: + - Expected behaviour + - Actual behaviour + - Why do you think it is an issue, not a misunderstanding + - How the issue can be reproduced: a repository or at least a code snippet + - If RestSharp unexpectedly throws an exception, provide the stack trace + +## Contributing + +Although issues are considered as contributions, we strongly suggest helping +the community by solving issues that you experienced by submitting a pull request. + +Here are contribution guidelines: + + - Make each pull request atomic and exclusive; don't send pull requests for a laundry list of changes. + - Even better, commit in small manageable chunks. + - Use the supplied `.editorconfig` file to format the code. + - Any change must be accompanied by a unit test covering the change. + - New tests are preferred to use FluentAssertions. + - No regions. + - No licence header for tested. + - Code must build for .NET Standard 2.0, .NET 5, and .NET 6. + - Test must run on .NET 6. + - Use `autocrlf=true` (`git config --global core.autocrlf true`) + + +## Common issues + +Before opening an issue on GitHub, please check the list of known issues below. + +### Content type + +One of the mistakes developers make when using RestSharp is setting the `Content-Type` header manually. +Remember that in most of the usual scenarios setting the content type header manually is not required, and it might be harmful. + +RestSharp sets the content type header automatically based on the request type. +You might want to override the request body content type, but the best way to do it is to supply the content type to the body parameter itself. +Functions for adding the request body to the request have overloads, which accept content type. For example + +```csharp +request.AddStringBody(jsonString, ContentType.Json); +``` + +### Setting the User Agent + +Setting the user agent on the request won't work when you use `AddHeader`. + +Instead, please use the `RestClientOptions.UserAgent` property. + +### Empty response + +We regularly get issues where developers complain that their requests get executed +and they get a proper raw response, but the `RestResponse` instance doesn't +have a deserialized object set. + +In other situations, the raw response is also empty. + +All those issues are caused by the design choice to swallow exceptions +that occur when RestSharp makes the request and processes the response. Instead, +RestSharp produces so-called _error response_. + +You can check the response status to find out if there are any errors. +The following properties can tell you about those errors: + +- `IsSuccessful` +- `ResponseStatus` +- `StatusCode` +- `ErrorMessage` +- `ErrorException` + +It could be that the request was executed and you got `200 OK` status +code back and some content, but the typed `Data` property is empty. + +In that case, you probably got deserialization issues. By default, RestSharp will just return an empty (`null`) result in the `Data` property. +Deserialization errors can be also populated to the error response. To do that, +set the `client.FailOnDeserializationError` property to `true`. + +It is also possible to force RestSharp to throw an exception. + +If you set `client.ThrowOnDeserializationError`, RestSharp will throw a `DeserializationException` +when the serializer throws. The exception has the internal exception and the response. + +Finally, by setting `ThrowOnAnyError` you can force RestSharp to re-throw any +exception that happens when making the request and processing the response. diff --git a/docs/static/.nojekyll b/docs/static/.nojekyll new file mode 100644 index 000000000..e69de29bb diff --git a/docs/static/img/android-chrome-192x192.png b/docs/static/img/android-chrome-192x192.png new file mode 100644 index 000000000..9a2cc6bb1 Binary files /dev/null and b/docs/static/img/android-chrome-192x192.png differ diff --git a/docs/static/img/android-chrome-512x512.png b/docs/static/img/android-chrome-512x512.png new file mode 100644 index 000000000..eaf07aa31 Binary files /dev/null and b/docs/static/img/android-chrome-512x512.png differ diff --git a/docs/static/img/apple-touch-icon.png b/docs/static/img/apple-touch-icon.png new file mode 100644 index 000000000..55567fb41 Binary files /dev/null and b/docs/static/img/apple-touch-icon.png differ diff --git a/docs/static/img/aws_logo.png b/docs/static/img/aws_logo.png new file mode 100644 index 000000000..68304e083 Binary files /dev/null and b/docs/static/img/aws_logo.png differ diff --git a/docs/static/img/favicon-16x16.png b/docs/static/img/favicon-16x16.png new file mode 100644 index 000000000..65435396c Binary files /dev/null and b/docs/static/img/favicon-16x16.png differ diff --git a/docs/static/img/favicon-32x32.png b/docs/static/img/favicon-32x32.png new file mode 100644 index 000000000..e938113bf Binary files /dev/null and b/docs/static/img/favicon-32x32.png differ diff --git a/docs/static/img/favicon.ico b/docs/static/img/favicon.ico new file mode 100644 index 000000000..d501014d2 Binary files /dev/null and b/docs/static/img/favicon.ico differ diff --git a/docs/static/img/restsharp.png b/docs/static/img/restsharp.png new file mode 100644 index 000000000..7203b38fd Binary files /dev/null and b/docs/static/img/restsharp.png differ diff --git a/docs/static/img/site.webmanifest b/docs/static/img/site.webmanifest new file mode 100644 index 000000000..45dc8a206 --- /dev/null +++ b/docs/static/img/site.webmanifest @@ -0,0 +1 @@ +{"name":"","short_name":"","icons":[{"src":"/android-chrome-192x192.png","sizes":"192x192","type":"image/png"},{"src":"/android-chrome-512x512.png","sizes":"512x512","type":"image/png"}],"theme_color":"#ffffff","background_color":"#ffffff","display":"standalone"} \ No newline at end of file diff --git a/docs/tsconfig.json b/docs/tsconfig.json new file mode 100644 index 000000000..314eab8a4 --- /dev/null +++ b/docs/tsconfig.json @@ -0,0 +1,7 @@ +{ + // This file is not used in compilation. It is here just for a nice editor experience. + "extends": "@docusaurus/tsconfig", + "compilerOptions": { + "baseUrl": "." + } +} diff --git a/docs/versioned_docs/version-v110/advanced/_category_.json b/docs/versioned_docs/version-v110/advanced/_category_.json new file mode 100644 index 000000000..f395bdfe4 --- /dev/null +++ b/docs/versioned_docs/version-v110/advanced/_category_.json @@ -0,0 +1,7 @@ +{ + "label": "Advanced topics", + "position": 4, + "link": { + "type": "generated-index" + } +} diff --git a/docs/versioned_docs/version-v110/advanced/authenticators.md b/docs/versioned_docs/version-v110/advanced/authenticators.md new file mode 100644 index 000000000..14196d97c --- /dev/null +++ b/docs/versioned_docs/version-v110/advanced/authenticators.md @@ -0,0 +1,185 @@ +# Authenticators + +RestSharp includes authenticators for basic HTTP, OAuth1 and token-based (JWT and OAuth2). + +There are two ways to set the authenticator: client-wide or per-request. + +Set the client-wide authenticator by assigning the `Authenticator` property of `RestClientOptions`: + +```csharp +var options = new RestClientOptions("https://example.com") { + Authenticator = new HttpBasicAuthenticator("username", "password") +}; +var client = new RestClient(options); +``` + +To set the authenticator per-request, assign the `Authenticator` property of `RestRequest`: + +```csharp +var request = new RestRequest("/api/users/me") { + Authenticator = new HttpBasicAuthenticator("username", "password") +}; +var response = await client.ExecuteAsync(request, cancellationToken); +``` + +## Basic authentication + +The `HttpBasicAuthenticator` allows you pass a username and password as a basic `Authorization` header using a base64 encoded string. + +```csharp +var options = new RestClientOptions("https://example.com") { + Authenticator = new HttpBasicAuthenticator("username", "password") +}; +var client = new RestClient(options); +``` + +## OAuth1 + +For OAuth1 authentication the `OAuth1Authenticator` class provides static methods to help generate an OAuth authenticator. +OAuth1 authenticator will add the necessary OAuth parameters to the request, including signature. + +The authenticator will use `HMAC SHA1` to create a signature by default. +Each static function to create the authenticator allows you to override the default and use another method to generate the signature. + +### Request token + +Getting a temporary request token is the usual first step in the 3-legged OAuth1 flow. +Use `OAuth1Authenticator.ForRequestToken` function to get the request token authenticator. +This method requires a `consumerKey` and `consumerSecret` to authenticate. + +```csharp +var options = new RestClientOptions("https://api.twitter.com") { + Authenticator = OAuth1Authenticator.ForRequestToken(consumerKey, consumerSecret) +}; +var client = new RestClient(options); +var request = new RestRequest("oauth/request_token"); +``` + +The response should contain the token and the token secret, which can then be used to complete the authorization process. +If you need to provide the callback URL, assign the `CallbackUrl` property of the authenticator to the callback destination. + +### Access token + +Getting an access token is the usual third step in the 3-legged OAuth1 flow. +This method retrieves an access token when provided `consumerKey`, `consumerSecret`, `oauthToken`, and `oauthTokenSecret`. +If you don't have a token for this call, you need to make a call to get the request token as described above. + +```csharp +var authenticator = OAuth1Authenticator.ForAccessToken( + consumerKey, consumerSecret, oauthToken, oauthTokenSecret +); +var options = new RestClientOptions("https://api.twitter.com") { + Authenticator = authenticator +}; +var client = new RestClient(options); +var request = new RestRequest("oauth/access_token"); +``` + +If the second step in 3-leg OAuth1 flow returned a verifier value, you can use another overload of `ForAccessToken`: + +```csharp +var authenticator = OAuth1Authenticator.ForAccessToken( + consumerKey, consumerSecret, oauthToken, oauthTokenSecret, verifier +); +``` + +The response should contain the access token that can be used to make calls to protected resources. + +For refreshing access tokens, use one of the two overloads of `ForAccessToken` that accept `sessionHandle`. + +### Protected resource + +When the access token is available, use `ForProtectedResource` function to get the authenticator for accessing protected resources. + +```csharp +var authenticator = OAuth1Authenticator.ForAccessToken( + consumerKey, consumerSecret, accessToken, accessTokenSecret +); +var options = new RestClientOptions("https://api.twitter.com/1.1") { + Authenticator = authenticator +}; +var client = new RestClient(options); +var request = new RestRequest("statuses/update.json", Method.Post) + .AddParameter("status", "Hello Ladies + Gentlemen, a signed OAuth request!") + .AddParameter("include_entities", "true"); +``` + +### xAuth + +xAuth is a simplified version of OAuth1. It allows sending the username and password as `x_auth_username` and `x_auth_password` request parameters and directly get the access token. xAuth is not widely supported, but RestSharp still allows using it. + +Create an xAuth authenticator using `OAuth1Authenticator.ForClientAuthentication` function: + +```csharp +var authenticator = OAuth1Authenticator.ForClientAuthentication( + consumerKey, consumerSecret, username, password +); +``` + +### 0-legged OAuth + +The access token authenticator can be used in 0-legged OAuth scenarios by providing `null` for the `consumerSecret`. + +```csharp +var authenticator = OAuth1Authenticator.ForAccessToken( + consumerKey, null, oauthToken, oauthTokenSecret +); +``` + +## OAuth2 + +RestSharp has two very simple authenticators to send the access token as part of the request. + +`OAuth2UriQueryParameterAuthenticator` accepts the access token as the only constructor argument, and it will send the provided token as a query parameter `oauth_token`. + +`OAuth2AuthorizationRequestHeaderAuthenticator` has two constructors. One only accepts a single argument, which is the access token. The other constructor also allows you to specify the token type. The authenticator will then add an `Authorization` header using the specified token type or `OAuth` as the default token type, and the token itself. + +For example: + +```csharp +var authenticator = new OAuth2AuthorizationRequestHeaderAuthenticator( + token, "Bearer" +); +var options = new RestClientOptions("https://example.com") { + Authenticator = authenticator +}; +var client = new RestClient(options); +``` + +The code above will tell RestSharp to send the bearer token with each request as a header. Essentially, the code above does the same as the sample for `JwtAuthenticator` below. + +As those authenticators don't do much to get the token itself, you might be interested in looking at our [sample OAuth2 authenticator](../usage/example.md#authenticator), which requests the token on its own. + +## JWT + +The JWT authentication can be supported by using `JwtAuthenticator`. It is a very simple class that can be constructed like this: + +```csharp +var authenticator = new JwtAuthenticator(myToken); +var options = new RestClientOptions("https://example.com") { + Authenticator = authenticator +}; +var client = new RestClient(options); +``` + +For each request, it will add an `Authorization` header with the value `Bearer `. + +As you might need to refresh the token from, you can use the `SetBearerToken` method to update the token. + +## Custom authenticator + +You can write your own implementation by implementing `IAuthenticator` and +registering it with your RestClient: + +```csharp +var authenticator = new SuperAuthenticator(); // implements IAuthenticator +var options = new RestClientOptions("https://example.com") { + Authenticator = authenticator +}; +var client = new RestClient(options); +``` + +The `Authenticate` method is the very first thing called upon calling `RestClient.Execute` or `RestClient.Execute`. +It gets the `RestRequest` currently being executed giving you access to every part of the request data (headers, parameters, etc.) + +You can find an example of a custom authenticator that fetches and uses an OAuth2 bearer token [here](../usage/example.md#authenticator). diff --git a/docs/versioned_docs/version-v110/advanced/configuration.md b/docs/versioned_docs/version-v110/advanced/configuration.md new file mode 100644 index 000000000..95d506fc8 --- /dev/null +++ b/docs/versioned_docs/version-v110/advanced/configuration.md @@ -0,0 +1,230 @@ +--- +title: Configuration +description: Learn how to configure RestClient for non-trivial use cases. +sidebar_position: 1 +--- + +# Configuring RestClient + +This page describes how to create and configure `RestClient`. + +## Basic configuration + +The primary `RestClient` constructor accepts an instance of `RestClientOptions`. Most of the time, default option values don't need to be changed. However, in some cases, you'd want to configure the client differently, so you'd need to change some of the options in your code. The constructor also contains a few optional parameters for additional configuration that is not covered by client options. Here's the constructor signature: + +```csharp +public RestClient( + RestClientOptions options, + ConfigureHeaders? configureDefaultHeaders = null, + ConfigureSerialization? configureSerialization = null, + bool useClientFactory = false +) +``` + +Constructor parameters are: + +| Name | Description | Mandatory | +|-------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------| +| options | Client options | Yes | +| configureDefaultHeaders | Function to configure headers. Allows to configure default headers for `HttpClient`. Most of the time you'd prefer using `client.AddDefaultHeader` instead. | No | +| configureSerialization | Function to configure client serializers with non-default options or to use a different serializer ([learn more](serialization.md)) | No | +| useClientFactory | Instructs the client to use `SimpleFactory` ([learn more](../usage/usage.md#simple-factory)) to get an `HttpClient` instance | No | + +Here's an example of how to create a client using client options: + +```csharp +var options = new RestClientOptions("https://localhost:5000/api") { + DisableCharset = true +}; +var client = new RestClient(options); +``` + +When you only need to set the base URL, you can use a simplified constructor: + +```csharp +var client = new RestClient("https://localhost:5000/api"); +``` + +The simplified constructor will create an instance of client options and set the base URL provided as the constructor argument. + +Finally, you can override properties of default options using a configuration function. Here's the constructor signature that supports this method: + +```csharp +public RestClient( + ConfigureRestClient? configureRestClient = null, + ConfigureHeaders? configureDefaultHeaders = null, + ConfigureSerialization? configureSerialization = null, + bool useClientFactory = false +) +``` + +For example: + +```csharp +var client = new RestClient(options => { + options.BaseUrl = new Url("https://localhost:5000/api"), + options.DisableCharset = true +}); +``` + +You can also provide the base URL as a constructor argument like this: + +```csharp +var client = new RestClient("https://localhost:5000/api", options => { + options.DisableCharset = true +}); +``` + +## Using custom HttpClient + +By default, RestSharp creates an instance of `HttpClient` configured using the client options, and keeps it during the lifetime of the client. When the `RestClient` instance gets disposed, it also disposes the `HttpClient` instance. + +There might be a case when you need to provide your own `HttpClient`. For example, you would want to use `HttpClient` created by HTTP client factory. RestSharp allows you to do it by using additional constructors. These constructors are: + +```csharp +// Create a client using an existing HttpClient and RestClientOptions (optional) +public RestClient( + HttpClient httpClient, + RestClientOptions? options, + bool disposeHttpClient = false, + ConfigureSerialization? configureSerialization = null +) + +// Create a client using an existing HttpClient and optional RestClient configuration function +public RestClient( + HttpClient httpClient, + bool disposeHttpClient = false, + ConfigureRestClient? configureRestClient = null, + ConfigureSerialization? configureSerialization = null +) +``` + +The `disposeHttpClient` argument tells the client to dispose `HttpClient` when the client itself gets disposed. It's set to `false` by default as when the `HttpClient` is provided from the outside, it should normally be disposed on the outside as well. + +## Using custom message handler + +Unless you use an external instance of `HttpClient`, the `RestClient` creates one when being constructed, and it will use the default HTTP message handler, configured using `RestClientOptions`. Normally, you'd get a `SocketHttpHandler` with modern .NET, and `WinHttpHandler` with .NET Framework. + +There might be a case when you need to configure the HTTP message handler. For example, you want to add a delegating message handler. RestSharp allows you to do it by using additional constructors. There's one constructor that allows you to pass the custom `HttpMessageHandler`: + +```csharp +public RestClient( + HttpMessageHandler handler, + bool disposeHandler = true, + ConfigureRestClient? configureRestClient = null, + ConfigureSerialization? configureSerialization = null +) +``` + +This constructor will create a new `HttpClient` instance using the provided message handler. As RestSharp will dispose the `HttpClient` instance when the `RestClient` instance gets disposed, the handler will be disposed as well. If you want to change that and keep the handler, set the `disposeHandler` parameter to `false`. + +:::note +When using a custom message handler, RestSharp **will not** configure it with client options, which are normally used to configure the handler created by RestSharp. +::: + +Another way to customize the message handler is to allow RestSharp to create a handler, but then configure it, or wrap it in a delegating handler. It can be done by using the `RestClientOptions.ConfigureMessageHandler` property. It can be set to a function that receives the handler created by RestSharp and returned either the same handler with different settings, or a new handler. + +For example, if you want to use `MockHttp` and its handler for testing, you can do it like this: + +```csharp +var mockHttp = new MockHttpMessageHandler(); +// Configure the MockHttp handler to do the checks +... + +var options = new RestClientOptions(Url) { + ConfigureMessageHandler = _ => mockHttp +}; +using var client = new RestClient(options); +``` + +In this example, we are reassigning the handler to MockHttp, so the handler created by RestSharp isn't used. In other cases you want to use delegating handlers as middleware, so you'd pass the handler created by RestSharp to the delegating handler: + +```csharp +var options = new RestClientOptions(Url) { + ConfigureMessageHandler = handler => new MyDelegatingHandler(handler) +}; +using var client = new RestClient(options); +``` + +## Client options + +RestSharp allows configuring `RestClient` using client options, as mentioned at the beginning of this page. Below, you find more details about available options. + +| Option | Description | +|----------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| `BaseUrl` | Client base URL. It can also be provided as the `RestClientOptions` constructor argument. | +| `ConfigureMessageHandler` | Configures the HTTP message handler (see above). | +| `CalculateResponseStatus` | Function to calculate a different response status from `HttpResponseMessage`. By default, the request is considered as complete if it returns a successful status code or 404. | +| `Authenticator` | Client-level authenticator. Read more about authenticators [here](authenticators.md). | +| `Interceptors` | A collector of interceptors. Read more about interceptors [here](interceptors.md). | +| `Credentials` | Instance of `ICredentials` used for NTLM or Kerberos authentication. Not supported in browsers. | +| `UseDefaultCredentials` | Whether to use default OS credentials for NTLM or Kerberos authentication. Not supported in browsers. | +| `DisableCharset` | When set to `true`, the `Content-Type` header won't have the `charset` portion. Some older web servers don't understand the `charset` portion in the header and fail to process the request. | +| `AutomaticDecompression` | Allows customizing supported decompression methods. Default is `All` except for .NET Framework that only support `GZip`. Not supported in browsers. | +| `MaxRedirects` | The number of redirects to follow. Not supported in browsers. | +| `ClientCertificates` | A collection of X.509 client certificates to be used for authentication. Not supported in browsers. | +| `Proxy` | Can be used if the client needs to use an explicit, non-default proxy. Not supported in browsers, on iOS and tvOS. | +| `CachePolicy` | Shortcut for setting the default value for `Cache-Control` header. | +| `FollowRedirects` | Instructs the client to follow redirects. Default is `true`. | +| `Expect100Continue` | Gets or sets a value that indicates if the `Expect` header for an HTTP request contains `Continue`. | +| `UserAgent` | Allows overriding the default value for `User-Agent` header, which is `RestSharp/{version}`. | +| `PreAuthenticate` | Gets or sets a value that indicates whether the client sends an `Authorization` header with the request. Not supported in browsers. | +| `RemoteCertificateValidationCallback` | Custom function to validate the server certificate. Normally, it's used when the server uses a certificate that isn't trusted by default. | +| `BaseHost` | Value for the `Host` header sent with each request. | +| `CookieContainer` | Custom cookie container that will be shared among all calls made by the client. Normally not required as RestSharp handles cookies without using a client-level cookie container. | +| `MaxTimeout` | Client-level timeout in milliseconds. If the request timeout is also set, this value isn't used. | +| `Encoding` | Default request encoding. Override it only if you don't use UTF-8. | +| `ThrowOnDeserializationError` | Forces the client to throw if it fails to deserialize the response. Remember that not all deserialization issues forces the serializer to throw. Default is `false`, so the client will return a `RestResponse` with deserialization exception details. Only relevant for `Execute...` functions. | +| `FailOnDeserializationError` | When set to `true`, if the client fails to deserialize the response, the response object will have status `Failed`, although the HTTP calls might have been successful. Default is `true`. | +| `ThrowOnAnyError` | When set to `true`, the client will re-throw any exception from `HttpClient`. Default is `false`. Only applies for `Execute...` functions. | +| `AllowMultipleDefaultParametersWithSameName` | By default, adding parameters with the same name is not allowed. You can override this behaviour by setting this property to `true`. | +| `Encode` | A function to encode URLs, the default is a custom RestSharp function based on `Uri.EscapeDataString()`. Set it if you need a different way to do the encoding. | +| `EncodeQuery` | A function to encode URL query parameters. The default is the same function as for `Encode` property. | + +Some of the options are used by RestSharp code, but some are only used to configure the `HttpMessageHandler`. These options are: +- `Credentials` +- `UseDefaultCredentials` +- `AutomaticDecompression` +- `PreAuthenticate` +- `MaxRedirects` +- `RemoteCertificateValidationCallback` +- `ClientCertificates` +- `FollowRedirects` +- `Proxy` + +:::note +If setting these options to non-default values produce no desirable effect, check if your framework and platform supports them. RestSharp doesn't change behaviour based on values of those options. +::: + +The `IRestClient` interface exposes the `Options` property, so any option can be inspected at runtime. However, RestSharp converts the options object provided to the client constructor to an immutable object. Therefore, no client option can be changed after the client is instantiated. It's because changing client options at runtime can produce issues in concurrent environments, effectively rendering the client as not thread-safe. Apart from that, changing the options that are used to create the message handler would require re-creating the handler, and also `HttpClient`, which should not be done at runtime. + +## Configuring requests + +Client options apply to all requests made by the client. Sometimes, you want to fine-tune particular requests, so they execute with custom configuration. It's possible to do using properties of `RestRequest`, described below. + +| Name | Description | +|------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| `AlwaysMultipartFormData` | When set to `true`, the request will be sent as a multipart form, even though it's not required. By default, RestSharp only sends requests with multiple attachments as multipart forms. Default is `false`. | +| `AlwaysSingleFileAsContent` | When set to true, the request with file attachment will not be sent as a multipart form, but as plain content. Default is `false`. It cannot be set to `true` when `AlwaysMultipartFormData` is set to `true`, or when the request has `POST` parameters. | +| `MultipartFormQuoteBoundary` | Default is `true`, which means that the form boundary string will be wrapped in quotes. If the server has an issue with that, setting this to `false` will remove quotes around the boundary. | +| `FormBoundary` | Allows specifying a custom multipart form boundary instead of using the default random string. | +| `RequestParameters` | Collection of request parameters. Normally, you won't need to use it as parameters are added to the request using `Add...` functions. | +| `CookieContainer` | Custom request-level cookie container. Default is `null`. You can still set request cookies using `AddCookie` and get response cookies from the response object without using cooking container. | +| `Authenticator` | Overrides the client-level authenticator. | +| `Files` | Collection of file parameters, read-only. Use `AddFile` for adding files to the request. | +| `Method` | Request HTTP method, default is `GET`. Only needed when using `Execute` or `ExecuteAsync` as other functions like `ExecutePostAsync` will override the request method. | +| `TImeout` | Overrides the client-level timeout. | +| `Resource` | Resource part of the remote endpoint URL. For example, when using the client-level base URL `https://localhost:5000/api` and `Resource` set to `weather`, the request will be sent to `https://localhost:5000/api/weather`. It can container resource placeholders to be used in combination with `AddUrlSegment` | +| `RequestFormat` | Identifies the request as JSON, XML, binary, or none. Rarely used because the client will set the request format based on the body type if functions like `AddJsonBody` or `AddXmlBody` are used. | +| `RootElement` | Used by the default deserializers to determine where to start deserializing from. Only supported for XML responses. Does not apply to requests. | +| `OnBeforeDeserialization` | **Obsolete** A function to be called before the response is deserializer. Allows changing the content before calling the deserializer. Use [interceptors](interceptors.md) instead. | +| `OnBeforeRequest` | **Obsolete** A function to be called right before the request is executed by `HttpClient`. It receives an instance of `HttpRequestMessage`. Use [interceptors](interceptors.md) instead. | +| `OnAfterRequest` | **Obsolete** A function to be called right after the request is executed by `HttpClient`. It receives an instance of `HttpResponseMessage`. Use [interceptors](interceptors.md) instead. | +| `Attempts` | When the request is being resent to retry, the property value increases by one. | +| `CompletionOption` | Instructs the client on when it should consider the request to be completed. The default is `ResponseContentRead`. It is automatically changed to `ResponseHeadersRead` when using async download functions or streaming. | +| `CachePolicy` | Overrides the client cache policy. | +| `ResponseWriter` | Allows custom handling of the response stream. The function gets the raw response stream and returns another stream or `null`. Cannot be used in combination with `AdvancedResponseWriter`. | +| `AdvancedResponseWriter` | Allows custom handling of the response. The function gets an instance of `HttpResponseMessage` and an instance of `RestRequest`. It must return an instance of `RestResponse`, so it effectively overrides RestSharp default functionality for creating responses. | +| `Interceptors` | Allows adding interceptors to the request. Both client-level and request-level interceptors will be called. | + +The table below contains all configuration properties of `RestRequest`. To learn more about adding request parameters, check the [usage page](../usage/usage.md#create-a-request) section about creating requests with parameters. diff --git a/docs/versioned_docs/version-v110/advanced/error-handling.md b/docs/versioned_docs/version-v110/advanced/error-handling.md new file mode 100644 index 000000000..7b3be11fc --- /dev/null +++ b/docs/versioned_docs/version-v110/advanced/error-handling.md @@ -0,0 +1,67 @@ +# Error handling + +If there is a network transport error (network is down, failed DNS lookup, etc), or any kind of server error (except 404), `RestResponse.ResponseStatus` will be set to `ResponseStatus.Error`, otherwise it will be `ResponseStatus.Completed`. + +If an API returns a 404, `ResponseStatus` will still be `Completed`. If you need access to the HTTP status code returned you will find it at `RestResponse.StatusCode`. +The `Status` property is an indicator of completion independent of the API error handling. + +Normally, RestSharp doesn't throw an exception if the request fails. + +However, it is possible to configure RestSharp to throw in different situations, when it normally doesn't throw +in favour of giving you the error as a property. + +| Property | Behavior | +|-------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| `FailOnDeserializationError` | Changes the default behavior when failed deserialization results in a successful response with an empty `Data` property of the response. Setting this property to `true` will tell RestSharp to consider failed deserialization as an error and set the `ResponseStatus` to `Error` accordingly. | +| `ThrowOnDeserializationError` | Changes the default behavior when failed deserialization results in empty `Data` property of the response. Setting this property to `true` will tell RestSharp to throw when deserialization fails. | +| `ThrowOnAnyError` | Setting this property to `true` changes the default behavior and forces RestSharp to throw if any errors occurs when making a request or during deserialization. | + +Those properties are available for the `RestClientOptions` and will be used for all request made with the client instance. + +For example, you can configure the client to throw an exception if any error occurs when making a request, or when a request returns a non-successful HTTP status code: + +```csharp +var options = new RestClientOptions(url) { + ThrowOnAnyError = true +}; +var client = new RestClient(options); +var request = new RestRequest("resource/{id}").AddUrlSegment("id", 123); +// 👇 will throw if the request fails +var response = await client.ExecuteGetAsync(request); +``` + +:::warning +Please be aware that deserialization failures will only work if the serializer throws an exception when deserializing the response. +Many serializers don't throw by default, and just return a `null` result. RestSharp is unable to figure out why `null` is returned, so it won't fail in this case. +Check the serializer documentation to find out if it can be configured to throw on deserialization error. +::: + +There are also slight differences on how different overloads handle exceptions. + +Asynchronous generic methods `GetAsync`, `PostAsync` and so on, which aren't a part of `RestClient` interface (those methods are extension methods) return `Task`. It means that there's no `RestResponse` to set the response status to error. We decided to throw an exception when such a request fails. It is a trade-off between the API consistency and usability of the library. Usually, you only need the content of `RestResponse` instance to diagnose issues and most of the time the exception would tell you what's wrong. + +Below, you can find how different extensions deal with errors. Note that functions, which don't throw by default, will throw exceptions when `ThrowOnAnyError` is set to `true`. + +| Function | Throws on errors | +|:----------------------|:-----------------| +| `ExecuteAsync` | No | +| `ExecuteGetAsync` | No | +| `ExecuteGetAsync` | No | +| `ExecutePostAsync` | No | +| `ExecutePostAsync` | No | +| `ExecutePutAsync` | No | +| `ExecutePutAsync` | No | +| `GetAsync` | Yes | +| `GetAsync` | Yes | +| `PostAsync` | Yes | +| `PostAsync` | Yes | +| `PatchAsync` | Yes | +| `PatchAsync` | Yes | +| `DeleteAsync` | Yes | +| `DeleteAsync` | Yes | +| `OptionsAsync` | Yes | +| `OptionsAsync` | Yes | +| `HeadAsync` | Yes | +| `HeadAsync` | Yes | + +In addition, all the functions for JSON requests, like `GetJsonAsync` and `PostJsonAsync` throw an exception if the HTTP call fails. diff --git a/docs/versioned_docs/version-v110/advanced/interceptors.md b/docs/versioned_docs/version-v110/advanced/interceptors.md new file mode 100644 index 000000000..a3bf7a9bc --- /dev/null +++ b/docs/versioned_docs/version-v110/advanced/interceptors.md @@ -0,0 +1,84 @@ +--- +title: Interceptors +--- + +## Intercepting requests and responses + +Interceptors are a powerful feature of RestSharp that allows you to modify requests and responses before they are sent or received. You can use interceptors to add headers, modify the request body, or even cancel the request. You can also use interceptors to modify the response before it is returned to the caller. + +### Implementing an interceptor + +To implement an interceptor, you need to create a class that inherits the `Interceptor` base class. The base class implements all interceptor methods as virtual, so you can override them in your derived class. + +Methods that you can override are: +- `BeforeRequest(RestRequest request, CancellationToken cancellationToken)` +- `AfterRequest(RestResponse response, CancellationToken cancellationToken)` +- `BeforeHttpRequest(HttpRequestMessage requestMessage, CancellationToken cancellationToken)` +- `AfterHttpRequest(HttpResponseMessage responseMessage, CancellationToken cancellationToken)` +- `BeforeDeserialization(RestResponse response, CancellationToken cancellationToken)` + +All those functions must return a `ValueTask` instance. + +Here's an example of an interceptor that adds a header to a request: + +```csharp +// This interceptor adds a header to the request +// You'd not normally use this interceptor, as RestSharp already has a method +// to add headers to the request +class HeaderInterceptor(string headerName, string headerValue) : Interceptors.Interceptor { + public override ValueTask BeforeHttpRequest(HttpRequestMessage requestMessage, CancellationToken cancellationToken) { + requestMessage.Headers.Add(headerName, headerValue); + return ValueTask.CompletedTask; + } +} +``` + +Because interceptor functions return `ValueTask`, you can use `async` and `await` inside them. + +### Using an interceptor + +It's possible to add as many interceptors as you want, both to the client and to the request. The interceptors are executed in the order they were added. + +Adding interceptors to the client is done via the client options: + +```csharp +var options = new RestClientOptions("https://api.example.com") { + Interceptors = [new HeaderInterceptor("Authorization", token)] +}; +var client = new RestClient(options); +``` + +When you add an interceptor to the client, it will be executed for every request made by that client. + +You can also add an interceptor to a specific request: + +```csharp +var request = new RestRequest("resource") { + Interceptors = [new HeaderInterceptor("Authorization", token)] +}; +``` + +In this case, the interceptor will only be executed for that specific request. + +### Deprecation notice + +Interceptors aim to replace the existing request hooks available in RestSharp prior to version 111.0. Those hooks are marked with `Obsolete` attribute and will be removed in the future. If you are using those hooks, we recommend migrating to interceptors as soon as possible. + +To make the migration easier, RestSharp provides a class called `CompatibilityInterceptor`. It has properties for the hooks available in RestSharp 110.0 and earlier. You can use it to migrate your code to interceptors without changing the existing logic. + +For example, a code that uses `OnBeforeRequest` hook: + +```csharp +var request = new RestRequest("success"); +request.OnBeforeDeserialization += _ => throw new Exception(exceptionMessage); +``` + +Can be migrated to interceptors like this: + +```csharp +var request = new RestRequest("success") { + Interceptors = [new CompatibilityInterceptor { + OnBeforeDeserialization = _ => throw new Exception(exceptionMessage) + }] +}; +``` \ No newline at end of file diff --git a/docs/versioned_docs/version-v110/advanced/serialization.md b/docs/versioned_docs/version-v110/advanced/serialization.md new file mode 100644 index 000000000..b7092519a --- /dev/null +++ b/docs/versioned_docs/version-v110/advanced/serialization.md @@ -0,0 +1,148 @@ +# Serialization + +One of the most common reasons to choose RestSharp over plain `HttpClient` is its rich build-in serialization support. RestSharp allows adding complex objects as request body to be serialized when making a call to an API endpoint, and deserializing the response to a given .NET type. RestSharp supports JSON and XML serialization and deserialization by default. In addition, you can use a CSV serializer or write your own. + +In contrast to `System.Net.Http.Json` package that contains `HttpClient` extensions to make `GET` or `POST` calls using JSON, RestSharp support JSON responses for all HTTP methods, not just for `GET`. + +## Configuration + +:::tip +The default behavior of RestSharp is to swallow deserialization errors and return `null` in the `Data` +property of the response. Read more about it in the [Error Handling](error-handling.md). +::: + +You can tell RestSharp to use a custom serializer by using the `configureSerialization` constructor parameter: + +```csharp +var client = new RestClient( + options, + configureSerialization: s => s.UseSerializer(() => new CustomSerializer()); +); +``` + +All RestSharp serializers implement the `IRestSerializer` interface. Among other things, the interface requires implementing the `AcceptedContentTypes` property, which must return a collection of content types supported by the serializer. Being configured to use certain serializers, RestSharp populates the `Accept` header accordingly, so it doesn't need to be set manually. + +When making a call, RestSharp sets the request content type according to the request body type. For example, when you use `AddJsonBody`, the content type is set to `application/json`. Normally, you won't need to set the `Content-Type` header manually. If you need to set a custom content type for a JSON call, you can use the optional `contentType` argument of `AddJsonBody`, for example: + +```csharp +request.AddJsonBody(data, "text/json"); +``` + +## JSON + +The default JSON serializer uses `System.Text.Json`, which is a part of .NET since .NET 6. For earlier versions, it is added as a dependency. There are also a few serializers provided as additional packages. + +By default, RestSharp will use `JsonSerializerDefaults.Web` configuration. If necessary, you can specify your own options: + +```csharp +var client = new RestClient( + options, + configureSerialization: s => s.UseSystemTextJson(new JsonSerializerOptions {...}) +); +``` + +## XML + +The default XML serializer is `DotNetXmlSerializer`, which uses `System.Xml.Serialization` library from .NET. + +In previous versions of RestSharp, the default XML serializer was a custom RestSharp XML serializer. To make the code library size smaller, that serializer is now available as a separate package [`RestSharp.Serializers.Xml`](https://www.nuget.org/packages/RestSharp.Serializers.Xml). +You can add it back if necessary by installing the package and adding it to the client: + +```csharp +var client = new RestClient( + options, + configureSerialization: s => s.UseXmlSerializer() +); +``` + +As before, you can supply three optional arguments for a custom namespace, custom root element, and if you want to use `SerializeAs` and `DeserializeAs` attributed. + +## NewtonsoftJson (aka Json.Net) + +The `NewtonsoftJson` package is the most popular JSON serializer for .NET. It handles all possible scenarios and is very configurable. Such a flexibility comes with the cost of performance. If you need speed, keep the default JSON serializer. + +RestSharp support Json.Net serializer via a separate package [`RestSharp.Serializers.NewtonsoftJson`](https://www.nuget.org/packages/RestSharp.Serializers.NewtonsoftJson). + +:::warning +Please note that `RestSharp.Newtonsoft.Json` package is not provided by RestSharp, is marked as obsolete on NuGet, and no longer supported by its creator. +::: + +Use the extension method provided by the package to configure the client: + +```csharp +var client = new RestClient( + options, + configureSerialization: s => s.UseNewtonsoftJson() +); +``` + +The serializer configures some options by default: + +```csharp +JsonSerializerSettings DefaultSettings = new JsonSerializerSettings { + ContractResolver = new CamelCasePropertyNamesContractResolver(), + DefaultValueHandling = DefaultValueHandling.Include, + TypeNameHandling = TypeNameHandling.None, + NullValueHandling = NullValueHandling.Ignore, + Formatting = Formatting.None, + ConstructorHandling = ConstructorHandling.AllowNonPublicDefaultConstructor +}; +``` + +If you need to use different settings, you can supply your instance of +`JsonSerializerSettings` as a parameter for the extension method. + +## CSV + +A separate package `RestSharp.Serializers.CsvHelper` provides a CSV serializer for RestSharp. It is based on the +`CsvHelper` library. + +Use the extension method provided by the package to configure the client: + +```csharp +var client = new RestClient( + options, + configureSerialization: s => s.UseCsvHelper() +); +``` + +You can also supply your instance of `CsvConfiguration` as a parameter for the extension method. + +```csharp +var client = new RestClient( + options, + configureSerialization: s => s.UseCsvHelper( + new CsvConfiguration(CultureInfo.InvariantCulture) {...} + ) +); +``` + +## Custom + +You can also implement your custom serializer. To support both serialization and +deserialization, you must implement the `IRestSerializer` interface. + +Here is an example of a custom serializer that uses `System.Text.Json`: + +```csharp +public class SimpleJsonSerializer : IRestSerializer { + public string? Serialize(object? obj) => obj == null ? null : JsonSerializer.Serialize(obj); + + public string? Serialize(Parameter bodyParameter) => Serialize(bodyParameter.Value); + + public T? Deserialize(RestResponse response) => JsonSerializer.Deserialize(response.Content!); + + public ContentType ContentType { get; set; } = ContentType.Json; + + public ISerializer Serializer => this; + public IDeserializer Deserializer => this; + public DataFormat DataFormat => DataFormat.Json; + public string[] AcceptedContentTypes => ContentType.JsonAccept; + public SupportsContentType SupportsContentType + => contentType => contentType.Value.EndsWith("json", StringComparison.InvariantCultureIgnoreCase); +} +``` + +The `SupportedContentTypes` function will be used to check if the serializer is able to deserialize the response based on the `Content-Type` response header. + +The `ContentType` property will be used when making a request so the server knows how to handle the payload. diff --git a/docs/versioned_docs/version-v110/changelog.md b/docs/versioned_docs/version-v110/changelog.md new file mode 100644 index 000000000..c19657872 --- /dev/null +++ b/docs/versioned_docs/version-v110/changelog.md @@ -0,0 +1,24 @@ +--- +title: What's new +description: List of changes for the current major version +sidebar_position: 1 +--- + +# Changelog + +For release notes of previous versions, please check the [Releases page](https://github.com/restsharp/RestSharp/releases) in RestSharp GitHub repository. + +## What's Changed +* Added default parameters to the request. They got missing somehow. +* Consider the boundary quotes request option value. +* Made `BuildUrl` an extension so it can be used publicly. +* Added client-level cookie container. + +## Breaking change + +The `IRestClient` interface signature is different, so any non-standard implementations need to adopt the changes. + +To keep `DefaultParameters` thread-safe, it got a new type `DefaultParameters`, and request property `Parameters` has a dedicated type `RequestParameter`. Code-wise the change is non-breaking as the signatures are the same, but v110 is not binary compatible with previous versions. The difference is that `DefaultParameters` collection wraps all its mutations in a lock. + +**Full Changelog**: https://github.com/restsharp/RestSharp/compare/109.0.1...110.0.0 + diff --git a/docs/versioned_docs/version-v110/intro.md b/docs/versioned_docs/version-v110/intro.md new file mode 100644 index 000000000..caf619979 --- /dev/null +++ b/docs/versioned_docs/version-v110/intro.md @@ -0,0 +1,112 @@ +--- +sidebar_position: 2 +title: Quick start +--- + +## Introduction + +:::warning +RestSharp v107+ changes the library API surface and its behaviour significantly. We advise looking at [migration](/migration) docs to understand how to migrate to the latest version of RestSharp. +::: + +The main purpose of RestSharp is to make synchronous and asynchronous calls to remote resources over HTTP. As the name suggests, the main audience of RestSharp are developers who use REST APIs. However, RestSharp can call any API over HTTP, as long as you have the resource URI and request parameters that you want to send comply with W3C HTTP standards. + +One of the main challenges of using HTTP APIs for .NET developers is to work with requests and responses of different kinds and translate them to complex C# types. RestSharp can take care of serializing the request body to JSON or XML and deserialize the response. It can also form a valid request URI based on different parameter kinds: path, query, form or body. + +## Getting Started + +Before you can use RestSharp in your application, you need to add the NuGet package. You can do it using your IDE or the command line: + +``` +dotnet add package RestSharp +``` + +### Basic Usage + +If you only have a small number of one-off API requests to perform, you can use RestSharp like this: + +```csharp +using RestSharp; +using RestSharp.Authenticators; + +var options = new RestClientOptions("https://api.twitter.com/1.1") { + Authenticator = new HttpBasicAuthenticator("username", "password") +}; +var client = new RestClient(options); +var request = new RestRequest("statuses/home_timeline.json"); +// The cancellation token comes from the caller. You can still make a call without it. +var response = await client.GetAsync(request, cancellationToken); +``` + +It will return a `RestResponse` back, which contains all the information returned from the remote server. +You have access to the headers, content, HTTP status and more. + +You can also use generic overloads like `Get` to automatically deserialize the response into a .NET class. + +For example: + +```csharp +using RestSharp; +using RestSharp.Authenticators; + +var options = new RestClientOptions("https://api.twitter.com/1.1") { + Authenticator = new HttpBasicAuthenticator("username", "password") +}; +var client = new RestClient(options); + +var request = new RestRequest("statuses/home_timeline.json"); + +// The cancellation token comes from the caller. You can still make a call without it. +var timeline = await client.GetAsync(request, cancellationToken); +``` + +Both snippets above use the `GetAsync` extension, which is a wrapper about `ExecuteGetAsync`, which, in turn, is a wrapper around `ExecuteAsync`. +All `ExecuteAsync` overloads and return the `RestResponse` or `RestResponse`. + +The most important difference is that async methods named after HTTP methods (like `GetAsync` or `PostAsync`) return `Task` instead of `Task>`. It means that you won't get an error response if the request fails as those methods throw an exception for unsuccessful HTTP calls. For keeping the API consistent, non-generic functions like `GetAsync` or `PostAsync` also throw an exception if the request fails, although they return the `Task`. + +Read [here](advanced/error-handling.md) about how RestSharp handles exceptions. + +RestSharp also offers simple ways to call APIs that accept and return JSON payloads. You can use the `GetJsonAsync` and `PostJsonAsync` extension methods, which will automatically serialize the request body to JSON and deserialize the response to the specified type. + +```csharp +var client = new RestClient(options); +var timeline = await client.GetJsonAsync("statuses/home_timeline.json", cancellationToken); +``` + +Read [here](usage/usage.md#json-requests) about making JSON calls without preparing a request object. + +### Content type + +RestSharp supports sending XML or JSON body as part of the request. To add a body to the request, simply call `AddJsonBody` or `AddXmlBody` method of the `RestRequest` object. + +There is no need to set the `Content-Type` or add the `DataFormat` parameter to the request when using those methods, RestSharp will do it for you. + +RestSharp will also handle both XML and JSON responses and perform all necessary deserialization tasks, depending on the server response type. Therefore, you only need to add the `Accept` header if you want to deserialize the response manually. + +For example, only you'd only need these lines to make a request with JSON body: + +```csharp +var request = new RestRequest("address/update").AddJsonBody(updatedAddress); +var response = await client.PostAsync(request); +``` + +It's also possible to make the same call using `PostAsync` shorter syntax: + +```csharp +var response = await PostJsonAsync( + "address/update", request, cancellationToken +); +``` + +Read more about serialization and deserialization [here](advanced/serialization.md). + +### Response + +When you use `ExecuteAsync`, you get an instance of `RestResponse` back. The response object has the `Content` property, which contains the response as string. You can find other useful properties there, like `StatusCode`, `ContentType` and so on. If the request wasn't successful, you'd get a response back with `IsSuccessful` property set to `false` and the error explained in the `ErrorException` and `ErrorMessage` properties. + +When using typed `ExecuteAsync`, you get an instance of `RestResponse` back, which is identical to `RestResponse` but also contains the `T Data` property with the deserialized response. + +None of `ExecuteAsync` overloads throw if the remote server returns an error. You can inspect the response and find the status code, error message, and, potentially, an exception. + +Extensions like `GetAsync` will not return the whole `RestResponse` but just a deserialized response. These extensions will throw an exception if the remote server returns an error. The exception details contain the status code returned by the server. diff --git a/docs/versioned_docs/version-v110/usage/_category_.json b/docs/versioned_docs/version-v110/usage/_category_.json new file mode 100644 index 000000000..bd2045cd6 --- /dev/null +++ b/docs/versioned_docs/version-v110/usage/_category_.json @@ -0,0 +1,7 @@ +{ + "label": "Using RestSharp", + "position": 3, + "link": { + "type": "generated-index" + } +} diff --git a/docs/versioned_docs/version-v110/usage/example.md b/docs/versioned_docs/version-v110/usage/example.md new file mode 100644 index 000000000..458ed57bb --- /dev/null +++ b/docs/versioned_docs/version-v110/usage/example.md @@ -0,0 +1,148 @@ +# Example + +RestSharp works best as the foundation for a proxy class for your API. Each API would most probably require different settings for `RestClient`. Hence, a dedicated API class (and its interface) gives you sound isolation between different `RestClient` instances and make them testable. + +For example, let's look at a simple Twitter API v2 client, which uses OAuth2 machine-to-machine authentication. For it to work, you would need to have access to the Twitter Developers portal, a project, and an approved application inside the project with OAuth2 enabled. + +## Client model + +Before implementing an API client, we need to have a model for it. The model includes an abstraction for the client, which has functions for the API calls we are interested to implement. In addition, the client model would include the necessary request and response models. Usually those are simple classes or records without logic, which are often referred to as DTOs (data transfer objects). + +This example starts with a single function that retrieves one Twitter user. Lets being by defining the API client interface: + +```csharp +public interface ITwitterClient { + Task GetUser(string user); +} +``` + +As the function returns a `TwitterUser` instance, we need to define it as a model: + +```csharp +public record TwitterUser(string Id, string Name, string Username); +``` + +## Client implementation + +When that is done, we can implement the interface and add all the necessary code blocks to get a working API client. + +The client class needs the following: +- A constructor for passing API credentials +- A wrapped `RestClient` instance with the Twitter API base URI pre-configured +- An authenticator to support authorizing the client using Twitter OAuth2 authentication +- The actual function to get the user (to implement the `ITwitterClient` interface) + +Creating an authenticator is described [below](#authenticator). + +Here's how the client implementation could look like: + +```csharp +public class TwitterClient : ITwitterClient, IDisposable { + readonly RestClient _client; + + public TwitterClient(string apiKey, string apiKeySecret) { + var options = new RestClientOptions("https://api.twitter.com/2"); + _client = new RestClient(options); + } + + public async Task GetUser(string user) { + var response = await _client.GetJsonAsync>( + "users/by/username/{user}", + new { user } + ); + return response!.Data; + } + + record TwitterSingleObject(T Data); + + public void Dispose() { + _client?.Dispose(); + GC.SuppressFinalize(this); + } +} +``` + +It is also possible to use ASP.NET Core Options for configuring the client, instead of passing the credentials as strings. For example, we can add a class for Twitter client options, and use it in a constructor: + +```csharp +public class TwitterClientOptions(string ApiKey, string ApiSecret); + +public TwitterClient(IOptions options) { + var opt = new RestClientOptions("https://api.twitter.com/2"); + _client = new RestClient(options); +} +``` + +Then, you can register and configure the client using ASP.NET Core dependency injection container. + +Right now, the client won't really work as Twitter API requires authentication. It's covered in the next section. + +## Authenticator + +Before we can call the API itself, we need to get a bearer token. Twitter exposes an endpoint `https://api.twitter.com/oauth2/token`. As it follows the OAuth2 conventions, the code can be used to create an authenticator for some other vendors. + +First, we need a model for deserializing the token endpoint response. OAuth2 uses snake case for property naming, so we need to decorate model properties with `JsonPropertyName` attribute: + +```csharp +record TokenResponse { + [JsonPropertyName("token_type")] + public string TokenType { get; init; } + [JsonPropertyName("access_token")] + public string AccessToken { get; init; } +} +``` + +Next, we create the authenticator itself. It needs the API key and API key secret to call the token endpoint using basic HTTP authentication. In addition, we can extend the list of parameters with the base URL to convert it to a more generic OAuth2 authenticator. + +The easiest way to create an authenticator is to inherit from the `AuthenticatorBase` base class: + +```csharp +public class TwitterAuthenticator : AuthenticatorBase { + readonly string _baseUrl; + readonly string _clientId; + readonly string _clientSecret; + + public TwitterAuthenticator(string baseUrl, string clientId, string clientSecret) : base("") { + _baseUrl = baseUrl; + _clientId = clientId; + _clientSecret = clientSecret; + } + + protected override async ValueTask GetAuthenticationParameter(string accessToken) { + Token = string.IsNullOrEmpty(Token) ? await GetToken() : Token; + return new HeaderParameter(KnownHeaders.Authorization, Token); + } +} +``` + +During the first call made by the client using the authenticator, it will find out that the `Token` property is empty. It will then call the `GetToken` function to get the token once and reuse the token going forward. + +Now, we need to implement the `GetToken` function in the class: + +```csharp +async Task GetToken() { + var options = new RestClientOptions(_baseUrl){ + Authenticator = new HttpBasicAuthenticator(_clientId, _clientSecret), + }; + using var client = new RestClient(options); + + var request = new RestRequest("oauth2/token") + .AddParameter("grant_type", "client_credentials"); + var response = await client.PostAsync(request); + return $"{response!.TokenType} {response!.AccessToken}"; +} +``` + +As we need to make a call to the token endpoint, we need our own short-lived instance of `RestClient`. Unlike the actual Twitter client, it will use the `HttpBasicAuthenticator` to send the API key and secret as the username and password. The client then gets disposed as we only use it once. + +Here we add a POST parameter `grant_type` with `client_credentials` as its value. At the moment, it's the only supported value. + +The POST request will use the `application/x-www-form-urlencoded` content type by default. + +:::note +Sample code provided on this page is a production code. For example, the authenticator might produce undesired side effect when multiple requests are made at the same time when the token hasn't been obtained yet. It can be solved rather than simply using semaphores or synchronized invocation. +::: + +## Final words + +This page demonstrates how an API client can be implemented as a typed, configurable client with its own interface. Usage of the client in applications is not covered here as different application types and target frameworks have their own idiomatic ways to use HTTP clients. \ No newline at end of file diff --git a/docs/versioned_docs/version-v110/usage/usage.md b/docs/versioned_docs/version-v110/usage/usage.md new file mode 100644 index 000000000..1b378aace --- /dev/null +++ b/docs/versioned_docs/version-v110/usage/usage.md @@ -0,0 +1,576 @@ +--- +sidebar_position: 2 +--- + +# RestSharp basics + +This page describes some of the essential properties and features of RestSharp. + +## What RestSharp does + +Essentially, RestSharp is a wrapper around `HttpClient` that allows you to do the following: +- Add default parameters of any kind (not just headers) to the client, once +- Add parameters of any kind to each request (query, URL segment, form, attachment, serialized body, header) in a straightforward way +- Serialize the payload to JSON or XML if necessary +- Set the correct content headers (content type, disposition, length, etc.) +- Handle the remote endpoint response +- Deserialize the response from JSON or XML if necessary + +## API client + +The best way to call an external HTTP API is to create a typed client, which encapsulates RestSharp calls and doesn't expose the `RestClient` instance in public. + +You can find an example of a Twitter API client on the [Example](example.md) page. + +## Creating the client + +A RestSharp client can be instantiated by one of the constructors: + +```csharp +// Creates a client with default options to call a given base URL +var client = new RestClient("https://localhost:5000"); + +// Creates a client using the options object +var options = new RestClientOptions("https://localhost:5000") { + MaxTimeout = 1000 +}; +var client = new RestClient(options); +``` + +### Simple factory + +Another way to create the client instance is to use a simple client factory. The factory will use the `BaseUrl` property of the client options to cache `HttpClient` instances. Every distinct base URL will get its own `HttpClient` instance. Other options don't affect the caching. Therefore, if you use different options for the same base URL, you'll get the same `HttpClient` instance, which will not be configured with the new options. Options that aren't applied _after_ the first client instance is created are: + +* `Credentials` +* `UseDefaultCredentials` +* `AutomaticDecompression` +* `PreAuthenticate` +* `FollowRedirects` +* `RemoteCertificateValidationCallback` +* `ClientCertificates` +* `MaxRedirects` +* `MaxTimeout` +* `UserAgent` +* `Expect100Continue` + +Constructor parameters to configure the `HttpMessageHandler` and default `HttpClient` headers configuration are also ignored for the cached instance as the factory only configures the handler once. + +You need to set the `useClientFactory` parameter to `true` in the `RestClient` constructor to enable the factory. + +```csharp +var client = new RestClient("https://api.twitter.com/2", true); +``` + +## Create a request + +Before making a request using `RestClient`, you need to create a request instance: + +```csharp +var request = new RestRequest(resource); // resource is the sub-path of the client base path +``` + +The default request type is `GET` and you can override it by setting the `Method` property. You can also set the method using the constructor overload: + +```csharp +var request = new RestRequest(resource, Method.Post); +``` + +After you've created a `RestRequest`, you can add parameters to it. Below, you can find all the parameter types supported by RestSharp. + +### Adding headers + +Adds the header parameter as an HTTP header that is sent along with the request. The header name is the parameter's name and the header value is the value. + +You can use one of the following request methods to add a header parameter: + +```csharp +AddHeader(string name, string value); +AddHeader(string name, T value); // value will be converted to string +AddOrUpdateHeader(string name, string value); // replaces the header if it already exists +``` + +For example: + +```csharp +var request = new RestRequest("/path").AddHeader("X-Key", someKey); +``` + +You can also add header parameters to the client, and they will be added to every request made by the client. This is useful for adding authentication headers, for example. + +```csharp +client.AddDefaultHeader(string name, string value); +``` + +::: warning Content-Type +RestSharp will use the correct content type by default. Avoid adding the `Content-Type` header manually to your requests unless you are absolutely sure it is required. You can add a custom content type to the [body parameter](#request-body) itself. +::: + +### Get or Post parameters + +The default RestSharp parameter type is `GetOrPostParameter`. You can add `GetOrPost` parameter to the request using the `AddParameter` function: + +```csharp +request + .AddParameter("name1", "value1") + .AddParameter("name2", "value2"); +``` + +`GetOrPost` behaves differently based on the HTTP method. If you execute a `GET` call, RestSharp will append the parameters to the URL in the form `url?name1=value1&name2=value2`. + +On a `POST` or `PUT` requests, it depends on whether you have files attached to a request. +If not, the parameters will be sent as the body of the request in the form `name1=value1&name2=value2`. Also, the request will be sent as `application/x-www-form-urlencoded`. + +In both cases, name and value will automatically be URL-encoded, unless specified otherwise: + +```csharp +request.AddParameter("name", "Væ üé", false); // don't encode the value +``` + +If you have files, RestSharp will send a `multipart/form-data` request. Your parameters will be part of this request in the form: + +``` +Content-Disposition: form-data; name="parameterName" + +ParameterValue +``` + +You can also add `GetOrPost` parameter as a default parameter to the client. This will add the parameter to every request made by the client. + +```csharp +client.AddDefaultParameter("foo", "bar"); +``` + +It will work the same way as request parameters, except that it will be added to every request. + +### Using AddObject + +You can avoid calling `AddParameter` multiple times if you collect all the parameters in an object, and then use `AddObject`. +For example, this code: + +```csharp +var params = new { + status = 1, + priority = "high", + ids = new [] { "123", "456" } +}; +request.AddObject(params); +``` + +is equivalent to: + +```csharp +request.AddParameter("status", 1); +request.AddParameter("priority", "high"); +request.AddParameter("ids", "123,456"); +``` + +Remember that `AddObject` only works if your properties have primitive types. It also works with collections of primitive types as shown above. + +If you need to override the property name or format, you can do it using the `RequestProperty` attribute. For example: + +```csharp +public class RequestModel { + // override the name and the format + [RequestProperty(Name = "from_date", Format = "d")] + public DateTime FromDate { get; set; } +} + +// add it to the request +request.AddObject(new RequestModel { FromDate = DateTime.Now }); +``` + +In this case, the request will get a GET or POST parameter named `from_date` and its value would be the current date in short date format. + +### Using AddObjectStatic + +Request function `AddObjectStatic(...)` allows using pre-compiled expressions for getting property values. Compared to `AddObject` that uses reflections for each call, `AddObjectStatic` caches functions to retrieve properties from an object of type `T`, so it works much faster. + +You can instruct `AddObjectStatic` to use custom parameter names and formats, as well as supply the list of properties than need to be used as parameters. The last option could be useful if the type `T` has properties that don't need to be sent with HTTP call. + +To use custom parameter name or format, use the `RequestProperty` attribute. For example: + +```csharp +class TestObject { + [RequestProperty(Name = "some_data")] + public string SomeData { get; set; } + + [RequestProperty(Format = "d")] + public DateTime SomeDate { get; set; } + + [RequestProperty(Name = "dates", Format = "d")] + public DateTime[] DatesArray { get; set; } + + public int Plain { get; set; } + public DateTime[] PlainArray { get; set; } +} +``` + +### URL segment parameter + +Unlike `GetOrPost`, URL segment parameter replaces placeholder values in the request URL: + +```csharp +var request = new RestRequest("health/{entity}/status") + .AddUrlSegment("entity", "s2"); +``` + +When the request executes, RestSharp will try to match any `{placeholder}` with a parameter of that name (without the `{}`) and replace it with the value. So the above code results in `health/s2/status` being the URL. + +You can also add `UrlSegment` parameter as a default parameter to the client. This will add the parameter to every request made by the client. + +```csharp +client.AddDefaultUrlSegment("foo", "bar"); +``` + +### Cookies + +You can add cookies to a request using the `AddCookie` method: + +```csharp +request.AddCookie("foo", "bar"); +``` + +The simple two-parameter form defers domain resolution until execution time — the cookie domain is inferred from the request URL. If you need to specify the path and domain explicitly, use the four-parameter overload: + +```csharp +request.AddCookie("foo", "bar", "/path", "example.com"); +``` + +RestSharp will add cookies from the request as cookie headers and then extract the matching cookies from the response. You can observe and extract response cookies using the `RestResponse.Cookies` properties, which has the `CookieCollection` type. + +There is a `CookieContainer` instance on the request level. You can either assign the pre-populated container to `request.CookieContainer`, or let the container be created automatically at execution time. The four-parameter `AddCookie` overload populates the container immediately, while the two-parameter form stores cookies in `PendingCookies` until the request is executed. The container is used to extract all the cookies from it and create cookie headers for the request instead of using the container directly. It's because the cookie container is normally configured on the `HttpClientHandler` level and cookies are shared between requests made by the same client. In most of the cases this behaviour can be harmful. + +If your use case requires sharing cookies between requests made by the client instance, you can use the client-level `CookieContainer`, which you must provide as the options' property. You can add cookies to the container using the container API. No response cookies, however, would be auto-added to the container, but you can do it in code by getting cookies from the `Cookies` property of the response and adding them to the client-level container available via `IRestClient.Options.CookieContainer` property. + +### Request Body + +RestSharp supports multiple ways to add a request body: +- `AddJsonBody` for JSON payloads +- `AddXmlBody` for XML payloads +- `AddStringBody` for pre-serialized payloads + +We recommend using `AddJsonBody` or `AddXmlBody` methods instead of `AddParameter` with type `BodyParameter`. Those methods will set the proper request type and do the serialization work for you. + +When you make a `POST`, `PUT` or `PATCH` request and added `GetOrPost` [parameters](#get-or-post-parameters), RestSharp will send them as a URL-encoded form request body by default. When a request also has files, it will send a `multipart/form-data` request. You can also instruct RestSharp to send the body as `multipart/form-data` by setting the `AlwaysMultipartFormData` property to `true`. + +You can specify a custom body content type if necessary. The `contentType` argument is available in all the overloads that add a request body. + +It is not possible to add client-level default body parameters. + +#### String body + +If you have a pre-serialized payload like a JSON string, you can use `AddStringBody` to add it as a body parameter. You need to specify the content type, so the remote endpoint knows what to do with the request body. For example: + +```csharp +const json = "{ data: { foo: \"bar\" } }"; +request.AddStringBody(json, ContentType.Json); +``` + +#### JSON body + +When you call `AddJsonBody`, it does the following for you: + +- Instructs the RestClient to serialize the object parameter as JSON when making a request +- Sets the content type to `application/json` +- Sets the internal data type of the request body to `DataType.Json` + +Here is the example: + +```csharp +var param = new MyClass { IntData = 1, StringData = "test123" }; +request.AddJsonBody(param); +``` + +It is possible to override the default content type by supplying the `contentType` argument. For example: + +```csharp +request.AddJsonBody(param, "text/x-json"); +``` + +If you use a pre-serialized string with `AddJsonBody`, it will be sent as-is. The `AddJsonBody` will detect if the parameter is a string and will add it as a string body with JSON content type. +Essentially, it means that top-level strings won't be serialized as JSON when you use `AddJsonBody`. To overcome this issue, you can use an overload of `AddJsonBody`, which allows you to tell RestSharp to serialize the string as JSON: + +```csharp +const string payload = @" +""requestBody"": { + ""content"": { + ""application/json"": { + ""schema"": { + ""type"": ""string"" + } + } + } +},"; +request.AddJsonBody(payload, forceSerialize: true); // the string will be serialized +request.AddJsonBody(payload); // the string will NOT be serialized and will be sent as-is +``` + +#### XML body + +When you call `AddXmlBody`, it does the following for you: + +- Instructs the RestClient to serialize the object parameter as XML when making a request +- Sets the content type to `application/xml` +- Sets the internal data type of the request body to `DataType.Xml` + +:::warning +Do not send XML string to `AddXmlBody`; it won't work! +::: + +### Query string + +`QueryString` works like `GetOrPost`, except that it always appends the parameters to the url in the form `url?name1=value1&name2=value2`, regardless of the request method. + +Example: + +```csharp +var client = new RestClient("https://search.me"); +var request = new RestRequest("search") + .AddParameter("foo", "bar"); +var response = await client.GetAsync(request); +``` + +It will send a `GET` request to `https://search.me/search?foo=bar`. + +For `POST`-style requests you need to add the query string parameter explicitly: + +```csharp +request.AddQueryParameter("foo", "bar"); +``` + +In some cases, you might need to prevent RestSharp from encoding the query string parameter. +To do so, set the `encode` argument to `false` when adding the parameter: + +```csharp +request.AddQueryParameter("foo", "bar/fox", false); +``` + +You can also add a query string parameter as a default parameter to the client. This will add the parameter to every request made by the client. + +```csharp +client.AddDefaultQueryParameter("foo", "bar"); +``` + +The line above will result in all the requests made by that client instance to have `foo=bar` in the query string for all the requests made by that client. + +## Making a call + +Once you've added all the parameters to your `RestRequest`, you are ready to make a request. + +`RestClient` has a single function for this: + +```csharp +public async Task ExecuteAsync( + RestRequest request, + CancellationToken cancellationToken = default +) +``` + +You can also avoid setting the request method upfront and use one of the overloads: + +```csharp +Task ExecuteGetAsync(RestRequest request, CancellationToken cancellationToken) +Task ExecutePostAsync(RestRequest request, CancellationToken cancellationToken) +Task ExecutePutAsync(RestRequest request, CancellationToken cancellationToken) +``` + +When using any of those methods, you will get the response content as string in `response.Content`. + +RestSharp can deserialize the response for you. To use that feature, use one of the generic overloads: + +```csharp +Task> ExecuteAsync(RestRequest request, CancellationToken cancellationToken) +Task> ExecuteGetAsync(RestRequest request, CancellationToken cancellationToken) +Task> ExecutePostAsync(RestRequest request, CancellationToken cancellationToken) +Task> ExecutePutAsync(RestRequest request, CancellationToken cancellationToken) +``` + +All the overloads with names starting with `Execute` don't throw an exception if the server returns an error. Read more about it [here](../advanced/error-handling.md). + +If you just need a deserialized response, you can use one of the extensions: + +```csharp +Task GetAsync(RestRequest request, CancellationToken cancellationToken) +Task PostAsync(RestRequest request, CancellationToken cancellationToken) +Task PutAsync(RestRequest request, CancellationToken cancellationToken) +Task HeadAsync(RestRequest request, CancellationToken cancellationToken) +Task PatchAsync(RestRequest request, CancellationToken cancellationToken) +Task DeleteAsync(RestRequest request, CancellationToken cancellationToken) +``` + +Those extensions will throw an exception if the server returns an error, as there's no other way to float the error back to the caller. + +The `IRestClient` interface also has extensions for making requests without deserialization, which throw an exception if the server returns an error even if the client is configured to not throw exceptions. + +```csharp +Task GetAsync(RestRequest request, CancellationToken cancellationToken) +Task PostAsync(RestRequest request, CancellationToken cancellationToken) +Task PutAsync(RestRequest request, CancellationToken cancellationToken) +Task HeadAsync(RestRequest request, CancellationToken cancellationToken) +Task PatchAsync(RestRequest request, CancellationToken cancellationToken) +Task DeleteAsync(RestRequest request, CancellationToken cancellationToken) +``` + +### JSON requests + +To make a simple `GET` call and get a deserialized JSON response with a pre-formed resource string, use this: + +```csharp +var response = await client.GetJsonAsync("endpoint?foo=bar", cancellationToken); +``` + +You can also use a more advanced extension that uses an object to compose the resource string: + +```csharp +var client = new RestClient("https://example.org"); +var args = new { + id = "123", + foo = "bar" +}; +// Will make a call to https://example.org/endpoint/123?foo=bar +var response = await client.GetJsonAsync("endpoint/{id}", args, cancellationToken); +``` + +It will search for the URL segment parameters matching any of the object properties and replace them with values. All the other properties will be used as query parameters. + +Similar things are available for `POST` requests. + +```csharp +var request = new CreateOrder("123", "foo", 10100); +// Will post the request object as JSON to "orders" and returns a +// JSON response deserialized to OrderCreated +var result = client.PostJsonAsync("orders", request, cancellationToken); +``` + +```csharp +var request = new CreateOrder("123", "foo", 10100); +// Will post the request object as JSON to "orders" and returns a +// status code, not expecting any response body +var statusCode = client.PostJsonAsync("orders", request, cancellationToken); +``` + +The same two extensions also exist for `PUT` requests (`PutJsonAsync`); + +### JSON streaming APIs + +For HTTP API endpoints that stream the response data (like [Twitter search stream](https://developer.twitter.com/en/docs/twitter-api/tweets/filtered-stream/api-reference/get-tweets-search-stream)) you can use RestSharp with `StreamJsonAsync`, which returns an `IAsyncEnumerable`: + +```csharp +public async IAsyncEnumerable SearchStream( + [EnumeratorCancellation] CancellationToken cancellationToken = default +) { + var response = _client.StreamJsonAsync>( + "tweets/search/stream", cancellationToken + ); + + await foreach (var item in response.WithCancellation(cancellationToken)) { + yield return item.Data; + } +} +``` + +The main limitation of this function is that it expects each JSON object to be returned as a single line. It is unable to parse the response by combining multiple lines into a JSON string. + +### Uploading files + +To add a file to the request you can use the `RestRequest` function called `AddFile`. The main function accepts the `FileParameter` argument: + +```csharp +request.AddFile(fileParameter); +``` + +You can instantiate the file parameter using `FileParameter.Create` that accepts a bytes array, or `FileParameter.FromFile`, which will load the file from disk. + +There are also extension functions that wrap the creation of `FileParameter` inside: + +```csharp +// Adds a file from disk +AddFile(parameterName, filePath, contentType); + +// Adds an array of bytes +AddFile(parameterName, bytes, fileName, contentType); + +// Adds a stream returned by the getFile function +AddFile(parameterName, getFile, fileName, contentType); +``` + +Remember that `AddFile` will set all the necessary headers, so please don't try to set content headers manually. + +You can also provide file upload options to the `AddFile` call. The options are: +- `DisableFilenameEncoding` (default `false`): if set to `true`, RestSharp will not encode the file name in the `Content-Disposition` header +- `DisableFilenameStar` (default `true`): if set to `true`, RestSharp will not add the `filename*` parameter to the `Content-Disposition` header + +Example of using the options: + +```csharp +var options = new FileParameterOptions { + DisableFilenameEncoding = true, + DisableFilenameStar = false +}; +request.AddFile("file", filePath, options: options); +``` + +The options specified in the snippet above usually help when you upload files with non-ASCII characters in their names. + +### Downloading binary data + +There are two functions that allow you to download binary data from the remote API. + +First, there's `DownloadDataAsync`, which returns `Task`. This function allows you to open a stream reader and asynchronously stream large responses to memory or disk. + + +## Reusing HttpClient + +RestSharp uses `HttpClient` internally to make HTTP requests. It's possible to reuse the same `HttpClient` instance for multiple `RestClient` instances. This is useful when you want to share the same connection pool between multiple `RestClient` instances. + +One way of doing it is to use `RestClient` constructors that accept an instance of `HttpClient` or `HttpMessageHandler` as an argument. Note that in that case not all the options provided via `RestClientOptions` will be used. Here is the list of options that will work: + +- `BaseAddress` will be used to set the base address of the `HttpClient` instance if base address is not set there already. +- `MaxTimeout` +- `UserAgent` will be added to the `RestClient.DefaultParameters` list as a HTTP header. This will be added to each request made by the `RestClient`, and the `HttpClient` instance will not be modified. This is to allow the `HttpClient` instance to be reused for scenarios where different `User-Agent` headers are required. +- `Expect100Continue` + +Another option is to use a simple HTTP client factory as described [above](#simple-factory). + +## Blazor support + +Inside a Blazor webassembly app, you can make requests to external API endpoints. Microsoft examples show how to do it with `HttpClient`, and it's also possible to use RestSharp for the same purpose. + +You need to remember that webassembly has some platform-specific limitations. Therefore, you won't be able to instantiate `RestClient` using all of its constructors. In fact, you can only use `RestClient` constructors that accept `HttpClient` or `HttpMessageHandler` as an argument. If you use the default parameterless constructor, it will call the option-based constructor with default options. The options-based constructor will attempt to create an `HttpMessageHandler` instance using the options provided, and it will fail with Blazor, as some of those options throw thw "Unsupported platform" exception. + +Here is an example how to register the `RestClient` instance globally as a singleton: + +```csharp +builder.Services.AddSingleton(new RestClient(new HttpClient())); +``` + +Then, on a page you can inject the instance: + +```html +@page "/fetchdata" +@using RestSharp +@inject RestClient _restClient +``` + +And then use it: + +```csharp +@code { + private WeatherForecast[]? forecasts; + + protected override async Task OnInitializedAsync() { + forecasts = await _restClient.GetJsonAsync("http://localhost:5104/weather"); + } + + public class WeatherForecast { + public DateTime Date { get; set; } + public int TemperatureC { get; set; } + public string? Summary { get; set; } + public int TemperatureF => 32 + (int)(TemperatureC / 0.5556); + } +} +``` + +In this case, the call will be made to a WebAPI server hosted at `http://localhost:5104/weather`. Remember that if the WebAPI server is not hosting the webassembly itself, it needs to have a CORS policy configured to allow the webassembly origin to access the API endpoint from the browser. diff --git a/docs/versioned_docs/version-v111/advanced/_category_.json b/docs/versioned_docs/version-v111/advanced/_category_.json new file mode 100644 index 000000000..f395bdfe4 --- /dev/null +++ b/docs/versioned_docs/version-v111/advanced/_category_.json @@ -0,0 +1,7 @@ +{ + "label": "Advanced topics", + "position": 4, + "link": { + "type": "generated-index" + } +} diff --git a/docs/versioned_docs/version-v111/advanced/authenticators.md b/docs/versioned_docs/version-v111/advanced/authenticators.md new file mode 100644 index 000000000..14196d97c --- /dev/null +++ b/docs/versioned_docs/version-v111/advanced/authenticators.md @@ -0,0 +1,185 @@ +# Authenticators + +RestSharp includes authenticators for basic HTTP, OAuth1 and token-based (JWT and OAuth2). + +There are two ways to set the authenticator: client-wide or per-request. + +Set the client-wide authenticator by assigning the `Authenticator` property of `RestClientOptions`: + +```csharp +var options = new RestClientOptions("https://example.com") { + Authenticator = new HttpBasicAuthenticator("username", "password") +}; +var client = new RestClient(options); +``` + +To set the authenticator per-request, assign the `Authenticator` property of `RestRequest`: + +```csharp +var request = new RestRequest("/api/users/me") { + Authenticator = new HttpBasicAuthenticator("username", "password") +}; +var response = await client.ExecuteAsync(request, cancellationToken); +``` + +## Basic authentication + +The `HttpBasicAuthenticator` allows you pass a username and password as a basic `Authorization` header using a base64 encoded string. + +```csharp +var options = new RestClientOptions("https://example.com") { + Authenticator = new HttpBasicAuthenticator("username", "password") +}; +var client = new RestClient(options); +``` + +## OAuth1 + +For OAuth1 authentication the `OAuth1Authenticator` class provides static methods to help generate an OAuth authenticator. +OAuth1 authenticator will add the necessary OAuth parameters to the request, including signature. + +The authenticator will use `HMAC SHA1` to create a signature by default. +Each static function to create the authenticator allows you to override the default and use another method to generate the signature. + +### Request token + +Getting a temporary request token is the usual first step in the 3-legged OAuth1 flow. +Use `OAuth1Authenticator.ForRequestToken` function to get the request token authenticator. +This method requires a `consumerKey` and `consumerSecret` to authenticate. + +```csharp +var options = new RestClientOptions("https://api.twitter.com") { + Authenticator = OAuth1Authenticator.ForRequestToken(consumerKey, consumerSecret) +}; +var client = new RestClient(options); +var request = new RestRequest("oauth/request_token"); +``` + +The response should contain the token and the token secret, which can then be used to complete the authorization process. +If you need to provide the callback URL, assign the `CallbackUrl` property of the authenticator to the callback destination. + +### Access token + +Getting an access token is the usual third step in the 3-legged OAuth1 flow. +This method retrieves an access token when provided `consumerKey`, `consumerSecret`, `oauthToken`, and `oauthTokenSecret`. +If you don't have a token for this call, you need to make a call to get the request token as described above. + +```csharp +var authenticator = OAuth1Authenticator.ForAccessToken( + consumerKey, consumerSecret, oauthToken, oauthTokenSecret +); +var options = new RestClientOptions("https://api.twitter.com") { + Authenticator = authenticator +}; +var client = new RestClient(options); +var request = new RestRequest("oauth/access_token"); +``` + +If the second step in 3-leg OAuth1 flow returned a verifier value, you can use another overload of `ForAccessToken`: + +```csharp +var authenticator = OAuth1Authenticator.ForAccessToken( + consumerKey, consumerSecret, oauthToken, oauthTokenSecret, verifier +); +``` + +The response should contain the access token that can be used to make calls to protected resources. + +For refreshing access tokens, use one of the two overloads of `ForAccessToken` that accept `sessionHandle`. + +### Protected resource + +When the access token is available, use `ForProtectedResource` function to get the authenticator for accessing protected resources. + +```csharp +var authenticator = OAuth1Authenticator.ForAccessToken( + consumerKey, consumerSecret, accessToken, accessTokenSecret +); +var options = new RestClientOptions("https://api.twitter.com/1.1") { + Authenticator = authenticator +}; +var client = new RestClient(options); +var request = new RestRequest("statuses/update.json", Method.Post) + .AddParameter("status", "Hello Ladies + Gentlemen, a signed OAuth request!") + .AddParameter("include_entities", "true"); +``` + +### xAuth + +xAuth is a simplified version of OAuth1. It allows sending the username and password as `x_auth_username` and `x_auth_password` request parameters and directly get the access token. xAuth is not widely supported, but RestSharp still allows using it. + +Create an xAuth authenticator using `OAuth1Authenticator.ForClientAuthentication` function: + +```csharp +var authenticator = OAuth1Authenticator.ForClientAuthentication( + consumerKey, consumerSecret, username, password +); +``` + +### 0-legged OAuth + +The access token authenticator can be used in 0-legged OAuth scenarios by providing `null` for the `consumerSecret`. + +```csharp +var authenticator = OAuth1Authenticator.ForAccessToken( + consumerKey, null, oauthToken, oauthTokenSecret +); +``` + +## OAuth2 + +RestSharp has two very simple authenticators to send the access token as part of the request. + +`OAuth2UriQueryParameterAuthenticator` accepts the access token as the only constructor argument, and it will send the provided token as a query parameter `oauth_token`. + +`OAuth2AuthorizationRequestHeaderAuthenticator` has two constructors. One only accepts a single argument, which is the access token. The other constructor also allows you to specify the token type. The authenticator will then add an `Authorization` header using the specified token type or `OAuth` as the default token type, and the token itself. + +For example: + +```csharp +var authenticator = new OAuth2AuthorizationRequestHeaderAuthenticator( + token, "Bearer" +); +var options = new RestClientOptions("https://example.com") { + Authenticator = authenticator +}; +var client = new RestClient(options); +``` + +The code above will tell RestSharp to send the bearer token with each request as a header. Essentially, the code above does the same as the sample for `JwtAuthenticator` below. + +As those authenticators don't do much to get the token itself, you might be interested in looking at our [sample OAuth2 authenticator](../usage/example.md#authenticator), which requests the token on its own. + +## JWT + +The JWT authentication can be supported by using `JwtAuthenticator`. It is a very simple class that can be constructed like this: + +```csharp +var authenticator = new JwtAuthenticator(myToken); +var options = new RestClientOptions("https://example.com") { + Authenticator = authenticator +}; +var client = new RestClient(options); +``` + +For each request, it will add an `Authorization` header with the value `Bearer `. + +As you might need to refresh the token from, you can use the `SetBearerToken` method to update the token. + +## Custom authenticator + +You can write your own implementation by implementing `IAuthenticator` and +registering it with your RestClient: + +```csharp +var authenticator = new SuperAuthenticator(); // implements IAuthenticator +var options = new RestClientOptions("https://example.com") { + Authenticator = authenticator +}; +var client = new RestClient(options); +``` + +The `Authenticate` method is the very first thing called upon calling `RestClient.Execute` or `RestClient.Execute`. +It gets the `RestRequest` currently being executed giving you access to every part of the request data (headers, parameters, etc.) + +You can find an example of a custom authenticator that fetches and uses an OAuth2 bearer token [here](../usage/example.md#authenticator). diff --git a/docs/versioned_docs/version-v111/advanced/configuration.md b/docs/versioned_docs/version-v111/advanced/configuration.md new file mode 100644 index 000000000..6fbfaed33 --- /dev/null +++ b/docs/versioned_docs/version-v111/advanced/configuration.md @@ -0,0 +1,230 @@ +--- +title: Configuration +description: Learn how to configure RestClient for non-trivial use cases. +sidebar_position: 1 +--- + +# Configuring RestClient + +This page describes how to create and configure `RestClient`. + +## Basic configuration + +The primary `RestClient` constructor accepts an instance of `RestClientOptions`. Most of the time, default option values don't need to be changed. However, in some cases, you'd want to configure the client differently, so you'd need to change some of the options in your code. The constructor also contains a few optional parameters for additional configuration that is not covered by client options. Here's the constructor signature: + +```csharp +public RestClient( + RestClientOptions options, + ConfigureHeaders? configureDefaultHeaders = null, + ConfigureSerialization? configureSerialization = null, + bool useClientFactory = false +) +``` + +Constructor parameters are: + +| Name | Description | Mandatory | +|-------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------| +| options | Client options | Yes | +| configureDefaultHeaders | Function to configure headers. Allows to configure default headers for `HttpClient`. Most of the time you'd prefer using `client.AddDefaultHeader` instead. | No | +| configureSerialization | Function to configure client serializers with non-default options or to use a different serializer ([learn more](serialization.md)) | No | +| useClientFactory | Instructs the client to use `SimpleFactory` ([learn more](../usage/client#simple-factory)) to get an `HttpClient` instance | No | + +Here's an example of how to create a client using client options: + +```csharp +var options = new RestClientOptions("https://localhost:5000/api") { + DisableCharset = true +}; +var client = new RestClient(options); +``` + +When you only need to set the base URL, you can use a simplified constructor: + +```csharp +var client = new RestClient("https://localhost:5000/api"); +``` + +The simplified constructor will create an instance of client options and set the base URL provided as the constructor argument. + +Finally, you can override properties of default options using a configuration function. Here's the constructor signature that supports this method: + +```csharp +public RestClient( + ConfigureRestClient? configureRestClient = null, + ConfigureHeaders? configureDefaultHeaders = null, + ConfigureSerialization? configureSerialization = null, + bool useClientFactory = false +) +``` + +For example: + +```csharp +var client = new RestClient(options => { + options.BaseUrl = new Url("https://localhost:5000/api"), + options.DisableCharset = true +}); +``` + +You can also provide the base URL as a constructor argument like this: + +```csharp +var client = new RestClient("https://localhost:5000/api", options => { + options.DisableCharset = true +}); +``` + +## Using custom HttpClient + +By default, RestSharp creates an instance of `HttpClient` configured using the client options, and keeps it during the lifetime of the client. When the `RestClient` instance gets disposed, it also disposes the `HttpClient` instance. + +There might be a case when you need to provide your own `HttpClient`. For example, you would want to use `HttpClient` created by HTTP client factory. RestSharp allows you to do it by using additional constructors. These constructors are: + +```csharp +// Create a client using an existing HttpClient and RestClientOptions (optional) +public RestClient( + HttpClient httpClient, + RestClientOptions? options, + bool disposeHttpClient = false, + ConfigureSerialization? configureSerialization = null +) + +// Create a client using an existing HttpClient and optional RestClient configuration function +public RestClient( + HttpClient httpClient, + bool disposeHttpClient = false, + ConfigureRestClient? configureRestClient = null, + ConfigureSerialization? configureSerialization = null +) +``` + +The `disposeHttpClient` argument tells the client to dispose `HttpClient` when the client itself gets disposed. It's set to `false` by default as when the `HttpClient` is provided from the outside, it should normally be disposed on the outside as well. + +## Using custom message handler + +Unless you use an external instance of `HttpClient`, the `RestClient` creates one when being constructed, and it will use the default HTTP message handler, configured using `RestClientOptions`. Normally, you'd get a `SocketHttpHandler` with modern .NET, and `WinHttpHandler` with .NET Framework. + +There might be a case when you need to configure the HTTP message handler. For example, you want to add a delegating message handler. RestSharp allows you to do it by using additional constructors. There's one constructor that allows you to pass the custom `HttpMessageHandler`: + +```csharp +public RestClient( + HttpMessageHandler handler, + bool disposeHandler = true, + ConfigureRestClient? configureRestClient = null, + ConfigureSerialization? configureSerialization = null +) +``` + +This constructor will create a new `HttpClient` instance using the provided message handler. As RestSharp will dispose the `HttpClient` instance when the `RestClient` instance gets disposed, the handler will be disposed as well. If you want to change that and keep the handler, set the `disposeHandler` parameter to `false`. + +:::note +When using a custom message handler, RestSharp **will not** configure it with client options, which are normally used to configure the handler created by RestSharp. +::: + +Another way to customize the message handler is to allow RestSharp to create a handler, but then configure it, or wrap it in a delegating handler. It can be done by using the `RestClientOptions.ConfigureMessageHandler` property. It can be set to a function that receives the handler created by RestSharp and returned either the same handler with different settings, or a new handler. + +For example, if you want to use `MockHttp` and its handler for testing, you can do it like this: + +```csharp +var mockHttp = new MockHttpMessageHandler(); +// Configure the MockHttp handler to do the checks +... + +var options = new RestClientOptions(Url) { + ConfigureMessageHandler = _ => mockHttp +}; +using var client = new RestClient(options); +``` + +In this example, we are reassigning the handler to MockHttp, so the handler created by RestSharp isn't used. In other cases you want to use delegating handlers as middleware, so you'd pass the handler created by RestSharp to the delegating handler: + +```csharp +var options = new RestClientOptions(Url) { + ConfigureMessageHandler = handler => new MyDelegatingHandler(handler) +}; +using var client = new RestClient(options); +``` + +## Client options + +RestSharp allows configuring `RestClient` using client options, as mentioned at the beginning of this page. Below, you find more details about available options. + +| Option | Description | +|----------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| `BaseUrl` | Client base URL. It can also be provided as the `RestClientOptions` constructor argument. | +| `ConfigureMessageHandler` | Configures the HTTP message handler (see above). | +| `CalculateResponseStatus` | Function to calculate a different response status from `HttpResponseMessage`. By default, the request is considered as complete if it returns a successful status code or 404. | +| `Authenticator` | Client-level authenticator. Read more about authenticators [here](authenticators.md). | +| `Interceptors` | A collector of interceptors. Read more about interceptors [here](interceptors.md). | +| `Credentials` | Instance of `ICredentials` used for NTLM or Kerberos authentication. Not supported in browsers. | +| `UseDefaultCredentials` | Whether to use default OS credentials for NTLM or Kerberos authentication. Not supported in browsers. | +| `DisableCharset` | When set to `true`, the `Content-Type` header won't have the `charset` portion. Some older web servers don't understand the `charset` portion in the header and fail to process the request. | +| `AutomaticDecompression` | Allows customizing supported decompression methods. Default is `All` except for .NET Framework that only support `GZip`. Not supported in browsers. | +| `MaxRedirects` | The number of redirects to follow. Not supported in browsers. | +| `ClientCertificates` | A collection of X.509 client certificates to be used for authentication. Not supported in browsers. | +| `Proxy` | Can be used if the client needs to use an explicit, non-default proxy. Not supported in browsers, on iOS and tvOS. | +| `CachePolicy` | Shortcut for setting the default value for `Cache-Control` header. | +| `FollowRedirects` | Instructs the client to follow redirects. Default is `true`. | +| `Expect100Continue` | Gets or sets a value that indicates if the `Expect` header for an HTTP request contains `Continue`. | +| `UserAgent` | Allows overriding the default value for `User-Agent` header, which is `RestSharp/{version}`. | +| `PreAuthenticate` | Gets or sets a value that indicates whether the client sends an `Authorization` header with the request. Not supported in browsers. | +| `RemoteCertificateValidationCallback` | Custom function to validate the server certificate. Normally, it's used when the server uses a certificate that isn't trusted by default. | +| `BaseHost` | Value for the `Host` header sent with each request. | +| `CookieContainer` | Custom cookie container that will be shared among all calls made by the client. Normally not required as RestSharp handles cookies without using a client-level cookie container. | +| `MaxTimeout` | Client-level timeout in milliseconds. If the request timeout is also set, this value isn't used. | +| `Encoding` | Default request encoding. Override it only if you don't use UTF-8. | +| `ThrowOnDeserializationError` | Forces the client to throw if it fails to deserialize the response. Remember that not all deserialization issues forces the serializer to throw. Default is `false`, so the client will return a `RestResponse` with deserialization exception details. Only relevant for `Execute...` functions. | +| `FailOnDeserializationError` | When set to `true`, if the client fails to deserialize the response, the response object will have status `Failed`, although the HTTP calls might have been successful. Default is `true`. | +| `ThrowOnAnyError` | When set to `true`, the client will re-throw any exception from `HttpClient`. Default is `false`. Only applies for `Execute...` functions. | +| `AllowMultipleDefaultParametersWithSameName` | By default, adding parameters with the same name is not allowed. You can override this behaviour by setting this property to `true`. | +| `Encode` | A function to encode URLs, the default is a custom RestSharp function based on `Uri.EscapeDataString()`. Set it if you need a different way to do the encoding. | +| `EncodeQuery` | A function to encode URL query parameters. The default is the same function as for `Encode` property. | + +Some of the options are used by RestSharp code, but some are only used to configure the `HttpMessageHandler`. These options are: +- `Credentials` +- `UseDefaultCredentials` +- `AutomaticDecompression` +- `PreAuthenticate` +- `MaxRedirects` +- `RemoteCertificateValidationCallback` +- `ClientCertificates` +- `FollowRedirects` +- `Proxy` + +:::note +If setting these options to non-default values produce no desirable effect, check if your framework and platform supports them. RestSharp doesn't change behaviour based on values of those options. +::: + +The `IRestClient` interface exposes the `Options` property, so any option can be inspected at runtime. However, RestSharp converts the options object provided to the client constructor to an immutable object. Therefore, no client option can be changed after the client is instantiated. It's because changing client options at runtime can produce issues in concurrent environments, effectively rendering the client as not thread-safe. Apart from that, changing the options that are used to create the message handler would require re-creating the handler, and also `HttpClient`, which should not be done at runtime. + +## Configuring requests + +Client options apply to all requests made by the client. Sometimes, you want to fine-tune particular requests, so they execute with custom configuration. It's possible to do using properties of `RestRequest`, described below. + +| Name | Description | +|------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| `AlwaysMultipartFormData` | When set to `true`, the request will be sent as a multipart form, even though it's not required. By default, RestSharp only sends requests with multiple attachments as multipart forms. Default is `false`. | +| `AlwaysSingleFileAsContent` | When set to true, the request with file attachment will not be sent as a multipart form, but as plain content. Default is `false`. It cannot be set to `true` when `AlwaysMultipartFormData` is set to `true`, or when the request has `POST` parameters. | +| `MultipartFormQuoteBoundary` | Default is `true`, which means that the form boundary string will be wrapped in quotes. If the server has an issue with that, setting this to `false` will remove quotes around the boundary. | +| `FormBoundary` | Allows specifying a custom multipart form boundary instead of using the default random string. | +| `RequestParameters` | Collection of request parameters. Normally, you won't need to use it as parameters are added to the request using `Add...` functions. | +| `CookieContainer` | Custom request-level cookie container. Default is `null`. You can still set request cookies using `AddCookie` and get response cookies from the response object without using cooking container. | +| `Authenticator` | Overrides the client-level authenticator. | +| `Files` | Collection of file parameters, read-only. Use `AddFile` for adding files to the request. | +| `Method` | Request HTTP method, default is `GET`. Only needed when using `Execute` or `ExecuteAsync` as other functions like `ExecutePostAsync` will override the request method. | +| `TImeout` | Overrides the client-level timeout. | +| `Resource` | Resource part of the remote endpoint URL. For example, when using the client-level base URL `https://localhost:5000/api` and `Resource` set to `weather`, the request will be sent to `https://localhost:5000/api/weather`. It can container resource placeholders to be used in combination with `AddUrlSegment` | +| `RequestFormat` | Identifies the request as JSON, XML, binary, or none. Rarely used because the client will set the request format based on the body type if functions like `AddJsonBody` or `AddXmlBody` are used. | +| `RootElement` | Used by the default deserializers to determine where to start deserializing from. Only supported for XML responses. Does not apply to requests. | +| `OnBeforeDeserialization` | **Obsolete** A function to be called before the response is deserializer. Allows changing the content before calling the deserializer. Use [interceptors](interceptors.md) instead. | +| `OnBeforeRequest` | **Obsolete** A function to be called right before the request is executed by `HttpClient`. It receives an instance of `HttpRequestMessage`. Use [interceptors](interceptors.md) instead. | +| `OnAfterRequest` | **Obsolete** A function to be called right after the request is executed by `HttpClient`. It receives an instance of `HttpResponseMessage`. Use [interceptors](interceptors.md) instead. | +| `Attempts` | When the request is being resent to retry, the property value increases by one. | +| `CompletionOption` | Instructs the client on when it should consider the request to be completed. The default is `ResponseContentRead`. It is automatically changed to `ResponseHeadersRead` when using async download functions or streaming. | +| `CachePolicy` | Overrides the client cache policy. | +| `ResponseWriter` | Allows custom handling of the response stream. The function gets the raw response stream and returns another stream or `null`. Cannot be used in combination with `AdvancedResponseWriter`. | +| `AdvancedResponseWriter` | Allows custom handling of the response. The function gets an instance of `HttpResponseMessage` and an instance of `RestRequest`. It must return an instance of `RestResponse`, so it effectively overrides RestSharp default functionality for creating responses. | +| `Interceptors` | Allows adding interceptors to the request. Both client-level and request-level interceptors will be called. | + +The table below contains all configuration properties of `RestRequest`. To learn more about adding request parameters, check the [usage page](../usage/request.md) section about creating requests with parameters. diff --git a/docs/versioned_docs/version-v111/advanced/error-handling.md b/docs/versioned_docs/version-v111/advanced/error-handling.md new file mode 100644 index 000000000..7b3be11fc --- /dev/null +++ b/docs/versioned_docs/version-v111/advanced/error-handling.md @@ -0,0 +1,67 @@ +# Error handling + +If there is a network transport error (network is down, failed DNS lookup, etc), or any kind of server error (except 404), `RestResponse.ResponseStatus` will be set to `ResponseStatus.Error`, otherwise it will be `ResponseStatus.Completed`. + +If an API returns a 404, `ResponseStatus` will still be `Completed`. If you need access to the HTTP status code returned you will find it at `RestResponse.StatusCode`. +The `Status` property is an indicator of completion independent of the API error handling. + +Normally, RestSharp doesn't throw an exception if the request fails. + +However, it is possible to configure RestSharp to throw in different situations, when it normally doesn't throw +in favour of giving you the error as a property. + +| Property | Behavior | +|-------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| `FailOnDeserializationError` | Changes the default behavior when failed deserialization results in a successful response with an empty `Data` property of the response. Setting this property to `true` will tell RestSharp to consider failed deserialization as an error and set the `ResponseStatus` to `Error` accordingly. | +| `ThrowOnDeserializationError` | Changes the default behavior when failed deserialization results in empty `Data` property of the response. Setting this property to `true` will tell RestSharp to throw when deserialization fails. | +| `ThrowOnAnyError` | Setting this property to `true` changes the default behavior and forces RestSharp to throw if any errors occurs when making a request or during deserialization. | + +Those properties are available for the `RestClientOptions` and will be used for all request made with the client instance. + +For example, you can configure the client to throw an exception if any error occurs when making a request, or when a request returns a non-successful HTTP status code: + +```csharp +var options = new RestClientOptions(url) { + ThrowOnAnyError = true +}; +var client = new RestClient(options); +var request = new RestRequest("resource/{id}").AddUrlSegment("id", 123); +// 👇 will throw if the request fails +var response = await client.ExecuteGetAsync(request); +``` + +:::warning +Please be aware that deserialization failures will only work if the serializer throws an exception when deserializing the response. +Many serializers don't throw by default, and just return a `null` result. RestSharp is unable to figure out why `null` is returned, so it won't fail in this case. +Check the serializer documentation to find out if it can be configured to throw on deserialization error. +::: + +There are also slight differences on how different overloads handle exceptions. + +Asynchronous generic methods `GetAsync`, `PostAsync` and so on, which aren't a part of `RestClient` interface (those methods are extension methods) return `Task`. It means that there's no `RestResponse` to set the response status to error. We decided to throw an exception when such a request fails. It is a trade-off between the API consistency and usability of the library. Usually, you only need the content of `RestResponse` instance to diagnose issues and most of the time the exception would tell you what's wrong. + +Below, you can find how different extensions deal with errors. Note that functions, which don't throw by default, will throw exceptions when `ThrowOnAnyError` is set to `true`. + +| Function | Throws on errors | +|:----------------------|:-----------------| +| `ExecuteAsync` | No | +| `ExecuteGetAsync` | No | +| `ExecuteGetAsync` | No | +| `ExecutePostAsync` | No | +| `ExecutePostAsync` | No | +| `ExecutePutAsync` | No | +| `ExecutePutAsync` | No | +| `GetAsync` | Yes | +| `GetAsync` | Yes | +| `PostAsync` | Yes | +| `PostAsync` | Yes | +| `PatchAsync` | Yes | +| `PatchAsync` | Yes | +| `DeleteAsync` | Yes | +| `DeleteAsync` | Yes | +| `OptionsAsync` | Yes | +| `OptionsAsync` | Yes | +| `HeadAsync` | Yes | +| `HeadAsync` | Yes | + +In addition, all the functions for JSON requests, like `GetJsonAsync` and `PostJsonAsync` throw an exception if the HTTP call fails. diff --git a/docs/versioned_docs/version-v111/advanced/interceptors.md b/docs/versioned_docs/version-v111/advanced/interceptors.md new file mode 100644 index 000000000..a3bf7a9bc --- /dev/null +++ b/docs/versioned_docs/version-v111/advanced/interceptors.md @@ -0,0 +1,84 @@ +--- +title: Interceptors +--- + +## Intercepting requests and responses + +Interceptors are a powerful feature of RestSharp that allows you to modify requests and responses before they are sent or received. You can use interceptors to add headers, modify the request body, or even cancel the request. You can also use interceptors to modify the response before it is returned to the caller. + +### Implementing an interceptor + +To implement an interceptor, you need to create a class that inherits the `Interceptor` base class. The base class implements all interceptor methods as virtual, so you can override them in your derived class. + +Methods that you can override are: +- `BeforeRequest(RestRequest request, CancellationToken cancellationToken)` +- `AfterRequest(RestResponse response, CancellationToken cancellationToken)` +- `BeforeHttpRequest(HttpRequestMessage requestMessage, CancellationToken cancellationToken)` +- `AfterHttpRequest(HttpResponseMessage responseMessage, CancellationToken cancellationToken)` +- `BeforeDeserialization(RestResponse response, CancellationToken cancellationToken)` + +All those functions must return a `ValueTask` instance. + +Here's an example of an interceptor that adds a header to a request: + +```csharp +// This interceptor adds a header to the request +// You'd not normally use this interceptor, as RestSharp already has a method +// to add headers to the request +class HeaderInterceptor(string headerName, string headerValue) : Interceptors.Interceptor { + public override ValueTask BeforeHttpRequest(HttpRequestMessage requestMessage, CancellationToken cancellationToken) { + requestMessage.Headers.Add(headerName, headerValue); + return ValueTask.CompletedTask; + } +} +``` + +Because interceptor functions return `ValueTask`, you can use `async` and `await` inside them. + +### Using an interceptor + +It's possible to add as many interceptors as you want, both to the client and to the request. The interceptors are executed in the order they were added. + +Adding interceptors to the client is done via the client options: + +```csharp +var options = new RestClientOptions("https://api.example.com") { + Interceptors = [new HeaderInterceptor("Authorization", token)] +}; +var client = new RestClient(options); +``` + +When you add an interceptor to the client, it will be executed for every request made by that client. + +You can also add an interceptor to a specific request: + +```csharp +var request = new RestRequest("resource") { + Interceptors = [new HeaderInterceptor("Authorization", token)] +}; +``` + +In this case, the interceptor will only be executed for that specific request. + +### Deprecation notice + +Interceptors aim to replace the existing request hooks available in RestSharp prior to version 111.0. Those hooks are marked with `Obsolete` attribute and will be removed in the future. If you are using those hooks, we recommend migrating to interceptors as soon as possible. + +To make the migration easier, RestSharp provides a class called `CompatibilityInterceptor`. It has properties for the hooks available in RestSharp 110.0 and earlier. You can use it to migrate your code to interceptors without changing the existing logic. + +For example, a code that uses `OnBeforeRequest` hook: + +```csharp +var request = new RestRequest("success"); +request.OnBeforeDeserialization += _ => throw new Exception(exceptionMessage); +``` + +Can be migrated to interceptors like this: + +```csharp +var request = new RestRequest("success") { + Interceptors = [new CompatibilityInterceptor { + OnBeforeDeserialization = _ => throw new Exception(exceptionMessage) + }] +}; +``` \ No newline at end of file diff --git a/docs/versioned_docs/version-v111/advanced/serialization.md b/docs/versioned_docs/version-v111/advanced/serialization.md new file mode 100644 index 000000000..b7092519a --- /dev/null +++ b/docs/versioned_docs/version-v111/advanced/serialization.md @@ -0,0 +1,148 @@ +# Serialization + +One of the most common reasons to choose RestSharp over plain `HttpClient` is its rich build-in serialization support. RestSharp allows adding complex objects as request body to be serialized when making a call to an API endpoint, and deserializing the response to a given .NET type. RestSharp supports JSON and XML serialization and deserialization by default. In addition, you can use a CSV serializer or write your own. + +In contrast to `System.Net.Http.Json` package that contains `HttpClient` extensions to make `GET` or `POST` calls using JSON, RestSharp support JSON responses for all HTTP methods, not just for `GET`. + +## Configuration + +:::tip +The default behavior of RestSharp is to swallow deserialization errors and return `null` in the `Data` +property of the response. Read more about it in the [Error Handling](error-handling.md). +::: + +You can tell RestSharp to use a custom serializer by using the `configureSerialization` constructor parameter: + +```csharp +var client = new RestClient( + options, + configureSerialization: s => s.UseSerializer(() => new CustomSerializer()); +); +``` + +All RestSharp serializers implement the `IRestSerializer` interface. Among other things, the interface requires implementing the `AcceptedContentTypes` property, which must return a collection of content types supported by the serializer. Being configured to use certain serializers, RestSharp populates the `Accept` header accordingly, so it doesn't need to be set manually. + +When making a call, RestSharp sets the request content type according to the request body type. For example, when you use `AddJsonBody`, the content type is set to `application/json`. Normally, you won't need to set the `Content-Type` header manually. If you need to set a custom content type for a JSON call, you can use the optional `contentType` argument of `AddJsonBody`, for example: + +```csharp +request.AddJsonBody(data, "text/json"); +``` + +## JSON + +The default JSON serializer uses `System.Text.Json`, which is a part of .NET since .NET 6. For earlier versions, it is added as a dependency. There are also a few serializers provided as additional packages. + +By default, RestSharp will use `JsonSerializerDefaults.Web` configuration. If necessary, you can specify your own options: + +```csharp +var client = new RestClient( + options, + configureSerialization: s => s.UseSystemTextJson(new JsonSerializerOptions {...}) +); +``` + +## XML + +The default XML serializer is `DotNetXmlSerializer`, which uses `System.Xml.Serialization` library from .NET. + +In previous versions of RestSharp, the default XML serializer was a custom RestSharp XML serializer. To make the code library size smaller, that serializer is now available as a separate package [`RestSharp.Serializers.Xml`](https://www.nuget.org/packages/RestSharp.Serializers.Xml). +You can add it back if necessary by installing the package and adding it to the client: + +```csharp +var client = new RestClient( + options, + configureSerialization: s => s.UseXmlSerializer() +); +``` + +As before, you can supply three optional arguments for a custom namespace, custom root element, and if you want to use `SerializeAs` and `DeserializeAs` attributed. + +## NewtonsoftJson (aka Json.Net) + +The `NewtonsoftJson` package is the most popular JSON serializer for .NET. It handles all possible scenarios and is very configurable. Such a flexibility comes with the cost of performance. If you need speed, keep the default JSON serializer. + +RestSharp support Json.Net serializer via a separate package [`RestSharp.Serializers.NewtonsoftJson`](https://www.nuget.org/packages/RestSharp.Serializers.NewtonsoftJson). + +:::warning +Please note that `RestSharp.Newtonsoft.Json` package is not provided by RestSharp, is marked as obsolete on NuGet, and no longer supported by its creator. +::: + +Use the extension method provided by the package to configure the client: + +```csharp +var client = new RestClient( + options, + configureSerialization: s => s.UseNewtonsoftJson() +); +``` + +The serializer configures some options by default: + +```csharp +JsonSerializerSettings DefaultSettings = new JsonSerializerSettings { + ContractResolver = new CamelCasePropertyNamesContractResolver(), + DefaultValueHandling = DefaultValueHandling.Include, + TypeNameHandling = TypeNameHandling.None, + NullValueHandling = NullValueHandling.Ignore, + Formatting = Formatting.None, + ConstructorHandling = ConstructorHandling.AllowNonPublicDefaultConstructor +}; +``` + +If you need to use different settings, you can supply your instance of +`JsonSerializerSettings` as a parameter for the extension method. + +## CSV + +A separate package `RestSharp.Serializers.CsvHelper` provides a CSV serializer for RestSharp. It is based on the +`CsvHelper` library. + +Use the extension method provided by the package to configure the client: + +```csharp +var client = new RestClient( + options, + configureSerialization: s => s.UseCsvHelper() +); +``` + +You can also supply your instance of `CsvConfiguration` as a parameter for the extension method. + +```csharp +var client = new RestClient( + options, + configureSerialization: s => s.UseCsvHelper( + new CsvConfiguration(CultureInfo.InvariantCulture) {...} + ) +); +``` + +## Custom + +You can also implement your custom serializer. To support both serialization and +deserialization, you must implement the `IRestSerializer` interface. + +Here is an example of a custom serializer that uses `System.Text.Json`: + +```csharp +public class SimpleJsonSerializer : IRestSerializer { + public string? Serialize(object? obj) => obj == null ? null : JsonSerializer.Serialize(obj); + + public string? Serialize(Parameter bodyParameter) => Serialize(bodyParameter.Value); + + public T? Deserialize(RestResponse response) => JsonSerializer.Deserialize(response.Content!); + + public ContentType ContentType { get; set; } = ContentType.Json; + + public ISerializer Serializer => this; + public IDeserializer Deserializer => this; + public DataFormat DataFormat => DataFormat.Json; + public string[] AcceptedContentTypes => ContentType.JsonAccept; + public SupportsContentType SupportsContentType + => contentType => contentType.Value.EndsWith("json", StringComparison.InvariantCultureIgnoreCase); +} +``` + +The `SupportedContentTypes` function will be used to check if the serializer is able to deserialize the response based on the `Content-Type` response header. + +The `ContentType` property will be used when making a request so the server knows how to handle the payload. diff --git a/docs/versioned_docs/version-v111/changelog.md b/docs/versioned_docs/version-v111/changelog.md new file mode 100644 index 000000000..3fc2ca63f --- /dev/null +++ b/docs/versioned_docs/version-v111/changelog.md @@ -0,0 +1,49 @@ +--- +title: What's new +description: List of changes for the current major version +sidebar_position: 2 +--- + +# Changelog + +This changelog is only maintained since v111. For release notes of previous versions, please check the [Releases page](https://github.com/restsharp/RestSharp/releases) in RestSharp GitHub repository. + +Only the most important or breaking changes are listed there. All other changes can be found in each release on GitHub. + +## v111.3 + +New extensions: +* `RestResponse.GetHeader` for getting one response header value +* `RestResponse.GetHeaders` for getting a collection of header values +* `IRestClient.(Execute)Get(Async)` with string resource instead of a request object +* `IRestClient.(Execute)Delete(Async)` with string resource instead of a request object + +[Full changelog](https://github.com/restsharp/RestSharp/releases/tag/111.3.0) + +## v111.2 + +* `Execute` extensions that were accidentally removed from v111 are back +* Several authenticators got renamed by unintentional refactoring, that change has also been reverted. + +[Full changelog](https://github.com/restsharp/RestSharp/releases/tag/111.2.0) + +## v111.0 + +:::warning +Package for v111.0 and v111.1 are listed as unsupported on NuGet as there are API changes that weren't planned. +Use the patched version v111.2 or later. +::: + +### Breaking changes +* Client option `MaxTimeout` renamed to `Timeout` and changed type to `Timespan` for clarity. It doesn't configure the `HttpClient` timeout anymore. Instead, the same method is used for client and request level timeouts with cancellation tokens. +* Request option `Timeout` changed type to `Timespan` for clarity. + +### New features +* Added [interceptors](advanced/interceptors.md). +* As interceptors provide a better way to interject the request and response execution flow, request properties `OnBeforeRequest`, `OnBeforeDeserialization` and `OnAfterRequest` are marked obsolete and will be removed in future versions. +* Added .NET 8 target. +* Support for uploading files as content without multipart form. +* Added `CacheControl` options to client and requests. +* Allow using `AddJsonBody` to serialize top-level strings. + +[Full changelog](https://github.com/restsharp/RestSharp/releases/tag/111.0.0) \ No newline at end of file diff --git a/docs/versioned_docs/version-v111/intro.md b/docs/versioned_docs/version-v111/intro.md new file mode 100644 index 000000000..8144a61cd --- /dev/null +++ b/docs/versioned_docs/version-v111/intro.md @@ -0,0 +1,112 @@ +--- +sidebar_position: 1 +title: Quick start +--- + +## Introduction + +:::warning +RestSharp v107+ changes the library API surface and its behaviour significantly. We advise looking at [migration](/migration) docs to understand how to migrate to the latest version of RestSharp. +::: + +The main purpose of RestSharp is to make synchronous and asynchronous calls to remote resources over HTTP. As the name suggests, the main audience of RestSharp are developers who use REST APIs. However, RestSharp can call any API over HTTP, as long as you have the resource URI and request parameters that you want to send comply with W3C HTTP standards. + +One of the main challenges of using HTTP APIs for .NET developers is to work with requests and responses of different kinds and translate them to complex C# types. RestSharp can take care of serializing the request body to JSON or XML and deserialize the response. It can also form a valid request URI based on different parameter kinds: path, query, form or body. + +## Getting Started + +Before you can use RestSharp in your application, you need to add the NuGet package. You can do it using your IDE or the command line: + +``` +dotnet add package RestSharp +``` + +### Basic Usage + +If you only have a small number of one-off API requests to perform, you can use RestSharp like this: + +```csharp +using RestSharp; +using RestSharp.Authenticators; + +var options = new RestClientOptions("https://api.twitter.com/1.1") { + Authenticator = new HttpBasicAuthenticator("username", "password") +}; +var client = new RestClient(options); +var request = new RestRequest("statuses/home_timeline.json"); +// The cancellation token comes from the caller. You can still make a call without it. +var response = await client.GetAsync(request, cancellationToken); +``` + +It will return a `RestResponse` back, which contains all the information returned from the remote server. +You have access to the headers, content, HTTP status and more. + +You can also use generic overloads like `Get` to automatically deserialize the response into a .NET class. + +For example: + +```csharp +using RestSharp; +using RestSharp.Authenticators; + +var options = new RestClientOptions("https://api.twitter.com/1.1") { + Authenticator = new HttpBasicAuthenticator("username", "password") +}; +var client = new RestClient(options); + +var request = new RestRequest("statuses/home_timeline.json"); + +// The cancellation token comes from the caller. You can still make a call without it. +var timeline = await client.GetAsync(request, cancellationToken); +``` + +Both snippets above use the `GetAsync` extension, which is a wrapper about `ExecuteGetAsync`, which, in turn, is a wrapper around `ExecuteAsync`. +All `ExecuteAsync` overloads and return the `RestResponse` or `RestResponse`. + +The most important difference is that async methods named after HTTP methods (like `GetAsync` or `PostAsync`) return `Task` instead of `Task>`. It means that you won't get an error response if the request fails as those methods throw an exception for unsuccessful HTTP calls. For keeping the API consistent, non-generic functions like `GetAsync` or `PostAsync` also throw an exception if the request fails, although they return the `Task`. + +Read [here](advanced/error-handling.md) about how RestSharp handles exceptions. + +RestSharp also offers simple ways to call APIs that accept and return JSON payloads. You can use the `GetJsonAsync` and `PostJsonAsync` extension methods, which will automatically serialize the request body to JSON and deserialize the response to the specified type. + +```csharp +var client = new RestClient(options); +var timeline = await client.GetJsonAsync("statuses/home_timeline.json", cancellationToken); +``` + +Read [here](usage/execute#json-requests) about making JSON calls without preparing a request object. + +### Content type + +RestSharp supports sending XML or JSON body as part of the request. To add a body to the request, simply call `AddJsonBody` or `AddXmlBody` method of the `RestRequest` object. + +There is no need to set the `Content-Type` or add the `DataFormat` parameter to the request when using those methods, RestSharp will do it for you. + +RestSharp will also handle both XML and JSON responses and perform all necessary deserialization tasks, depending on the server response type. Therefore, you only need to add the `Accept` header if you want to deserialize the response manually. + +For example, you'd only need these lines to make a request with JSON body: + +```csharp +var request = new RestRequest("address/update").AddJsonBody(updatedAddress); +var response = await client.PostAsync(request); +``` + +It's also possible to make the same call using `PostAsync` shorter syntax: + +```csharp +var response = await PostJsonAsync( + "address/update", request, cancellationToken +); +``` + +Read more about serialization and deserialization [here](advanced/serialization.md). + +### Response + +When you use `ExecuteAsync`, you get an instance of `RestResponse` back. The response object has the `Content` property, which contains the response as string. You can find other useful properties there, like `StatusCode`, `ContentType` and so on. If the request wasn't successful, you'd get a response back with `IsSuccessful` property set to `false` and the error explained in the `ErrorException` and `ErrorMessage` properties. + +When using typed `ExecuteAsync`, you get an instance of `RestResponse` back, which is identical to `RestResponse` but also contains the `T Data` property with the deserialized response. + +None of `ExecuteAsync` overloads throw if the remote server returns an error. You can inspect the response and find the status code, error message, and, potentially, an exception. + +Extensions like `GetAsync` will not return the whole `RestResponse` but just a deserialized response. These extensions will throw an exception if the remote server returns an error. The exception details contain the status code returned by the server. diff --git a/docs/versioned_docs/version-v111/usage/_category_.json b/docs/versioned_docs/version-v111/usage/_category_.json new file mode 100644 index 000000000..bd2045cd6 --- /dev/null +++ b/docs/versioned_docs/version-v111/usage/_category_.json @@ -0,0 +1,7 @@ +{ + "label": "Using RestSharp", + "position": 3, + "link": { + "type": "generated-index" + } +} diff --git a/docs/versioned_docs/version-v111/usage/basics.md b/docs/versioned_docs/version-v111/usage/basics.md new file mode 100644 index 000000000..6bbb5594a --- /dev/null +++ b/docs/versioned_docs/version-v111/usage/basics.md @@ -0,0 +1,23 @@ +--- +sidebar_position: 2 +--- + +# RestSharp basics + +This page describes some of the essential properties and features of RestSharp. + +## What RestSharp does + +Essentially, RestSharp is a wrapper around `HttpClient` that allows you to do the following: +- Add default parameters of any kind (not just headers) to the client, once +- Add parameters of any kind to each request (query, URL segment, form, attachment, serialized body, header) in a straightforward way +- Serialize the payload to JSON or XML if necessary +- Set the correct content headers (content type, disposition, length, etc.) +- Handle the remote endpoint response +- Deserialize the response from JSON or XML if necessary + +## API client + +The best way to call an external HTTP API is to create a typed client, which encapsulates RestSharp calls and doesn't expose the `RestClient` instance in public. + +You can find an example of a Twitter API client on the [Example](example.md) page. diff --git a/docs/versioned_docs/version-v111/usage/client.md b/docs/versioned_docs/version-v111/usage/client.md new file mode 100644 index 000000000..0207c3e25 --- /dev/null +++ b/docs/versioned_docs/version-v111/usage/client.md @@ -0,0 +1,114 @@ +--- +sidebar_position: 3 +title: Creating the client +--- + +## Constructors + +A RestSharp client can be instantiated by one of its constructors. Two most commonly used constructors are: + +#### Only specify the base URL + +You can create an instance of `RestClient` with only a single parameter: the base URL. Even that isn't required as base URL can be left empty. In that case, you'd need to specify the absolute path for each call. When the base URL is set, you can use both relative and absolute path. + +```csharp +// Creates a client with default options to call a given base URL +var client = new RestClient("https://localhost:5000"); +``` + +#### Provide client options + +The most common way to create a client is to use the constructor with options. The options object has the type of `RestClientOptions`. +Here's an example of how to create a client using the same base path as in the previous sample, but with a couple additional settings: + +```csharp +// Creates a client using the options object +var options = new RestClientOptions("https://localhost:5000") { + MaxTimeout = 1000 +}; +var client = new RestClient(options); +``` + +#### Advanced configuration + +RestSharp can be configured with more tweaks, including default request options, how it should handle responses, how serialization works, etc. You can also provide your own instance of `HttpClient` or `HttpMessageHandler`. + +Read more about the advanced configuration of RestSharp on a [dedicated page](../advanced/configuration.md). + +## Simple factory + +Another way to create the client instance is to use a simple client factory. The factory will use the `BaseUrl` property of the client options to cache `HttpClient` instances. Every distinct base URL will get its own `HttpClient` instance. Other options don't affect the caching. Therefore, if you use different options for the same base URL, you'll get the same `HttpClient` instance, which will not be configured with the new options. Options that aren't applied _after_ the first client instance is created are: + +* `Credentials` +* `UseDefaultCredentials` +* `AutomaticDecompression` +* `PreAuthenticate` +* `FollowRedirects` +* `RemoteCertificateValidationCallback` +* `ClientCertificates` +* `MaxRedirects` +* `MaxTimeout` +* `UserAgent` +* `Expect100Continue` + +Constructor parameters to configure the `HttpMessageHandler` and default `HttpClient` headers configuration are also ignored for the cached instance as the factory only configures the handler once. + +You need to set the `useClientFactory` parameter to `true` in the `RestClient` constructor to enable the factory. + +```csharp +var client = new RestClient("https://api.twitter.com/2", true); +``` + +## Reusing HttpClient + +RestSharp uses `HttpClient` internally to make HTTP requests. It's possible to reuse the same `HttpClient` instance for multiple `RestClient` instances. This is useful when you want to share the same connection pool between multiple `RestClient` instances. + +One way of doing it is to use `RestClient` constructors that accept an instance of `HttpClient` or `HttpMessageHandler` as an argument. Note that in that case not all the options provided via `RestClientOptions` will be used. Here is the list of options that will work: + +- `BaseAddress` is be used to set the base address of the `HttpClient` instance if base address is not set there already. +- `MaxTimeout` is used to cancel the call using the cancellation token source, so +- `UserAgent` will be added to the `RestClient.DefaultParameters` list as a HTTP header. This will be added to each request made by the `RestClient`, and the `HttpClient` instance will not be modified. This is to allow the `HttpClient` instance to be reused for scenarios where different `User-Agent` headers are required. +- `Expect100Continue` + +Another option is to use a simple HTTP client factory as described [above](#simple-factory). + +## Blazor support + +Inside a Blazor webassembly app, you can make requests to external API endpoints. Microsoft examples show how to do it with `HttpClient`, and it's also possible to use RestSharp for the same purpose. + +You need to remember that webassembly has some platform-specific limitations. Therefore, you won't be able to instantiate `RestClient` using all of its constructors. In fact, you can only use `RestClient` constructors that accept `HttpClient` or `HttpMessageHandler` as an argument. If you use the default parameterless constructor, it will call the option-based constructor with default options. The options-based constructor will attempt to create an `HttpMessageHandler` instance using the options provided, and it will fail with Blazor, as some of those options throw thw "Unsupported platform" exception. + +Here is an example how to register the `RestClient` instance globally as a singleton: + +```csharp +builder.Services.AddSingleton(new RestClient(new HttpClient())); +``` + +Then, on a page you can inject the instance: + +```html +@page "/fetchdata" +@using RestSharp +@inject RestClient _restClient +``` + +And then use it: + +```csharp +@code { + private WeatherForecast[]? forecasts; + + protected override async Task OnInitializedAsync() { + forecasts = await _restClient.GetJsonAsync("http://localhost:5104/weather"); + } + + public class WeatherForecast { + public DateTime Date { get; set; } + public int TemperatureC { get; set; } + public string? Summary { get; set; } + public int TemperatureF => 32 + (int)(TemperatureC / 0.5556); + } +} +``` + +In this case, the call will be made to a WebAPI server hosted at `http://localhost:5104/weather`. Remember that if the WebAPI server is not hosting the webassembly itself, it needs to have a CORS policy configured to allow the webassembly origin to access the API endpoint from the browser. diff --git a/docs/versioned_docs/version-v111/usage/example.md b/docs/versioned_docs/version-v111/usage/example.md new file mode 100644 index 000000000..3e1bc8ec2 --- /dev/null +++ b/docs/versioned_docs/version-v111/usage/example.md @@ -0,0 +1,152 @@ +--- +sidebar_position: 1 +--- + +# Example + +RestSharp works best as the foundation for a proxy class for your API. Each API would most probably require different settings for `RestClient`. Hence, a dedicated API class (and its interface) gives you sound isolation between different `RestClient` instances and make them testable. + +For example, let's look at a simple Twitter API v2 client, which uses OAuth2 machine-to-machine authentication. For it to work, you would need to have access to the Twitter Developers portal, a project, and an approved application inside the project with OAuth2 enabled. + +## Client model + +Before implementing an API client, we need to have a model for it. The model includes an abstraction for the client, which has functions for the API calls we are interested to implement. In addition, the client model would include the necessary request and response models. Usually those are simple classes or records without logic, which are often referred to as DTOs (data transfer objects). + +This example starts with a single function that retrieves one Twitter user. Let's begin by defining the API client interface: + +```csharp +public interface ITwitterClient { + Task GetUser(string user); +} +``` + +As the function returns a `TwitterUser` instance, we need to define it as a model: + +```csharp +public record TwitterUser(string Id, string Name, string Username); +``` + +## Client implementation + +When that is done, we can implement the interface and add all the necessary code blocks to get a working API client. + +The client class needs the following: +- A constructor for passing API credentials +- A wrapped `RestClient` instance with the Twitter API base URI pre-configured +- An authenticator to support authorizing the client using Twitter OAuth2 authentication +- The actual function to get the user (to implement the `ITwitterClient` interface) + +Creating an authenticator is described [below](#authenticator). + +Here's how the client implementation could look like: + +```csharp +public class TwitterClient : ITwitterClient, IDisposable { + readonly RestClient _client; + + public TwitterClient(string apiKey, string apiKeySecret) { + var options = new RestClientOptions("https://api.twitter.com/2"); + _client = new RestClient(options); + } + + public async Task GetUser(string user) { + var response = await _client.GetAsync>( + "users/by/username/{user}", + new { user } + ); + return response!.Data; + } + + record TwitterSingleObject(T Data); + + public void Dispose() { + _client?.Dispose(); + GC.SuppressFinalize(this); + } +} +``` + +It is also possible to use ASP.NET Core Options for configuring the client, instead of passing the credentials as strings. For example, we can add a class for Twitter client options, and use it in a constructor: + +```csharp +public class TwitterClientOptions(string ApiKey, string ApiSecret); + +public TwitterClient(IOptions options) { + var opt = new RestClientOptions("https://api.twitter.com/2"); + _client = new RestClient(opt); +} +``` + +Then, you can register and configure the client using ASP.NET Core dependency injection container. + +Right now, the client won't really work as Twitter API requires authentication. It's covered in the next section. + +## Authenticator + +Before we can call the API itself, we need to get a bearer token. Twitter exposes an endpoint `https://api.twitter.com/oauth2/token`. As it follows the OAuth2 conventions, the code can be used to create an authenticator for some other vendors. + +First, we need a model for deserializing the token endpoint response. OAuth2 uses snake case for property naming, so we need to decorate model properties with `JsonPropertyName` attribute: + +```csharp +record TokenResponse { + [JsonPropertyName("token_type")] + public string TokenType { get; init; } + [JsonPropertyName("access_token")] + public string AccessToken { get; init; } +} +``` + +Next, we create the authenticator itself. It needs the API key and API key secret to call the token endpoint using basic HTTP authentication. In addition, we can extend the list of parameters with the base URL to convert it to a more generic OAuth2 authenticator. + +The easiest way to create an authenticator is to inherit from the `AuthenticatorBase` base class: + +```csharp +public class TwitterAuthenticator : AuthenticatorBase { + readonly string _baseUrl; + readonly string _clientId; + readonly string _clientSecret; + + public TwitterAuthenticator(string baseUrl, string clientId, string clientSecret) : base("") { + _baseUrl = baseUrl; + _clientId = clientId; + _clientSecret = clientSecret; + } + + protected override async ValueTask GetAuthenticationParameter(string accessToken) { + Token = string.IsNullOrEmpty(Token) ? await GetToken() : Token; + return new HeaderParameter(KnownHeaders.Authorization, Token); + } +} +``` + +During the first call made by the client using the authenticator, it will find out that the `Token` property is empty. It will then call the `GetToken` function to get the token once and reuse the token going forward. + +Now, we need to implement the `GetToken` function in the class: + +```csharp +async Task GetToken() { + var options = new RestClientOptions(_baseUrl){ + Authenticator = new HttpBasicAuthenticator(_clientId, _clientSecret), + }; + using var client = new RestClient(options); + + var request = new RestRequest("oauth2/token") + .AddParameter("grant_type", "client_credentials"); + var response = await client.PostAsync(request); + return $"{response!.TokenType} {response!.AccessToken}"; +} +``` + +As we need to make a call to the token endpoint, we need our own short-lived instance of `RestClient`. Unlike the actual Twitter client, it will use the `HttpBasicAuthenticator` to send the API key and secret as the username and password. The client then gets disposed as we only use it once. + +Here we add a POST parameter `grant_type` with `client_credentials` as its value. At the moment, it's the only supported value. + +The POST request will use the `application/x-www-form-urlencoded` content type by default. + +::: note +Sample code provided on this page is a production code. For example, the authenticator might produce undesired side effect when multiple requests are made at the same time when the token hasn't been obtained yet. It can be solved rather than simply using semaphores or synchronized invocation. +::: + +## Final words + +This page demonstrates how an API client can be implemented as a typed, configurable client with its own interface. Usage of the client in applications is not covered here as different application types and target frameworks have their own idiomatic ways to use HTTP clients. diff --git a/docs/versioned_docs/version-v111/usage/execute.md b/docs/versioned_docs/version-v111/usage/execute.md new file mode 100644 index 000000000..36343f793 --- /dev/null +++ b/docs/versioned_docs/version-v111/usage/execute.md @@ -0,0 +1,172 @@ +--- +sidebar_position: 5 +title: Making calls +--- + +## Executing requests + +Once you've added all the parameters to your `RestRequest`, you are ready to make a request. + +`RestClient` has a single function for this: + +```csharp +public async Task ExecuteAsync( + RestRequest request, + CancellationToken cancellationToken = default +) +``` + +You can also avoid setting the request method upfront and use one of the overloads: + +```csharp +Task ExecuteGetAsync(RestRequest request, CancellationToken cancellationToken) +Task ExecutePostAsync(RestRequest request, CancellationToken cancellationToken) +Task ExecutePutAsync(RestRequest request, CancellationToken cancellationToken) +Task ExecuteDeleteAsync(RestRequest request, CancellationToken cancellationToken) +Task ExecuteHeadAsync(RestRequest request, CancellationToken cancellationToken) +Task ExecuteOptionsAsync(RestRequest request, CancellationToken cancellationToken) +``` + +When using any of those methods, you will get the response content as string in `response.Content`. + +RestSharp can deserialize the response for you. To use that feature, use one of the generic overloads: + +```csharp +Task> ExecuteAsync(RestRequest request, CancellationToken cancellationToken) +Task> ExecuteGetAsync(RestRequest request, CancellationToken cancellationToken) +Task> ExecutePostAsync(RestRequest request, CancellationToken cancellationToken) +Task> ExecutePutAsync(RestRequest request, CancellationToken cancellationToken) +Task> ExecuteDeleteAsync(RestRequest request, CancellationToken cancellationToken) +Task> ExecuteHeadAsync(RestRequest request, CancellationToken cancellationToken) +Task> ExecuteOptionsAsync(RestRequest request, CancellationToken cancellationToken) +``` + +:::note Beware of errors +All the overloads with names starting with `Execute` don't throw an exception if the server returns an error. Read more about it [here](../advanced/error-handling.md). +It allows you to inspect responses and handle remote server errors gracefully. Overloads without `Execute` prefix throw exceptions in case of any error, so you'd need to ensure to handle exceptions properly. +::: + +If you just need a deserialized response, you can use one of the extensions: + +```csharp +Task GetAsync(RestRequest request, CancellationToken cancellationToken) +Task PostAsync(RestRequest request, CancellationToken cancellationToken) +Task PutAsync(RestRequest request, CancellationToken cancellationToken) +Task PatchAsync(RestRequest request, CancellationToken cancellationToken) +Task DeleteAsync(RestRequest request, CancellationToken cancellationToken) +Task HeadAsync(RestRequest request, CancellationToken cancellationToken) +Task OptionsAsync(RestRequest request, CancellationToken cancellationToken) +``` + +Those extensions will throw an exception if the server returns an error, as there's no other way to float the error back to the caller. + +The `IRestClient` interface also has extensions for making requests without deserialization, which throw an exception if the server returns an error even if the client is configured to not throw exceptions. + +```csharp +Task GetAsync(RestRequest request, CancellationToken cancellationToken) +Task PostAsync(RestRequest request, CancellationToken cancellationToken) +Task PutAsync(RestRequest request, CancellationToken cancellationToken) +Task PatchAsync(RestRequest request, CancellationToken cancellationToken) +Task DeleteAsync(RestRequest request, CancellationToken cancellationToken) +Task HeadAsync(RestRequest request, CancellationToken cancellationToken) +Task OptionsAsync(RestRequest request, CancellationToken cancellationToken) +``` + +### Sync calls + +The preferred way for making requests is to execute them asynchronously as HTTP calls are IO-bound operations. +If you are unable to make async calls, all the functions about have sync overloads, which have the same names without `Async` suffix. +For example, for making a sync `GET` call you can use `ExecuteGet(request)` or `Get`, etc. + +## Requests without body + +Some HTTP methods don't suppose to be used with request body. For those methods, RestSharp supports making simplified calls without using `RestRequest`. All you need is to provide the resource path as a string. + +For example, you can make a `DELETE` call like this: + +```csharp +var response = await client.ExecuteDeleteAsync($"order/delete/{orderId}", cancellationToken); +``` + +Similarly, you can make `GET` calls with or without deserialization of the response using `ExecuteGetAsync(resource)`, `GetAsync(resource)`, `ExecuteGetAsync(resource)`, and `GetAsync(resource)` (see below). + +## JSON requests + +RestSharp provides an easier API for making calls to endpoints that accept and return JSON. + +### GET calls + +To make a simple `GET` call and get a deserialized JSON response with a pre-formed resource string, use this: + +```csharp +var response = await client.GetAsync("endpoint?foo=bar", cancellationToken); +``` + +:::note +In v111, `GetJsonAsync` is renamed to `GetAsync`. +::: + +You can also use a more advanced extension that uses an object to compose the resource string: + +```csharp +var client = new RestClient("https://example.org"); +var args = new { + id = "123", + foo = "bar" +}; +// Will make a call to https://example.org/endpoint/123?foo=bar +var response = await client.GetAsync("endpoint/{id}", args, cancellationToken); +``` + +It will search for the URL segment parameters matching any of the object properties and replace them with values. All the other properties will be used as query parameters. + +One note about `GetAsync` is that it will deserialize the response with any supported content type, not only JSON. + +### POST calls + +Similar things are available for `POST` requests. + +```csharp +var request = new CreateOrder("123", "foo", 10100); +// Will post the request object as JSON to "orders" and returns a +// JSON response deserialized to OrderCreated +var result = client.PostJsonAsync("orders", request, cancellationToken); +``` + +```csharp +var request = new CreateOrder("123", "foo", 10100); +// Will post the request object as JSON to "orders" and returns a +// status code, not expecting any response body +var statusCode = client.PostJsonAsync("orders", request, cancellationToken); +``` + +The same two extensions also exist for `PUT` requests (`PutJsonAsync`); + +## Downloading binary data + +There are two functions that allow you to download binary data from the remote API. + +First, there's `DownloadDataAsync`, which returns `Task`. This function allows you to open a stream reader and asynchronously stream large responses to memory or disk. + +## JSON streaming + +For HTTP API endpoints that stream the response data (like [Twitter search stream](https://developer.twitter.com/en/docs/twitter-api/tweets/filtered-stream/api-reference/get-tweets-search-stream)) you can use RestSharp with `StreamJsonAsync`, which returns an `IAsyncEnumerable`: + +```csharp +public async IAsyncEnumerable SearchStream( + [EnumeratorCancellation] CancellationToken cancellationToken = default +) { + var response = _client.StreamJsonAsync>( + "tweets/search/stream", cancellationToken + ); + + await foreach (var item in response.WithCancellation(cancellationToken)) { + yield return item.Data; + } +} +``` + +The main limitation of this function is that it expects each JSON object to be returned as a single line. It is unable to parse the response by combining multiple lines into a JSON string. + diff --git a/docs/versioned_docs/version-v111/usage/request.md b/docs/versioned_docs/version-v111/usage/request.md new file mode 100644 index 000000000..0644ce22a --- /dev/null +++ b/docs/versioned_docs/version-v111/usage/request.md @@ -0,0 +1,338 @@ +--- +sidebar_position: 4 +title: Preparing requests +--- + +## Create a request + +Before making a request using `RestClient`, you need to create a request instance: + +```csharp +var request = new RestRequest(resource); // resource is the sub-path of the client base path +``` + +The default request type is `GET` and you can override it by setting the `Method` property. You can also set the method using the constructor overload: + +```csharp +var request = new RestRequest(resource, Method.Post); +``` + +After you've created a `RestRequest`, you can add parameters to it. Below, you can find all the parameter types supported by RestSharp. + +## Request headers + +Adds the header parameter as an HTTP header that is sent along with the request. The header name is the parameter's name and the header value is the value. + +You can use one of the following request methods to add a header parameter: + +```csharp +AddHeader(string name, string value); +AddHeader(string name, T value); // value will be converted to string +AddOrUpdateHeader(string name, string value); // replaces the header if it already exists +``` + +For example: + +```csharp +var request = new RestRequest("/path").AddHeader("X-Key", someKey); +``` + +You can also add header parameters to the client, and they will be added to every request made by the client. This is useful for adding authentication headers, for example. + +```csharp +client.AddDefaultHeader(string name, string value); +``` + +:::warning Avoid setting Content-Type header +RestSharp will use the correct content type by default. Avoid adding the `Content-Type` header manually to your requests unless you are absolutely sure it is required. You can add a custom content type to the [body parameter](#request-body) itself. +::: + +## Get or Post parameters + +The default RestSharp parameter type is `GetOrPostParameter`. You can add `GetOrPost` parameter to the request using the `AddParameter` function: + +```csharp +request + .AddParameter("name1", "value1") + .AddParameter("name2", "value2"); +``` + +`GetOrPost` behaves differently based on the HTTP method. If you execute a `GET` call, RestSharp will append the parameters to the URL in the form `url?name1=value1&name2=value2`. + +On a `POST` or `PUT` requests, it depends on whether you have files attached to a request. +If not, the parameters will be sent as the body of the request in the form `name1=value1&name2=value2`. Also, the request will be sent as `application/x-www-form-urlencoded`. + +In both cases, name and value will automatically be URL-encoded, unless specified otherwise: + +```csharp +request.AddParameter("name", "Væ üé", false); // don't encode the value +``` + +If you have files, RestSharp will send a `multipart/form-data` request. Your parameters will be part of this request in the form: + +``` +Content-Disposition: form-data; name="parameterName" + +ParameterValue +``` + +You can also add `GetOrPost` parameter as a default parameter to the client. This will add the parameter to every request made by the client. + +```csharp +client.AddDefaultParameter("foo", "bar"); +``` + +It will work the same way as request parameters, except that it will be added to every request. + +## Query string + +`QueryString` works like `GetOrPost`, except that it always appends the parameters to the url in the form `url?name1=value1&name2=value2`, regardless of the request method. + +Example: + +```csharp +var client = new RestClient("https://search.me"); +var request = new RestRequest("search") + .AddParameter("foo", "bar"); +var response = await client.GetAsync(request); +``` + +It will send a `GET` request to `https://search.me/search?foo=bar`. + +For `POST`-style requests you need to add the query string parameter explicitly: + +```csharp +request.AddQueryParameter("foo", "bar"); +``` + +In some cases, you might need to prevent RestSharp from encoding the query string parameter. +To do so, set the `encode` argument to `false` when adding the parameter: + +```csharp +request.AddQueryParameter("foo", "bar/fox", false); +``` + +You can also add a query string parameter as a default parameter to the client. This will add the parameter to every request made by the client. + +```csharp +client.AddDefaultQueryParameter("foo", "bar"); +``` + +The line above will result in all the requests made by that client instance to have `foo=bar` in the query string for all the requests made by that client. + +## Using AddObject + +You can avoid calling `AddParameter` multiple times if you collect all the parameters in an object, and then use `AddObject`. +For example, this code: + +```csharp +var params = new { + status = 1, + priority = "high", + ids = new [] { "123", "456" } +}; +request.AddObject(params); +``` + +is equivalent to: + +```csharp +request.AddParameter("status", 1); +request.AddParameter("priority", "high"); +request.AddParameter("ids", "123,456"); +``` + +Remember that `AddObject` only works if your properties have primitive types. It also works with collections of primitive types as shown above. + +If you need to override the property name or format, you can do it using the `RequestProperty` attribute. For example: + +```csharp +public class RequestModel { + // override the name and the format + [RequestProperty(Name = "from_date", Format = "d")] + public DateTime FromDate { get; set; } +} + +// add it to the request +request.AddObject(new RequestModel { FromDate = DateTime.Now }); +``` + +In this case, the request will get a GET or POST parameter named `from_date` and its value would be the current date in short date format. + +## Using AddObjectStatic + +Request function `AddObjectStatic(...)` allows using pre-compiled expressions for getting property values. Compared to `AddObject` that uses reflections for each call, `AddObjectStatic` caches functions to retrieve properties from an object of type `T`, so it works much faster. + +You can instruct `AddObjectStatic` to use custom parameter names and formats, as well as supply the list of properties than need to be used as parameters. The last option could be useful if the type `T` has properties that don't need to be sent with HTTP call. + +To use custom parameter name or format, use the `RequestProperty` attribute. For example: + +```csharp +class TestObject { + [RequestProperty(Name = "some_data")] + public string SomeData { get; set; } + + [RequestProperty(Format = "d")] + public DateTime SomeDate { get; set; } + + [RequestProperty(Name = "dates", Format = "d")] + public DateTime[] DatesArray { get; set; } + + public int Plain { get; set; } + public DateTime[] PlainArray { get; set; } +} +``` + +## URL segment parameter + +Unlike `GetOrPost`, URL segment parameter replaces placeholder values in the request URL: + +```csharp +var request = new RestRequest("health/{entity}/status") + .AddUrlSegment("entity", "s2"); +``` + +When the request executes, RestSharp will try to match any `{placeholder}` with a parameter of that name (without the `{}`) and replace it with the value. So the above code results in `health/s2/status` being the URL. + +You can also add `UrlSegment` parameter as a default parameter to the client. This will add the parameter to every request made by the client. + +```csharp +client.AddDefaultUrlSegment("foo", "bar"); +``` + +## Cookies + +You can add cookies to a request using the `AddCookie` method: + +```csharp +request.AddCookie("foo", "bar"); +``` + +The simple two-parameter form defers domain resolution until execution time — the cookie domain is inferred from the request URL. If you need to specify the path and domain explicitly, use the four-parameter overload: + +```csharp +request.AddCookie("foo", "bar", "/path", "example.com"); +``` + +RestSharp will add cookies from the request as cookie headers and then extract the matching cookies from the response. You can observe and extract response cookies using the `RestResponse.Cookies` properties, which has the `CookieCollection` type. + +There is a `CookieContainer` instance on the request level. You can either assign the pre-populated container to `request.CookieContainer`, or let the container be created automatically at execution time. The four-parameter `AddCookie` overload populates the container immediately, while the two-parameter form stores cookies in `PendingCookies` until the request is executed. The container is used to extract all the cookies from it and create cookie headers for the request instead of using the container directly. It's because the cookie container is normally configured on the `HttpClientHandler` level and cookies are shared between requests made by the same client. In most of the cases this behaviour can be harmful. + +If your use case requires sharing cookies between requests made by the client instance, you can use the client-level `CookieContainer`, which you must provide as the options' property. You can add cookies to the container using the container API. No response cookies, however, would be auto-added to the container, but you can do it in code by getting cookies from the `Cookies` property of the response and adding them to the client-level container available via `IRestClient.Options.CookieContainer` property. + +## Request Body + +RestSharp supports multiple ways to add a request body: +- `AddJsonBody` for JSON payloads +- `AddXmlBody` for XML payloads +- `AddStringBody` for pre-serialized payloads + +We recommend using `AddJsonBody` or `AddXmlBody` methods instead of `AddParameter` with type `BodyParameter`. Those methods will set the proper request type and do the serialization work for you. + +When you make a `POST`, `PUT` or `PATCH` request and added `GetOrPost` [parameters](#get-or-post-parameters), RestSharp will send them as a URL-encoded form request body by default. When a request also has files, it will send a `multipart/form-data` request. You can also instruct RestSharp to send the body as `multipart/form-data` by setting the `AlwaysMultipartFormData` property to `true`. + +You can specify a custom body content type if necessary. The `contentType` argument is available in all the overloads that add a request body. + +It is not possible to add client-level default body parameters. + +### String body + +If you have a pre-serialized payload like a JSON string, you can use `AddStringBody` to add it as a body parameter. You need to specify the content type, so the remote endpoint knows what to do with the request body. For example: + +```csharp +const json = "{ data: { foo: \"bar\" } }"; +request.AddStringBody(json, ContentType.Json); +``` + +### JSON body + +When you call `AddJsonBody`, it does the following for you: + +- Instructs the RestClient to serialize the object parameter as JSON when making a request +- Sets the content type to `application/json` +- Sets the internal data type of the request body to `DataType.Json` + +Here is the example: + +```csharp +var param = new MyClass { IntData = 1, StringData = "test123" }; +request.AddJsonBody(param); +``` + +It is possible to override the default content type by supplying the `contentType` argument. For example: + +```csharp +request.AddJsonBody(param, "text/x-json"); +``` + +If you use a pre-serialized string with `AddJsonBody`, it will be sent as-is. The `AddJsonBody` will detect if the parameter is a string and will add it as a string body with JSON content type. +Essentially, it means that top-level strings won't be serialized as JSON when you use `AddJsonBody`. To overcome this issue, you can use an overload of `AddJsonBody`, which allows you to tell RestSharp to serialize the string as JSON: + +```csharp +const string payload = @" +""requestBody"": { + ""content"": { + ""application/json"": { + ""schema"": { + ""type"": ""string"" + } + } + } +},"; +request.AddJsonBody(payload, forceSerialize: true); // the string will be serialized +request.AddJsonBody(payload); // the string will NOT be serialized and will be sent as-is +``` + +### XML body + +When you call `AddXmlBody`, it does the following for you: + +- Instructs the RestClient to serialize the object parameter as XML when making a request +- Sets the content type to `application/xml` +- Sets the internal data type of the request body to `DataType.Xml` + +:::warning +Do not send XML string to `AddXmlBody`; it won't work! +::: + + +## Uploading files + +To add a file to the request you can use the `RestRequest` function called `AddFile`. The main function accepts the `FileParameter` argument: + +```csharp +request.AddFile(fileParameter); +``` + +You can instantiate the file parameter using `FileParameter.Create` that accepts a bytes array, or `FileParameter.FromFile`, which will load the file from disk. + +There are also extension functions that wrap the creation of `FileParameter` inside: + +```csharp +// Adds a file from disk +AddFile(parameterName, filePath, contentType); + +// Adds an array of bytes +AddFile(parameterName, bytes, fileName, contentType); + +// Adds a stream returned by the getFile function +AddFile(parameterName, getFile, fileName, contentType); +``` + +Remember that `AddFile` will set all the necessary headers, so please don't try to set content headers manually. + +You can also provide file upload options to the `AddFile` call. The options are: +- `DisableFilenameEncoding` (default `false`): if set to `true`, RestSharp will not encode the file name in the `Content-Disposition` header +- `DisableFilenameStar` (default `true`): if set to `true`, RestSharp will not add the `filename*` parameter to the `Content-Disposition` header + +Example of using the options: + +```csharp +var options = new FileParameterOptions { + DisableFilenameEncoding = true, + DisableFilenameStar = false +}; +request.AddFile("file", filePath, options: options); +``` + +The options specified in the snippet above usually help when you upload files with non-ASCII characters in their names. diff --git a/docs/versioned_docs/version-v111/usage/response.md b/docs/versioned_docs/version-v111/usage/response.md new file mode 100644 index 000000000..d9cd10626 --- /dev/null +++ b/docs/versioned_docs/version-v111/usage/response.md @@ -0,0 +1,36 @@ +--- +sidebar_position: 6 +title: Handling responses +--- + +All `Execute{Method}Async` functions return an instance of `RestResponse`. Similarly, `Execute{Method}Async` return a generic instance of `RestResponse` where `T` is the response object type. + +Response object contains the following properties: + +| Property | Type | Description | +|--------------------------|-----------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------| +| `Request` | `RestRequest` | Request instance that was used to get the response. | +| `ContentType` | `string?` | Response content type. `Null` if response has no content. | +| `ContentLength` | `long?` | Response content length. `Null` if response has no content. | +| `ContentEncoding` | `ICollection` | Content encoding collection. Empty if response has no content. | +| `Content` | `string?` | Response content as string. `Null` if response has no content. | +| `IsSuccessfulStatusCode` | `bool` | Indicates if response was successful, so no errors were reported by the server. Note that `404` response code means success. | +| `ResponseStatus` | `None`, `Completed`, `Error`, `TimedOut`, `Aborted` | Response completion status. Note that completed responses might still return errors. | +| `IsSuccessful` | `bool` | `True` when `IsSuccessfulStatusCode` is `true` and `ResponseStatus` is `Completed`. | +| `StatusDescription` | `string?` | Response status description, if available. | +| `RawBytes` | `byte[]?` | Response content as byte array. `Null` if response has no content. | +| `ResponseUri` | `Uri?` | URI of the response, which might be different from request URI in case of redirects. | +| `Server` | `string?` | Server header value of the response. | +| `Cookies` | `CookieCollection?` | Collection of cookies received with the response, if any. | +| `Headers` | Collection of `HeaderParameter` | Response headers. | +| `ContentHeaders` | Collection of `HeaderParameter` | Response content headers. | +| `ErrorMessage` | `string?` | Transport or another non-HTTP error generated while attempting request. | +| `ErrorException` | `Exception?` | Exception thrown when executing the request, if any. | +| `Version` | `Version?` | HTTP protocol version of the request. | +| `RootElement` | `string?` | Root element of the serialized response content, only works if deserializer supports it. | + +In addition, `RestResponse` has one additional property: + +| Property | Type | Description | +|----------|------|-----------------------------------------------------------------------------------------------------------------------------------------------------------| +| `Data` | `T?` | Deserialized response object. `Null` if there's no content in the response, deserializer failed to understand the response content, or if request failed. | diff --git a/docs/versioned_docs/version-v112/advanced/_category_.json b/docs/versioned_docs/version-v112/advanced/_category_.json new file mode 100644 index 000000000..f395bdfe4 --- /dev/null +++ b/docs/versioned_docs/version-v112/advanced/_category_.json @@ -0,0 +1,7 @@ +{ + "label": "Advanced topics", + "position": 4, + "link": { + "type": "generated-index" + } +} diff --git a/docs/versioned_docs/version-v112/advanced/authenticators.md b/docs/versioned_docs/version-v112/advanced/authenticators.md new file mode 100644 index 000000000..14196d97c --- /dev/null +++ b/docs/versioned_docs/version-v112/advanced/authenticators.md @@ -0,0 +1,185 @@ +# Authenticators + +RestSharp includes authenticators for basic HTTP, OAuth1 and token-based (JWT and OAuth2). + +There are two ways to set the authenticator: client-wide or per-request. + +Set the client-wide authenticator by assigning the `Authenticator` property of `RestClientOptions`: + +```csharp +var options = new RestClientOptions("https://example.com") { + Authenticator = new HttpBasicAuthenticator("username", "password") +}; +var client = new RestClient(options); +``` + +To set the authenticator per-request, assign the `Authenticator` property of `RestRequest`: + +```csharp +var request = new RestRequest("/api/users/me") { + Authenticator = new HttpBasicAuthenticator("username", "password") +}; +var response = await client.ExecuteAsync(request, cancellationToken); +``` + +## Basic authentication + +The `HttpBasicAuthenticator` allows you pass a username and password as a basic `Authorization` header using a base64 encoded string. + +```csharp +var options = new RestClientOptions("https://example.com") { + Authenticator = new HttpBasicAuthenticator("username", "password") +}; +var client = new RestClient(options); +``` + +## OAuth1 + +For OAuth1 authentication the `OAuth1Authenticator` class provides static methods to help generate an OAuth authenticator. +OAuth1 authenticator will add the necessary OAuth parameters to the request, including signature. + +The authenticator will use `HMAC SHA1` to create a signature by default. +Each static function to create the authenticator allows you to override the default and use another method to generate the signature. + +### Request token + +Getting a temporary request token is the usual first step in the 3-legged OAuth1 flow. +Use `OAuth1Authenticator.ForRequestToken` function to get the request token authenticator. +This method requires a `consumerKey` and `consumerSecret` to authenticate. + +```csharp +var options = new RestClientOptions("https://api.twitter.com") { + Authenticator = OAuth1Authenticator.ForRequestToken(consumerKey, consumerSecret) +}; +var client = new RestClient(options); +var request = new RestRequest("oauth/request_token"); +``` + +The response should contain the token and the token secret, which can then be used to complete the authorization process. +If you need to provide the callback URL, assign the `CallbackUrl` property of the authenticator to the callback destination. + +### Access token + +Getting an access token is the usual third step in the 3-legged OAuth1 flow. +This method retrieves an access token when provided `consumerKey`, `consumerSecret`, `oauthToken`, and `oauthTokenSecret`. +If you don't have a token for this call, you need to make a call to get the request token as described above. + +```csharp +var authenticator = OAuth1Authenticator.ForAccessToken( + consumerKey, consumerSecret, oauthToken, oauthTokenSecret +); +var options = new RestClientOptions("https://api.twitter.com") { + Authenticator = authenticator +}; +var client = new RestClient(options); +var request = new RestRequest("oauth/access_token"); +``` + +If the second step in 3-leg OAuth1 flow returned a verifier value, you can use another overload of `ForAccessToken`: + +```csharp +var authenticator = OAuth1Authenticator.ForAccessToken( + consumerKey, consumerSecret, oauthToken, oauthTokenSecret, verifier +); +``` + +The response should contain the access token that can be used to make calls to protected resources. + +For refreshing access tokens, use one of the two overloads of `ForAccessToken` that accept `sessionHandle`. + +### Protected resource + +When the access token is available, use `ForProtectedResource` function to get the authenticator for accessing protected resources. + +```csharp +var authenticator = OAuth1Authenticator.ForAccessToken( + consumerKey, consumerSecret, accessToken, accessTokenSecret +); +var options = new RestClientOptions("https://api.twitter.com/1.1") { + Authenticator = authenticator +}; +var client = new RestClient(options); +var request = new RestRequest("statuses/update.json", Method.Post) + .AddParameter("status", "Hello Ladies + Gentlemen, a signed OAuth request!") + .AddParameter("include_entities", "true"); +``` + +### xAuth + +xAuth is a simplified version of OAuth1. It allows sending the username and password as `x_auth_username` and `x_auth_password` request parameters and directly get the access token. xAuth is not widely supported, but RestSharp still allows using it. + +Create an xAuth authenticator using `OAuth1Authenticator.ForClientAuthentication` function: + +```csharp +var authenticator = OAuth1Authenticator.ForClientAuthentication( + consumerKey, consumerSecret, username, password +); +``` + +### 0-legged OAuth + +The access token authenticator can be used in 0-legged OAuth scenarios by providing `null` for the `consumerSecret`. + +```csharp +var authenticator = OAuth1Authenticator.ForAccessToken( + consumerKey, null, oauthToken, oauthTokenSecret +); +``` + +## OAuth2 + +RestSharp has two very simple authenticators to send the access token as part of the request. + +`OAuth2UriQueryParameterAuthenticator` accepts the access token as the only constructor argument, and it will send the provided token as a query parameter `oauth_token`. + +`OAuth2AuthorizationRequestHeaderAuthenticator` has two constructors. One only accepts a single argument, which is the access token. The other constructor also allows you to specify the token type. The authenticator will then add an `Authorization` header using the specified token type or `OAuth` as the default token type, and the token itself. + +For example: + +```csharp +var authenticator = new OAuth2AuthorizationRequestHeaderAuthenticator( + token, "Bearer" +); +var options = new RestClientOptions("https://example.com") { + Authenticator = authenticator +}; +var client = new RestClient(options); +``` + +The code above will tell RestSharp to send the bearer token with each request as a header. Essentially, the code above does the same as the sample for `JwtAuthenticator` below. + +As those authenticators don't do much to get the token itself, you might be interested in looking at our [sample OAuth2 authenticator](../usage/example.md#authenticator), which requests the token on its own. + +## JWT + +The JWT authentication can be supported by using `JwtAuthenticator`. It is a very simple class that can be constructed like this: + +```csharp +var authenticator = new JwtAuthenticator(myToken); +var options = new RestClientOptions("https://example.com") { + Authenticator = authenticator +}; +var client = new RestClient(options); +``` + +For each request, it will add an `Authorization` header with the value `Bearer `. + +As you might need to refresh the token from, you can use the `SetBearerToken` method to update the token. + +## Custom authenticator + +You can write your own implementation by implementing `IAuthenticator` and +registering it with your RestClient: + +```csharp +var authenticator = new SuperAuthenticator(); // implements IAuthenticator +var options = new RestClientOptions("https://example.com") { + Authenticator = authenticator +}; +var client = new RestClient(options); +``` + +The `Authenticate` method is the very first thing called upon calling `RestClient.Execute` or `RestClient.Execute`. +It gets the `RestRequest` currently being executed giving you access to every part of the request data (headers, parameters, etc.) + +You can find an example of a custom authenticator that fetches and uses an OAuth2 bearer token [here](../usage/example.md#authenticator). diff --git a/docs/versioned_docs/version-v112/advanced/configuration.md b/docs/versioned_docs/version-v112/advanced/configuration.md new file mode 100644 index 000000000..b57638632 --- /dev/null +++ b/docs/versioned_docs/version-v112/advanced/configuration.md @@ -0,0 +1,230 @@ +--- +title: Configuration +description: Learn how to configure RestClient for non-trivial use cases. +sidebar_position: 1 +--- + +# Configuring RestClient + +This page describes how to create and configure `RestClient`. + +## Basic configuration + +The primary `RestClient` constructor accepts an instance of `RestClientOptions`. Most of the time, default option values don't need to be changed. However, in some cases, you'd want to configure the client differently, so you'd need to change some of the options in your code. The constructor also contains a few optional parameters for additional configuration that is not covered by client options. Here's the constructor signature: + +```csharp +public RestClient( + RestClientOptions options, + ConfigureHeaders? configureDefaultHeaders = null, + ConfigureSerialization? configureSerialization = null, + bool useClientFactory = false +) +``` + +Constructor parameters are: + +| Name | Description | Mandatory | +|-------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------| +| options | Client options | Yes | +| configureDefaultHeaders | Function to configure headers. Allows to configure default headers for `HttpClient`. Most of the time you'd prefer using `client.AddDefaultHeader` instead. | No | +| configureSerialization | Function to configure client serializers with non-default options or to use a different serializer ([learn more](serialization.md)) | No | +| useClientFactory | Instructs the client to use `SimpleFactory` ([learn more](../usage/client.md#simple-factory)) to get an `HttpClient` instance | No | + +Here's an example of how to create a client using client options: + +```csharp +var options = new RestClientOptions("https://localhost:5000/api") { + DisableCharset = true +}; +var client = new RestClient(options); +``` + +When you only need to set the base URL, you can use a simplified constructor: + +```csharp +var client = new RestClient("https://localhost:5000/api"); +``` + +The simplified constructor will create an instance of client options and set the base URL provided as the constructor argument. + +Finally, you can override properties of default options using a configuration function. Here's the constructor signature that supports this method: + +```csharp +public RestClient( + ConfigureRestClient? configureRestClient = null, + ConfigureHeaders? configureDefaultHeaders = null, + ConfigureSerialization? configureSerialization = null, + bool useClientFactory = false +) +``` + +For example: + +```csharp +var client = new RestClient(options => { + options.BaseUrl = new Url("https://localhost:5000/api"), + options.DisableCharset = true +}); +``` + +You can also provide the base URL as a constructor argument like this: + +```csharp +var client = new RestClient("https://localhost:5000/api", options => { + options.DisableCharset = true +}); +``` + +## Using custom HttpClient + +By default, RestSharp creates an instance of `HttpClient` configured using the client options, and keeps it during the lifetime of the client. When the `RestClient` instance gets disposed, it also disposes the `HttpClient` instance. + +There might be a case when you need to provide your own `HttpClient`. For example, you would want to use `HttpClient` created by HTTP client factory. RestSharp allows you to do it by using additional constructors. These constructors are: + +```csharp +// Create a client using an existing HttpClient and RestClientOptions (optional) +public RestClient( + HttpClient httpClient, + RestClientOptions? options, + bool disposeHttpClient = false, + ConfigureSerialization? configureSerialization = null +) + +// Create a client using an existing HttpClient and optional RestClient configuration function +public RestClient( + HttpClient httpClient, + bool disposeHttpClient = false, + ConfigureRestClient? configureRestClient = null, + ConfigureSerialization? configureSerialization = null +) +``` + +The `disposeHttpClient` argument tells the client to dispose `HttpClient` when the client itself gets disposed. It's set to `false` by default as when the `HttpClient` is provided from the outside, it should normally be disposed on the outside as well. + +## Using custom message handler + +Unless you use an external instance of `HttpClient`, the `RestClient` creates one when being constructed, and it will use the default HTTP message handler, configured using `RestClientOptions`. Normally, you'd get a `SocketHttpHandler` with modern .NET, and `WinHttpHandler` with .NET Framework. + +There might be a case when you need to configure the HTTP message handler. For example, you want to add a delegating message handler. RestSharp allows you to do it by using additional constructors. There's one constructor that allows you to pass the custom `HttpMessageHandler`: + +```csharp +public RestClient( + HttpMessageHandler handler, + bool disposeHandler = true, + ConfigureRestClient? configureRestClient = null, + ConfigureSerialization? configureSerialization = null +) +``` + +This constructor will create a new `HttpClient` instance using the provided message handler. As RestSharp will dispose the `HttpClient` instance when the `RestClient` instance gets disposed, the handler will be disposed as well. If you want to change that and keep the handler, set the `disposeHandler` parameter to `false`. + +:::note +When using a custom message handler, RestSharp **will not** configure it with client options, which are normally used to configure the handler created by RestSharp. +::: + +Another way to customize the message handler is to allow RestSharp to create a handler, but then configure it, or wrap it in a delegating handler. It can be done by using the `RestClientOptions.ConfigureMessageHandler` property. It can be set to a function that receives the handler created by RestSharp and returned either the same handler with different settings, or a new handler. + +For example, if you want to use `MockHttp` and its handler for testing, you can do it like this: + +```csharp +var mockHttp = new MockHttpMessageHandler(); +// Configure the MockHttp handler to do the checks +... + +var options = new RestClientOptions(Url) { + ConfigureMessageHandler = _ => mockHttp +}; +using var client = new RestClient(options); +``` + +In this example, we are reassigning the handler to MockHttp, so the handler created by RestSharp isn't used. In other cases you want to use delegating handlers as middleware, so you'd pass the handler created by RestSharp to the delegating handler: + +```csharp +var options = new RestClientOptions(Url) { + ConfigureMessageHandler = handler => new MyDelegatingHandler(handler) +}; +using var client = new RestClient(options); +``` + +## Client options + +RestSharp allows configuring `RestClient` using client options, as mentioned at the beginning of this page. Below, you find more details about available options. + +| Option | Description | +|----------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| `BaseUrl` | Client base URL. It can also be provided as the `RestClientOptions` constructor argument. | +| `ConfigureMessageHandler` | Configures the HTTP message handler (see above). | +| `CalculateResponseStatus` | Function to calculate a different response status from `HttpResponseMessage`. By default, the request is considered as complete if it returns a successful status code or 404. | +| `Authenticator` | Client-level authenticator. Read more about authenticators [here](authenticators.md). | +| `Interceptors` | A collector of interceptors. Read more about interceptors [here](interceptors.md). | +| `Credentials` | Instance of `ICredentials` used for NTLM or Kerberos authentication. Not supported in browsers. | +| `UseDefaultCredentials` | Whether to use default OS credentials for NTLM or Kerberos authentication. Not supported in browsers. | +| `DisableCharset` | When set to `true`, the `Content-Type` header won't have the `charset` portion. Some older web servers don't understand the `charset` portion in the header and fail to process the request. | +| `AutomaticDecompression` | Allows customizing supported decompression methods. Default is `All` except for .NET Framework that only support `GZip`. Not supported in browsers. | +| `MaxRedirects` | The number of redirects to follow. Not supported in browsers. | +| `ClientCertificates` | A collection of X.509 client certificates to be used for authentication. Not supported in browsers. | +| `Proxy` | Can be used if the client needs to use an explicit, non-default proxy. Not supported in browsers, on iOS and tvOS. | +| `CachePolicy` | Shortcut for setting the default value for `Cache-Control` header. | +| `FollowRedirects` | Instructs the client to follow redirects. Default is `true`. | +| `Expect100Continue` | Gets or sets a value that indicates if the `Expect` header for an HTTP request contains `Continue`. | +| `UserAgent` | Allows overriding the default value for `User-Agent` header, which is `RestSharp/{version}`. | +| `PreAuthenticate` | Gets or sets a value that indicates whether the client sends an `Authorization` header with the request. Not supported in browsers. | +| `RemoteCertificateValidationCallback` | Custom function to validate the server certificate. Normally, it's used when the server uses a certificate that isn't trusted by default. | +| `BaseHost` | Value for the `Host` header sent with each request. | +| `CookieContainer` | Custom cookie container that will be shared among all calls made by the client. Normally not required as RestSharp handles cookies without using a client-level cookie container. | +| `MaxTimeout` | Client-level timeout in milliseconds. If the request timeout is also set, this value isn't used. | +| `Encoding` | Default request encoding. Override it only if you don't use UTF-8. | +| `ThrowOnDeserializationError` | Forces the client to throw if it fails to deserialize the response. Remember that not all deserialization issues forces the serializer to throw. Default is `false`, so the client will return a `RestResponse` with deserialization exception details. Only relevant for `Execute...` functions. | +| `FailOnDeserializationError` | When set to `true`, if the client fails to deserialize the response, the response object will have status `Failed`, although the HTTP calls might have been successful. Default is `true`. | +| `ThrowOnAnyError` | When set to `true`, the client will re-throw any exception from `HttpClient`. Default is `false`. Only applies for `Execute...` functions. | +| `AllowMultipleDefaultParametersWithSameName` | By default, adding parameters with the same name is not allowed. You can override this behaviour by setting this property to `true`. | +| `Encode` | A function to encode URLs, the default is a custom RestSharp function based on `Uri.EscapeDataString()`. Set it if you need a different way to do the encoding. | +| `EncodeQuery` | A function to encode URL query parameters. The default is the same function as for `Encode` property. | + +Some of the options are used by RestSharp code, but some are only used to configure the `HttpMessageHandler`. These options are: +- `Credentials` +- `UseDefaultCredentials` +- `AutomaticDecompression` +- `PreAuthenticate` +- `MaxRedirects` +- `RemoteCertificateValidationCallback` +- `ClientCertificates` +- `FollowRedirects` +- `Proxy` + +:::note +If setting these options to non-default values produce no desirable effect, check if your framework and platform supports them. RestSharp doesn't change behaviour based on values of those options. +::: + +The `IRestClient` interface exposes the `Options` property, so any option can be inspected at runtime. However, RestSharp converts the options object provided to the client constructor to an immutable object. Therefore, no client option can be changed after the client is instantiated. It's because changing client options at runtime can produce issues in concurrent environments, effectively rendering the client as not thread-safe. Apart from that, changing the options that are used to create the message handler would require re-creating the handler, and also `HttpClient`, which should not be done at runtime. + +## Configuring requests + +Client options apply to all requests made by the client. Sometimes, you want to fine-tune particular requests, so they execute with custom configuration. It's possible to do using properties of `RestRequest`, described below. + +| Name | Description | +|------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| `AlwaysMultipartFormData` | When set to `true`, the request will be sent as a multipart form, even though it's not required. By default, RestSharp only sends requests with multiple attachments as multipart forms. Default is `false`. | +| `AlwaysSingleFileAsContent` | When set to true, the request with file attachment will not be sent as a multipart form, but as plain content. Default is `false`. It cannot be set to `true` when `AlwaysMultipartFormData` is set to `true`, or when the request has `POST` parameters. | +| `MultipartFormQuoteBoundary` | Default is `true`, which means that the form boundary string will be wrapped in quotes. If the server has an issue with that, setting this to `false` will remove quotes around the boundary. | +| `FormBoundary` | Allows specifying a custom multipart form boundary instead of using the default random string. | +| `RequestParameters` | Collection of request parameters. Normally, you won't need to use it as parameters are added to the request using `Add...` functions. | +| `CookieContainer` | Custom request-level cookie container. Default is `null`. You can still set request cookies using `AddCookie` and get response cookies from the response object without using cooking container. | +| `Authenticator` | Overrides the client-level authenticator. | +| `Files` | Collection of file parameters, read-only. Use `AddFile` for adding files to the request. | +| `Method` | Request HTTP method, default is `GET`. Only needed when using `Execute` or `ExecuteAsync` as other functions like `ExecutePostAsync` will override the request method. | +| `TImeout` | Overrides the client-level timeout. | +| `Resource` | Resource part of the remote endpoint URL. For example, when using the client-level base URL `https://localhost:5000/api` and `Resource` set to `weather`, the request will be sent to `https://localhost:5000/api/weather`. It can container resource placeholders to be used in combination with `AddUrlSegment` | +| `RequestFormat` | Identifies the request as JSON, XML, binary, or none. Rarely used because the client will set the request format based on the body type if functions like `AddJsonBody` or `AddXmlBody` are used. | +| `RootElement` | Used by the default deserializers to determine where to start deserializing from. Only supported for XML responses. Does not apply to requests. | +| `OnBeforeDeserialization` | **Obsolete** A function to be called before the response is deserializer. Allows changing the content before calling the deserializer. Use [interceptors](interceptors.md) instead. | +| `OnBeforeRequest` | **Obsolete** A function to be called right before the request is executed by `HttpClient`. It receives an instance of `HttpRequestMessage`. Use [interceptors](interceptors.md) instead. | +| `OnAfterRequest` | **Obsolete** A function to be called right after the request is executed by `HttpClient`. It receives an instance of `HttpResponseMessage`. Use [interceptors](interceptors.md) instead. | +| `Attempts` | When the request is being resent to retry, the property value increases by one. | +| `CompletionOption` | Instructs the client on when it should consider the request to be completed. The default is `ResponseContentRead`. It is automatically changed to `ResponseHeadersRead` when using async download functions or streaming. | +| `CachePolicy` | Overrides the client cache policy. | +| `ResponseWriter` | Allows custom handling of the response stream. The function gets the raw response stream and returns another stream or `null`. Cannot be used in combination with `AdvancedResponseWriter`. | +| `AdvancedResponseWriter` | Allows custom handling of the response. The function gets an instance of `HttpResponseMessage` and an instance of `RestRequest`. It must return an instance of `RestResponse`, so it effectively overrides RestSharp default functionality for creating responses. | +| `Interceptors` | Allows adding interceptors to the request. Both client-level and request-level interceptors will be called. | + +The table below contains all configuration properties of `RestRequest`. To learn more about adding request parameters, check the [usage page](../usage/request.md) page about creating requests with parameters. diff --git a/docs/versioned_docs/version-v112/advanced/error-handling.md b/docs/versioned_docs/version-v112/advanced/error-handling.md new file mode 100644 index 000000000..80e822dcc --- /dev/null +++ b/docs/versioned_docs/version-v112/advanced/error-handling.md @@ -0,0 +1,71 @@ +# Error handling + +If there is a network transport error (network is down, failed DNS lookup, etc.), or any kind of server error (except 404), `RestResponse.ResponseStatus` will be set to `ResponseStatus.Error`, otherwise it will be `ResponseStatus.Completed`. + +If an API returns a 404, `ResponseStatus` will still be `Completed`. If you need access to the HTTP status code returned, you will find it at `RestResponse.StatusCode`. +The `Status` property is an indicator of completion independent of the API error handling. + +Normally, RestSharp doesn't throw an exception if the request fails. + +However, it is possible to configure RestSharp to throw in different situations when it normally doesn't throw +in favor of giving you the error as a property. + +| Property | Behavior | +|-------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| `FailOnDeserializationError` | Changes the default behavior when failed deserialization results in a successful response with an empty `Data` property of the response. Setting this property to `true` will tell RestSharp to consider failed deserialization as an error and set the `ResponseStatus` to `Error` accordingly. | +| `ThrowOnDeserializationError` | Changes the default behavior when failed deserialization results in empty `Data` property of the response. Setting this property to `true` will tell RestSharp to throw when deserialization fails. | +| `ThrowOnAnyError` | Setting this property to `true` changes the default behavior and forces RestSharp to throw if any errors occurs when making a request or during deserialization. | + +Those properties are available for the `RestClientOptions` and will be used for all request made with the client instance. + +For example, you can configure the client to throw an exception if any error occurs when making a request or when a request returns a non-successful HTTP status code: + +```csharp +var options = new RestClientOptions(url) { + ThrowOnAnyError = true +}; +var client = new RestClient(options); +var request = new RestRequest("resource/{id}").AddUrlSegment("id", 123); + +// 👇 will throw if the request fails +var deserialized = await client.GetAsync(request); + +// 👇 will NOT throw if the request fails, inspect the response to find out what happened +var response = await client.ExecuteGetAsync(request); +``` + +:::warning +Please be aware that deserialization failures will only work if the serializer throws an exception when deserializing the response. +Many serializers don't throw by default, and just return a `null` result. RestSharp is unable to figure out why `null` is returned, so it won't fail in this case. +Check the serializer documentation to find out if it can be configured to throw on deserialization error. +::: + +There are also slight differences on how different overloads handle exceptions. + +Asynchronous generic methods `GetAsync`, `PostAsync` and so on, which aren't a part of `RestClient` API (those methods are extension methods) return `Task`. It means that there's no `RestResponse` to set the response status to error. We decided to throw an exception when such a request fails. It is a trade-off between the API consistency and usability of the library. Usually, you only need the content of `RestResponse` instance to diagnose issues and most of the time the exception would tell you what's wrong. + +Below, you can find how different extensions deal with errors. Note that functions, which don't throw by default, will throw exceptions when `ThrowOnAnyError` is set to `true`. + +| Function | Throws on errors | +|:----------------------|:-----------------| +| `ExecuteAsync` | No | +| `ExecuteGetAsync` | No | +| `ExecuteGetAsync` | No | +| `ExecutePostAsync` | No | +| `ExecutePostAsync` | No | +| `ExecutePutAsync` | No | +| `ExecutePutAsync` | No | +| `GetAsync` | Yes | +| `GetAsync` | Yes | +| `PostAsync` | Yes | +| `PostAsync` | Yes | +| `PatchAsync` | Yes | +| `PatchAsync` | Yes | +| `DeleteAsync` | Yes | +| `DeleteAsync` | Yes | +| `OptionsAsync` | Yes | +| `OptionsAsync` | Yes | +| `HeadAsync` | Yes | +| `HeadAsync` | Yes | + +In addition, all the functions for JSON requests, like `GetJsonAsync` and `PostJsonAsync` throw an exception if the HTTP call fails. diff --git a/docs/versioned_docs/version-v112/advanced/interceptors.md b/docs/versioned_docs/version-v112/advanced/interceptors.md new file mode 100644 index 000000000..a3bf7a9bc --- /dev/null +++ b/docs/versioned_docs/version-v112/advanced/interceptors.md @@ -0,0 +1,84 @@ +--- +title: Interceptors +--- + +## Intercepting requests and responses + +Interceptors are a powerful feature of RestSharp that allows you to modify requests and responses before they are sent or received. You can use interceptors to add headers, modify the request body, or even cancel the request. You can also use interceptors to modify the response before it is returned to the caller. + +### Implementing an interceptor + +To implement an interceptor, you need to create a class that inherits the `Interceptor` base class. The base class implements all interceptor methods as virtual, so you can override them in your derived class. + +Methods that you can override are: +- `BeforeRequest(RestRequest request, CancellationToken cancellationToken)` +- `AfterRequest(RestResponse response, CancellationToken cancellationToken)` +- `BeforeHttpRequest(HttpRequestMessage requestMessage, CancellationToken cancellationToken)` +- `AfterHttpRequest(HttpResponseMessage responseMessage, CancellationToken cancellationToken)` +- `BeforeDeserialization(RestResponse response, CancellationToken cancellationToken)` + +All those functions must return a `ValueTask` instance. + +Here's an example of an interceptor that adds a header to a request: + +```csharp +// This interceptor adds a header to the request +// You'd not normally use this interceptor, as RestSharp already has a method +// to add headers to the request +class HeaderInterceptor(string headerName, string headerValue) : Interceptors.Interceptor { + public override ValueTask BeforeHttpRequest(HttpRequestMessage requestMessage, CancellationToken cancellationToken) { + requestMessage.Headers.Add(headerName, headerValue); + return ValueTask.CompletedTask; + } +} +``` + +Because interceptor functions return `ValueTask`, you can use `async` and `await` inside them. + +### Using an interceptor + +It's possible to add as many interceptors as you want, both to the client and to the request. The interceptors are executed in the order they were added. + +Adding interceptors to the client is done via the client options: + +```csharp +var options = new RestClientOptions("https://api.example.com") { + Interceptors = [new HeaderInterceptor("Authorization", token)] +}; +var client = new RestClient(options); +``` + +When you add an interceptor to the client, it will be executed for every request made by that client. + +You can also add an interceptor to a specific request: + +```csharp +var request = new RestRequest("resource") { + Interceptors = [new HeaderInterceptor("Authorization", token)] +}; +``` + +In this case, the interceptor will only be executed for that specific request. + +### Deprecation notice + +Interceptors aim to replace the existing request hooks available in RestSharp prior to version 111.0. Those hooks are marked with `Obsolete` attribute and will be removed in the future. If you are using those hooks, we recommend migrating to interceptors as soon as possible. + +To make the migration easier, RestSharp provides a class called `CompatibilityInterceptor`. It has properties for the hooks available in RestSharp 110.0 and earlier. You can use it to migrate your code to interceptors without changing the existing logic. + +For example, a code that uses `OnBeforeRequest` hook: + +```csharp +var request = new RestRequest("success"); +request.OnBeforeDeserialization += _ => throw new Exception(exceptionMessage); +``` + +Can be migrated to interceptors like this: + +```csharp +var request = new RestRequest("success") { + Interceptors = [new CompatibilityInterceptor { + OnBeforeDeserialization = _ => throw new Exception(exceptionMessage) + }] +}; +``` \ No newline at end of file diff --git a/docs/versioned_docs/version-v112/advanced/serialization.md b/docs/versioned_docs/version-v112/advanced/serialization.md new file mode 100644 index 000000000..b7092519a --- /dev/null +++ b/docs/versioned_docs/version-v112/advanced/serialization.md @@ -0,0 +1,148 @@ +# Serialization + +One of the most common reasons to choose RestSharp over plain `HttpClient` is its rich build-in serialization support. RestSharp allows adding complex objects as request body to be serialized when making a call to an API endpoint, and deserializing the response to a given .NET type. RestSharp supports JSON and XML serialization and deserialization by default. In addition, you can use a CSV serializer or write your own. + +In contrast to `System.Net.Http.Json` package that contains `HttpClient` extensions to make `GET` or `POST` calls using JSON, RestSharp support JSON responses for all HTTP methods, not just for `GET`. + +## Configuration + +:::tip +The default behavior of RestSharp is to swallow deserialization errors and return `null` in the `Data` +property of the response. Read more about it in the [Error Handling](error-handling.md). +::: + +You can tell RestSharp to use a custom serializer by using the `configureSerialization` constructor parameter: + +```csharp +var client = new RestClient( + options, + configureSerialization: s => s.UseSerializer(() => new CustomSerializer()); +); +``` + +All RestSharp serializers implement the `IRestSerializer` interface. Among other things, the interface requires implementing the `AcceptedContentTypes` property, which must return a collection of content types supported by the serializer. Being configured to use certain serializers, RestSharp populates the `Accept` header accordingly, so it doesn't need to be set manually. + +When making a call, RestSharp sets the request content type according to the request body type. For example, when you use `AddJsonBody`, the content type is set to `application/json`. Normally, you won't need to set the `Content-Type` header manually. If you need to set a custom content type for a JSON call, you can use the optional `contentType` argument of `AddJsonBody`, for example: + +```csharp +request.AddJsonBody(data, "text/json"); +``` + +## JSON + +The default JSON serializer uses `System.Text.Json`, which is a part of .NET since .NET 6. For earlier versions, it is added as a dependency. There are also a few serializers provided as additional packages. + +By default, RestSharp will use `JsonSerializerDefaults.Web` configuration. If necessary, you can specify your own options: + +```csharp +var client = new RestClient( + options, + configureSerialization: s => s.UseSystemTextJson(new JsonSerializerOptions {...}) +); +``` + +## XML + +The default XML serializer is `DotNetXmlSerializer`, which uses `System.Xml.Serialization` library from .NET. + +In previous versions of RestSharp, the default XML serializer was a custom RestSharp XML serializer. To make the code library size smaller, that serializer is now available as a separate package [`RestSharp.Serializers.Xml`](https://www.nuget.org/packages/RestSharp.Serializers.Xml). +You can add it back if necessary by installing the package and adding it to the client: + +```csharp +var client = new RestClient( + options, + configureSerialization: s => s.UseXmlSerializer() +); +``` + +As before, you can supply three optional arguments for a custom namespace, custom root element, and if you want to use `SerializeAs` and `DeserializeAs` attributed. + +## NewtonsoftJson (aka Json.Net) + +The `NewtonsoftJson` package is the most popular JSON serializer for .NET. It handles all possible scenarios and is very configurable. Such a flexibility comes with the cost of performance. If you need speed, keep the default JSON serializer. + +RestSharp support Json.Net serializer via a separate package [`RestSharp.Serializers.NewtonsoftJson`](https://www.nuget.org/packages/RestSharp.Serializers.NewtonsoftJson). + +:::warning +Please note that `RestSharp.Newtonsoft.Json` package is not provided by RestSharp, is marked as obsolete on NuGet, and no longer supported by its creator. +::: + +Use the extension method provided by the package to configure the client: + +```csharp +var client = new RestClient( + options, + configureSerialization: s => s.UseNewtonsoftJson() +); +``` + +The serializer configures some options by default: + +```csharp +JsonSerializerSettings DefaultSettings = new JsonSerializerSettings { + ContractResolver = new CamelCasePropertyNamesContractResolver(), + DefaultValueHandling = DefaultValueHandling.Include, + TypeNameHandling = TypeNameHandling.None, + NullValueHandling = NullValueHandling.Ignore, + Formatting = Formatting.None, + ConstructorHandling = ConstructorHandling.AllowNonPublicDefaultConstructor +}; +``` + +If you need to use different settings, you can supply your instance of +`JsonSerializerSettings` as a parameter for the extension method. + +## CSV + +A separate package `RestSharp.Serializers.CsvHelper` provides a CSV serializer for RestSharp. It is based on the +`CsvHelper` library. + +Use the extension method provided by the package to configure the client: + +```csharp +var client = new RestClient( + options, + configureSerialization: s => s.UseCsvHelper() +); +``` + +You can also supply your instance of `CsvConfiguration` as a parameter for the extension method. + +```csharp +var client = new RestClient( + options, + configureSerialization: s => s.UseCsvHelper( + new CsvConfiguration(CultureInfo.InvariantCulture) {...} + ) +); +``` + +## Custom + +You can also implement your custom serializer. To support both serialization and +deserialization, you must implement the `IRestSerializer` interface. + +Here is an example of a custom serializer that uses `System.Text.Json`: + +```csharp +public class SimpleJsonSerializer : IRestSerializer { + public string? Serialize(object? obj) => obj == null ? null : JsonSerializer.Serialize(obj); + + public string? Serialize(Parameter bodyParameter) => Serialize(bodyParameter.Value); + + public T? Deserialize(RestResponse response) => JsonSerializer.Deserialize(response.Content!); + + public ContentType ContentType { get; set; } = ContentType.Json; + + public ISerializer Serializer => this; + public IDeserializer Deserializer => this; + public DataFormat DataFormat => DataFormat.Json; + public string[] AcceptedContentTypes => ContentType.JsonAccept; + public SupportsContentType SupportsContentType + => contentType => contentType.Value.EndsWith("json", StringComparison.InvariantCultureIgnoreCase); +} +``` + +The `SupportedContentTypes` function will be used to check if the serializer is able to deserialize the response based on the `Content-Type` response header. + +The `ContentType` property will be used when making a request so the server knows how to handle the payload. diff --git a/docs/versioned_docs/version-v112/changelog.md b/docs/versioned_docs/version-v112/changelog.md new file mode 100644 index 000000000..3a6d9513a --- /dev/null +++ b/docs/versioned_docs/version-v112/changelog.md @@ -0,0 +1,19 @@ +--- +title: What's new +description: List of changes for the current major version +sidebar_position: 1 +--- + +# Changelog + +For release notes of previous versions, please check the [Releases page](https://github.com/restsharp/RestSharp/releases) in RestSharp GitHub repository. + +Changes between major versions are documented in the documentation for each version on this website. + +# v112.0 + +* Security fix for [CVE-2024-45302](https://github.com/restsharp/RestSharp/security/advisories/GHSA-4rr6-2v9v-wcpc). Header values cannot contain `CRLF`. + +## v112.1 + +* Follow up on v112.0 security fix: remove `\t` from the list of forbidden characters in headers. \ No newline at end of file diff --git a/docs/versioned_docs/version-v112/intro.md b/docs/versioned_docs/version-v112/intro.md new file mode 100644 index 000000000..43fa8e2f0 --- /dev/null +++ b/docs/versioned_docs/version-v112/intro.md @@ -0,0 +1,112 @@ +--- +sidebar_position: 2 +title: Quick start +--- + +## Introduction + +:::warning +RestSharp v107+ changes the library API surface and its behaviour significantly. We advise looking at [migration](/migration) docs to understand how to migrate to the latest version of RestSharp. +::: + +The main purpose of RestSharp is to make synchronous and asynchronous calls to remote resources over HTTP. As the name suggests, the main audience of RestSharp are developers who use REST APIs. However, RestSharp can call any API over HTTP, as long as you have the resource URI and request parameters that you want to send comply with W3C HTTP standards. + +One of the main challenges of using HTTP APIs for .NET developers is to work with requests and responses of different kinds and translate them to complex C# types. RestSharp can take care of serializing the request body to JSON or XML and deserialize the response. It can also form a valid request URI based on different parameter kinds: path, query, form or body. + +## Getting Started + +Before you can use RestSharp in your application, you need to add the NuGet package. You can do it using your IDE or the command line: + +``` +dotnet add package RestSharp +``` + +### Basic Usage + +If you only have a small number of one-off API requests to perform, you can use RestSharp like this: + +```csharp +using RestSharp; +using RestSharp.Authenticators; + +var options = new RestClientOptions("https://api.twitter.com/1.1") { + Authenticator = new HttpBasicAuthenticator("username", "password") +}; +var client = new RestClient(options); +var request = new RestRequest("statuses/home_timeline.json"); +// The cancellation token comes from the caller. You can still make a call without it. +var response = await client.GetAsync(request, cancellationToken); +``` + +It will return a `RestResponse` back, which contains all the information returned from the remote server. +You have access to the headers, content, HTTP status and more. + +You can also use generic overloads like `Get` to automatically deserialize the response into a .NET class. + +For example: + +```csharp +using RestSharp; +using RestSharp.Authenticators; + +var options = new RestClientOptions("https://api.twitter.com/1.1") { + Authenticator = new HttpBasicAuthenticator("username", "password") +}; +var client = new RestClient(options); + +var request = new RestRequest("statuses/home_timeline.json"); + +// The cancellation token comes from the caller. You can still make a call without it. +var timeline = await client.GetAsync(request, cancellationToken); +``` + +Both snippets above use the `GetAsync` extension, which is a wrapper about `ExecuteGetAsync`, which, in turn, is a wrapper around `ExecuteAsync`. +All `ExecuteAsync` overloads and return the `RestResponse` or `RestResponse`. + +The most important difference is that async methods named after HTTP methods (like `GetAsync` or `PostAsync`) return `Task` instead of `Task>`. It means that you won't get an error response if the request fails as those methods throw an exception for unsuccessful HTTP calls. For keeping the API consistent, non-generic functions like `GetAsync` or `PostAsync` also throw an exception if the request fails, although they return the `Task`. + +Read [here](advanced/error-handling.md) about how RestSharp handles exceptions. + +RestSharp also offers simple ways to call APIs that accept and return JSON payloads. You can use the `GetJsonAsync` and `PostJsonAsync` extension methods, which will automatically serialize the request body to JSON and deserialize the response to the specified type. + +```csharp +var client = new RestClient(options); +var timeline = await client.GetJsonAsync("statuses/home_timeline.json", cancellationToken); +``` + +Read [here](usage/execute.md#json-requests) about making JSON calls without preparing a request object. + +### Content type + +RestSharp supports sending XML or JSON body as part of the request. To add a body to the request, simply call `AddJsonBody` or `AddXmlBody` method of the `RestRequest` object. + +There is no need to set the `Content-Type` or add the `DataFormat` parameter to the request when using those methods, RestSharp will do it for you. + +RestSharp will also handle both XML and JSON responses and perform all necessary deserialization tasks, depending on the server response type. Therefore, you only need to add the `Accept` header if you want to deserialize the response manually. + +For example, only you'd only need these lines to make a request with JSON body: + +```csharp +var request = new RestRequest("address/update").AddJsonBody(updatedAddress); +var response = await client.PostAsync(request); +``` + +It's also possible to make the same call using `PostAsync` shorter syntax: + +```csharp +var response = await client.PostJsonAsync( + "address/update", updatedAddress, cancellationToken +); +``` + +Read more about serialization and deserialization [here](advanced/serialization.md). + +### Response + +When you use `ExecuteAsync`, you get an instance of `RestResponse` back. The response object has the `Content` property, which contains the response as string. You can find other useful properties there, like `StatusCode`, `ContentType` and so on. If the request wasn't successful, you'd get a response back with `IsSuccessful` property set to `false` and the error explained in the `ErrorException` and `ErrorMessage` properties. + +When using typed `ExecuteAsync`, you get an instance of `RestResponse` back, which is identical to `RestResponse` but also contains the `T Data` property with the deserialized response. + +None of `ExecuteAsync` overloads throw if the remote server returns an error. You can inspect the response and find the status code, error message, and, potentially, an exception. + +Extensions like `GetAsync` will not return the whole `RestResponse` but just a deserialized response. These extensions will throw an exception if the remote server returns an error. The exception details contain the status code returned by the server. diff --git a/docs/versioned_docs/version-v112/usage/_category_.json b/docs/versioned_docs/version-v112/usage/_category_.json new file mode 100644 index 000000000..bd2045cd6 --- /dev/null +++ b/docs/versioned_docs/version-v112/usage/_category_.json @@ -0,0 +1,7 @@ +{ + "label": "Using RestSharp", + "position": 3, + "link": { + "type": "generated-index" + } +} diff --git a/docs/versioned_docs/version-v112/usage/basics.md b/docs/versioned_docs/version-v112/usage/basics.md new file mode 100644 index 000000000..6bbb5594a --- /dev/null +++ b/docs/versioned_docs/version-v112/usage/basics.md @@ -0,0 +1,23 @@ +--- +sidebar_position: 2 +--- + +# RestSharp basics + +This page describes some of the essential properties and features of RestSharp. + +## What RestSharp does + +Essentially, RestSharp is a wrapper around `HttpClient` that allows you to do the following: +- Add default parameters of any kind (not just headers) to the client, once +- Add parameters of any kind to each request (query, URL segment, form, attachment, serialized body, header) in a straightforward way +- Serialize the payload to JSON or XML if necessary +- Set the correct content headers (content type, disposition, length, etc.) +- Handle the remote endpoint response +- Deserialize the response from JSON or XML if necessary + +## API client + +The best way to call an external HTTP API is to create a typed client, which encapsulates RestSharp calls and doesn't expose the `RestClient` instance in public. + +You can find an example of a Twitter API client on the [Example](example.md) page. diff --git a/docs/versioned_docs/version-v112/usage/client.md b/docs/versioned_docs/version-v112/usage/client.md new file mode 100644 index 000000000..e84b955f4 --- /dev/null +++ b/docs/versioned_docs/version-v112/usage/client.md @@ -0,0 +1,115 @@ +--- +sidebar_position: 3 +title: Creating the client +--- + +## Constructors + +A RestSharp client can be instantiated by one of its constructors. Two most commonly used constructors are: + +#### Only specify the base URL + +You can create an instance of `RestClient` with only a single parameter: the base URL. Even that isn't required as base URL can be left empty. In that case, you'd need to specify the absolute path for each call. When the base URL is set, you can use both relative and absolute path. + +```csharp +// Creates a client with default options to call a given base URL +var client = new RestClient("https://localhost:5000"); +``` + +#### Provide client options + +The most common way to create a client is to use the constructor with options. The options object has the type of `RestClientOptions`. +Here's an example of how to create a client using the same base path as in the previous sample, but with a couple additional settings: + +```csharp +// Creates a client using the options object +var options = new RestClientOptions("https://localhost:5000") { + MaxTimeout = 1000 +}; +var client = new RestClient(options); +``` + +#### Advanced configuration + +RestSharp can be configured with more tweaks, including default request options, how it should handle responses, how serialization works, etc. You can also provide your own instance of `HttpClient` or `HttpMessageHandler`. + +Read more about the advanced configuration of RestSharp on a [dedicated page](../advanced/configuration.md). + +## Simple factory + +Another way to create the client instance is to use a simple client factory. The factory will use the `BaseUrl` property of the client options to cache `HttpClient` instances. Every distinct base URL will get its own `HttpClient` instance. Other options don't affect the caching. Therefore, if you use different options for the same base URL, you'll get the same `HttpClient` instance, which will not be configured with the new options. Options that aren't applied _after_ the first client instance is created are: + +* `Credentials` +* `UseDefaultCredentials` +* `AutomaticDecompression` +* `PreAuthenticate` +* `FollowRedirects` +* `RemoteCertificateValidationCallback` +* `ClientCertificates` +* `MaxRedirects` +* `MaxTimeout` +* `UserAgent` +* `Expect100Continue` + +Constructor parameters to configure the `HttpMessageHandler` and default `HttpClient` headers configuration are also ignored for the cached instance as the factory only configures the handler once. + +You need to set the `useClientFactory` parameter to `true` in the `RestClient` constructor to enable the factory. + +```csharp +var options = new RestClientOptions("https://api.twitter.com/2"); +var client = new RestClient(options, useClientFactory: true); +``` + +## Reusing HttpClient + +RestSharp uses `HttpClient` internally to make HTTP requests. It's possible to reuse the same `HttpClient` instance for multiple `RestClient` instances. This is useful when you want to share the same connection pool between multiple `RestClient` instances. + +One way of doing it is to use `RestClient` constructors that accept an instance of `HttpClient` or `HttpMessageHandler` as an argument. Note that in that case not all the options provided via `RestClientOptions` will be used. Here is the list of options that will work: + +- `BaseAddress` is be used to set the base address of the `HttpClient` instance if base address is not set there already. +- `MaxTimeout` is used to cancel the call using the cancellation token source, so +- `UserAgent` will be added to the `RestClient.DefaultParameters` list as a HTTP header. This will be added to each request made by the `RestClient`, and the `HttpClient` instance will not be modified. This is to allow the `HttpClient` instance to be reused for scenarios where different `User-Agent` headers are required. +- `Expect100Continue` + +Another option is to use a simple HTTP client factory as described [above](#simple-factory). + +## Blazor support + +Inside a Blazor webassembly app, you can make requests to external API endpoints. Microsoft examples show how to do it with `HttpClient`, and it's also possible to use RestSharp for the same purpose. + +You need to remember that webassembly has some platform-specific limitations. Therefore, you won't be able to instantiate `RestClient` using all of its constructors. In fact, you can only use `RestClient` constructors that accept `HttpClient` or `HttpMessageHandler` as an argument. If you use the default parameterless constructor, it will call the option-based constructor with default options. The options-based constructor will attempt to create an `HttpMessageHandler` instance using the options provided, and it will fail with Blazor, as some of those options throw thw "Unsupported platform" exception. + +Here is an example how to register the `RestClient` instance globally as a singleton: + +```csharp +builder.Services.AddSingleton(new RestClient(new HttpClient())); +``` + +Then, on a page you can inject the instance: + +```html +@page "/fetchdata" +@using RestSharp +@inject RestClient _restClient +``` + +And then use it: + +```csharp +@code { + private WeatherForecast[]? forecasts; + + protected override async Task OnInitializedAsync() { + forecasts = await _restClient.GetJsonAsync("http://localhost:5104/weather"); + } + + public class WeatherForecast { + public DateTime Date { get; set; } + public int TemperatureC { get; set; } + public string? Summary { get; set; } + public int TemperatureF => 32 + (int)(TemperatureC / 0.5556); + } +} +``` + +In this case, the call will be made to a WebAPI server hosted at `http://localhost:5104/weather`. Remember that if the WebAPI server is not hosting the webassembly itself, it needs to have a CORS policy configured to allow the webassembly origin to access the API endpoint from the browser. diff --git a/docs/versioned_docs/version-v112/usage/example.md b/docs/versioned_docs/version-v112/usage/example.md new file mode 100644 index 000000000..6182d8ff3 --- /dev/null +++ b/docs/versioned_docs/version-v112/usage/example.md @@ -0,0 +1,152 @@ +--- +sidebar_position: 1 +--- + +# Example + +RestSharp works best as the foundation for a proxy class for your API. Each API would most probably require different settings for `RestClient`. Hence, a dedicated API class (and its interface) gives you sound isolation between different `RestClient` instances and make them testable. + +For example, let's look at a simple Twitter API v2 client, which uses OAuth2 machine-to-machine authentication. For it to work, you would need to have access to the Twitter Developers portal, a project, and an approved application inside the project with OAuth2 enabled. + +## Client model + +Before implementing an API client, we need to have a model for it. The model includes an abstraction for the client, which has functions for the API calls we are interested to implement. In addition, the client model would include the necessary request and response models. Usually those are simple classes or records without logic, which are often referred to as DTOs (data transfer objects). + +This example starts with a single function that retrieves one Twitter user. Lets being by defining the API client interface: + +```csharp +public interface ITwitterClient { + Task GetUser(string user); +} +``` + +As the function returns a `TwitterUser` instance, we need to define it as a model: + +```csharp +public record TwitterUser(string Id, string Name, string Username); +``` + +## Client implementation + +When that is done, we can implement the interface and add all the necessary code blocks to get a working API client. + +The client class needs the following: +- A constructor for passing API credentials +- A wrapped `RestClient` instance with the Twitter API base URI pre-configured +- An authenticator to support authorizing the client using Twitter OAuth2 authentication +- The actual function to get the user (to implement the `ITwitterClient` interface) + +Creating an authenticator is described [below](#authenticator). + +Here's how the client implementation could look like: + +```csharp +public class TwitterClient : ITwitterClient, IDisposable { + readonly RestClient _client; + + public TwitterClient(string apiKey, string apiKeySecret) { + var options = new RestClientOptions("https://api.twitter.com/2"); + _client = new RestClient(options); + } + + public async Task GetUser(string user) { + var response = await _client.GetAsync>( + "users/by/username/{user}", + new { user } + ); + return response!.Data; + } + + record TwitterSingleObject(T Data); + + public void Dispose() { + _client?.Dispose(); + GC.SuppressFinalize(this); + } +} +``` + +It is also possible to use ASP.NET Core Options for configuring the client, instead of passing the credentials as strings. For example, we can add a class for Twitter client options, and use it in a constructor: + +```csharp +public class TwitterClientOptions(string ApiKey, string ApiSecret); + +public TwitterClient(IOptions options) { + var opt = new RestClientOptions("https://api.twitter.com/2"); + _client = new RestClient(options); +} +``` + +Then, you can register and configure the client using ASP.NET Core dependency injection container. + +Right now, the client won't really work as Twitter API requires authentication. It's covered in the next section. + +## Authenticator + +Before we can call the API itself, we need to get a bearer token. Twitter exposes an endpoint `https://api.twitter.com/oauth2/token`. As it follows the OAuth2 conventions, the code can be used to create an authenticator for some other vendors. + +First, we need a model for deserializing the token endpoint response. OAuth2 uses snake case for property naming, so we need to decorate model properties with `JsonPropertyName` attribute: + +```csharp +record TokenResponse { + [JsonPropertyName("token_type")] + public string TokenType { get; init; } + [JsonPropertyName("access_token")] + public string AccessToken { get; init; } +} +``` + +Next, we create the authenticator itself. It needs the API key and API key secret to call the token endpoint using basic HTTP authentication. In addition, we can extend the list of parameters with the base URL to convert it to a more generic OAuth2 authenticator. + +The easiest way to create an authenticator is to inherit from the `AuthenticatorBase` base class: + +```csharp +public class TwitterAuthenticator : AuthenticatorBase { + readonly string _baseUrl; + readonly string _clientId; + readonly string _clientSecret; + + public TwitterAuthenticator(string baseUrl, string clientId, string clientSecret) : base("") { + _baseUrl = baseUrl; + _clientId = clientId; + _clientSecret = clientSecret; + } + + protected override async ValueTask GetAuthenticationParameter(string accessToken) { + Token = string.IsNullOrEmpty(Token) ? await GetToken() : Token; + return new HeaderParameter(KnownHeaders.Authorization, Token); + } +} +``` + +During the first call made by the client using the authenticator, it will find out that the `Token` property is empty. It will then call the `GetToken` function to get the token once and reuse the token going forward. + +Now, we need to implement the `GetToken` function in the class: + +```csharp +async Task GetToken() { + var options = new RestClientOptions(_baseUrl){ + Authenticator = new HttpBasicAuthenticator(_clientId, _clientSecret), + }; + using var client = new RestClient(options); + + var request = new RestRequest("oauth2/token") + .AddParameter("grant_type", "client_credentials"); + var response = await client.PostAsync(request); + return $"{response!.TokenType} {response!.AccessToken}"; +} +``` + +As we need to make a call to the token endpoint, we need our own short-lived instance of `RestClient`. Unlike the actual Twitter client, it will use the `HttpBasicAuthenticator` to send the API key and secret as the username and password. The client then gets disposed as we only use it once. + +Here we add a POST parameter `grant_type` with `client_credentials` as its value. At the moment, it's the only supported value. + +The POST request will use the `application/x-www-form-urlencoded` content type by default. + +::: note +Sample code provided on this page is a production code. For example, the authenticator might produce undesired side effect when multiple requests are made at the same time when the token hasn't been obtained yet. It can be solved rather than simply using semaphores or synchronized invocation. +::: + +## Final words + +This page demonstrates how an API client can be implemented as a typed, configurable client with its own interface. Usage of the client in applications is not covered here as different application types and target frameworks have their own idiomatic ways to use HTTP clients. \ No newline at end of file diff --git a/docs/versioned_docs/version-v112/usage/execute.md b/docs/versioned_docs/version-v112/usage/execute.md new file mode 100644 index 000000000..36343f793 --- /dev/null +++ b/docs/versioned_docs/version-v112/usage/execute.md @@ -0,0 +1,172 @@ +--- +sidebar_position: 5 +title: Making calls +--- + +## Executing requests + +Once you've added all the parameters to your `RestRequest`, you are ready to make a request. + +`RestClient` has a single function for this: + +```csharp +public async Task ExecuteAsync( + RestRequest request, + CancellationToken cancellationToken = default +) +``` + +You can also avoid setting the request method upfront and use one of the overloads: + +```csharp +Task ExecuteGetAsync(RestRequest request, CancellationToken cancellationToken) +Task ExecutePostAsync(RestRequest request, CancellationToken cancellationToken) +Task ExecutePutAsync(RestRequest request, CancellationToken cancellationToken) +Task ExecuteDeleteAsync(RestRequest request, CancellationToken cancellationToken) +Task ExecuteHeadAsync(RestRequest request, CancellationToken cancellationToken) +Task ExecuteOptionsAsync(RestRequest request, CancellationToken cancellationToken) +``` + +When using any of those methods, you will get the response content as string in `response.Content`. + +RestSharp can deserialize the response for you. To use that feature, use one of the generic overloads: + +```csharp +Task> ExecuteAsync(RestRequest request, CancellationToken cancellationToken) +Task> ExecuteGetAsync(RestRequest request, CancellationToken cancellationToken) +Task> ExecutePostAsync(RestRequest request, CancellationToken cancellationToken) +Task> ExecutePutAsync(RestRequest request, CancellationToken cancellationToken) +Task> ExecuteDeleteAsync(RestRequest request, CancellationToken cancellationToken) +Task> ExecuteHeadAsync(RestRequest request, CancellationToken cancellationToken) +Task> ExecuteOptionsAsync(RestRequest request, CancellationToken cancellationToken) +``` + +:::note Beware of errors +All the overloads with names starting with `Execute` don't throw an exception if the server returns an error. Read more about it [here](../advanced/error-handling.md). +It allows you to inspect responses and handle remote server errors gracefully. Overloads without `Execute` prefix throw exceptions in case of any error, so you'd need to ensure to handle exceptions properly. +::: + +If you just need a deserialized response, you can use one of the extensions: + +```csharp +Task GetAsync(RestRequest request, CancellationToken cancellationToken) +Task PostAsync(RestRequest request, CancellationToken cancellationToken) +Task PutAsync(RestRequest request, CancellationToken cancellationToken) +Task PatchAsync(RestRequest request, CancellationToken cancellationToken) +Task DeleteAsync(RestRequest request, CancellationToken cancellationToken) +Task HeadAsync(RestRequest request, CancellationToken cancellationToken) +Task OptionsAsync(RestRequest request, CancellationToken cancellationToken) +``` + +Those extensions will throw an exception if the server returns an error, as there's no other way to float the error back to the caller. + +The `IRestClient` interface also has extensions for making requests without deserialization, which throw an exception if the server returns an error even if the client is configured to not throw exceptions. + +```csharp +Task GetAsync(RestRequest request, CancellationToken cancellationToken) +Task PostAsync(RestRequest request, CancellationToken cancellationToken) +Task PutAsync(RestRequest request, CancellationToken cancellationToken) +Task PatchAsync(RestRequest request, CancellationToken cancellationToken) +Task DeleteAsync(RestRequest request, CancellationToken cancellationToken) +Task HeadAsync(RestRequest request, CancellationToken cancellationToken) +Task OptionsAsync(RestRequest request, CancellationToken cancellationToken) +``` + +### Sync calls + +The preferred way for making requests is to execute them asynchronously as HTTP calls are IO-bound operations. +If you are unable to make async calls, all the functions about have sync overloads, which have the same names without `Async` suffix. +For example, for making a sync `GET` call you can use `ExecuteGet(request)` or `Get`, etc. + +## Requests without body + +Some HTTP methods don't suppose to be used with request body. For those methods, RestSharp supports making simplified calls without using `RestRequest`. All you need is to provide the resource path as a string. + +For example, you can make a `DELETE` call like this: + +```csharp +var response = await client.ExecuteDeleteAsync($"order/delete/{orderId}", cancellationToken); +``` + +Similarly, you can make `GET` calls with or without deserialization of the response using `ExecuteGetAsync(resource)`, `GetAsync(resource)`, `ExecuteGetAsync(resource)`, and `GetAsync(resource)` (see below). + +## JSON requests + +RestSharp provides an easier API for making calls to endpoints that accept and return JSON. + +### GET calls + +To make a simple `GET` call and get a deserialized JSON response with a pre-formed resource string, use this: + +```csharp +var response = await client.GetAsync("endpoint?foo=bar", cancellationToken); +``` + +:::note +In v111, `GetJsonAsync` is renamed to `GetAsync`. +::: + +You can also use a more advanced extension that uses an object to compose the resource string: + +```csharp +var client = new RestClient("https://example.org"); +var args = new { + id = "123", + foo = "bar" +}; +// Will make a call to https://example.org/endpoint/123?foo=bar +var response = await client.GetAsync("endpoint/{id}", args, cancellationToken); +``` + +It will search for the URL segment parameters matching any of the object properties and replace them with values. All the other properties will be used as query parameters. + +One note about `GetAsync` is that it will deserialize the response with any supported content type, not only JSON. + +### POST calls + +Similar things are available for `POST` requests. + +```csharp +var request = new CreateOrder("123", "foo", 10100); +// Will post the request object as JSON to "orders" and returns a +// JSON response deserialized to OrderCreated +var result = client.PostJsonAsync("orders", request, cancellationToken); +``` + +```csharp +var request = new CreateOrder("123", "foo", 10100); +// Will post the request object as JSON to "orders" and returns a +// status code, not expecting any response body +var statusCode = client.PostJsonAsync("orders", request, cancellationToken); +``` + +The same two extensions also exist for `PUT` requests (`PutJsonAsync`); + +## Downloading binary data + +There are two functions that allow you to download binary data from the remote API. + +First, there's `DownloadDataAsync`, which returns `Task`. This function allows you to open a stream reader and asynchronously stream large responses to memory or disk. + +## JSON streaming + +For HTTP API endpoints that stream the response data (like [Twitter search stream](https://developer.twitter.com/en/docs/twitter-api/tweets/filtered-stream/api-reference/get-tweets-search-stream)) you can use RestSharp with `StreamJsonAsync`, which returns an `IAsyncEnumerable`: + +```csharp +public async IAsyncEnumerable SearchStream( + [EnumeratorCancellation] CancellationToken cancellationToken = default +) { + var response = _client.StreamJsonAsync>( + "tweets/search/stream", cancellationToken + ); + + await foreach (var item in response.WithCancellation(cancellationToken)) { + yield return item.Data; + } +} +``` + +The main limitation of this function is that it expects each JSON object to be returned as a single line. It is unable to parse the response by combining multiple lines into a JSON string. + diff --git a/docs/versioned_docs/version-v112/usage/request.md b/docs/versioned_docs/version-v112/usage/request.md new file mode 100644 index 000000000..76343b347 --- /dev/null +++ b/docs/versioned_docs/version-v112/usage/request.md @@ -0,0 +1,356 @@ +--- +sidebar_position: 4 +title: Preparing requests +--- + +## Create a request + +Before making a request using `RestClient`, you need to create a request instance: + +```csharp +var request = new RestRequest(resource); // resource is the sub-path of the client base path +``` + +The default request type is `GET` and you can override it by setting the `Method` property. You can also set the method using the constructor overload: + +```csharp +var request = new RestRequest(resource, Method.Post); +``` + +After you've created a `RestRequest`, you can add parameters to it. Below, you can find all the parameter types supported by RestSharp. + +## Request headers + +Adds the header parameter as an HTTP header that is sent along with the request. The header name is the parameter's name and the header value is the value. + +You can use one of the following request methods to add a header parameter: + +```csharp +AddHeader(string name, string value); +AddHeader(string name, T value); // value will be converted to string +AddOrUpdateHeader(string name, string value); // replaces the header if it already exists +``` + +For example: + +```csharp +var request = new RestRequest("/path").AddHeader("X-Key", someKey); +``` + +You can also add header parameters to the client, and they will be added to every request made by the client. This is useful for adding authentication headers, for example. + +```csharp +client.AddDefaultHeader(string name, string value); +``` + +:::warning Avoid setting Content-Type header +RestSharp will use the correct content type by default. Avoid adding the `Content-Type` header manually to your requests unless you are absolutely sure it is required. You can add a custom content type to the [body parameter](#request-body) itself. +::: + +## Get or Post parameters + +The default RestSharp parameter type is `GetOrPostParameter`. You can add `GetOrPost` parameter to the request using the `AddParameter` function: + +```csharp +request + .AddParameter("name1", "value1") + .AddParameter("name2", "value2"); +``` + +`GetOrPost` behaves differently based on the HTTP method. If you execute a `GET` call, RestSharp will append the parameters to the URL in the form `url?name1=value1&name2=value2`. + +On a `POST` or `PUT` requests, it depends on whether you have files attached to a request. +If not, the parameters will be sent as the body of the request in the form `name1=value1&name2=value2`. Also, the request will be sent as `application/x-www-form-urlencoded`. + +In both cases, name and value will automatically be URL-encoded, unless specified otherwise: + +```csharp +request.AddParameter("name", "Væ üé", false); // don't encode the value +``` + +If you have files, RestSharp will send a `multipart/form-data` request. Your parameters will be part of this request in the form: + +``` +Content-Type: text/plain; charset=utf-8 +Content-Disposition: form-data; name="parameterName" + +ParameterValue +``` + +Sometimes, you need to override the default content type for the parameter when making a multipart form call. It's possible to do by setting the `ContentType` property of the parameter object. As an example, the code below will create a POST parameter with JSON value, and set the appropriate content type: + +```csharp +var parameter = new GetOrPostParameter("someJson", "{\"attributeFormat\":\"pdf\"}") { + ContentType = "application/json" +}; +request.AddParameter(parameter); +``` + +When the request is set to use multipart content, the parameter will be sent as part of the request with the specified content type: + +``` +Content-Type: application/json; charset=utf-8 +Content-Disposition: form-data; name="someJson" + +{"attributeFormat":"pdf"} +``` + +You can also add `GetOrPost` parameter as a default parameter to the client. This will add the parameter to every request made by the client. + +```csharp +client.AddDefaultParameter("foo", "bar"); +``` + +It will work the same way as request parameters, except that it will be added to every request. + +## Query string + +`QueryString` works like `GetOrPost`, except that it always appends the parameters to the url in the form `url?name1=value1&name2=value2`, regardless of the request method. + +Example: + +```csharp +var client = new RestClient("https://search.me"); +var request = new RestRequest("search") + .AddParameter("foo", "bar"); +var response = await client.GetAsync(request); +``` + +It will send a `GET` request to `https://search.me/search?foo=bar`. + +For `POST`-style requests you need to add the query string parameter explicitly: + +```csharp +request.AddQueryParameter("foo", "bar"); +``` + +In some cases, you might need to prevent RestSharp from encoding the query string parameter. +To do so, set the `encode` argument to `false` when adding the parameter: + +```csharp +request.AddQueryParameter("foo", "bar/fox", false); +``` + +You can also add a query string parameter as a default parameter to the client. This will add the parameter to every request made by the client. + +```csharp +client.AddDefaultQueryParameter("foo", "bar"); +``` + +The line above will result in all the requests made by that client instance to have `foo=bar` in the query string for all the requests made by that client. + +## Using AddObject + +You can avoid calling `AddParameter` multiple times if you collect all the parameters in an object, and then use `AddObject`. +For example, this code: + +```csharp +var params = new { + status = 1, + priority = "high", + ids = new [] { "123", "456" } +}; +request.AddObject(params); +``` + +is equivalent to: + +```csharp +request.AddParameter("status", 1); +request.AddParameter("priority", "high"); +request.AddParameter("ids", "123,456"); +``` + +Remember that `AddObject` only works if your properties have primitive types. It also works with collections of primitive types as shown above. + +If you need to override the property name or format, you can do it using the `RequestProperty` attribute. For example: + +```csharp +public class RequestModel { + // override the name and the format + [RequestProperty(Name = "from_date", Format = "d")] + public DateTime FromDate { get; set; } +} + +// add it to the request +request.AddObject(new RequestModel { FromDate = DateTime.Now }); +``` + +In this case, the request will get a GET or POST parameter named `from_date` and its value would be the current date in short date format. + +## Using AddObjectStatic + +Request function `AddObjectStatic(...)` allows using pre-compiled expressions for getting property values. Compared to `AddObject` that uses reflections for each call, `AddObjectStatic` caches functions to retrieve properties from an object of type `T`, so it works much faster. + +You can instruct `AddObjectStatic` to use custom parameter names and formats, as well as supply the list of properties than need to be used as parameters. The last option could be useful if the type `T` has properties that don't need to be sent with HTTP call. + +To use custom parameter name or format, use the `RequestProperty` attribute. For example: + +```csharp +class TestObject { + [RequestProperty(Name = "some_data")] + public string SomeData { get; set; } + + [RequestProperty(Format = "d")] + public DateTime SomeDate { get; set; } + + [RequestProperty(Name = "dates", Format = "d")] + public DateTime[] DatesArray { get; set; } + + public int Plain { get; set; } + public DateTime[] PlainArray { get; set; } +} +``` + +## URL segment parameter + +Unlike `GetOrPost`, URL segment parameter replaces placeholder values in the request URL: + +```csharp +var request = new RestRequest("health/{entity}/status") + .AddUrlSegment("entity", "s2"); +``` + +When the request executes, RestSharp will try to match any `{placeholder}` with a parameter of that name (without the `{}`) and replace it with the value. So the above code results in `health/s2/status` being the URL. + +You can also add `UrlSegment` parameter as a default parameter to the client. This will add the parameter to every request made by the client. + +```csharp +client.AddDefaultUrlSegment("foo", "bar"); +``` + +## Cookies + +You can add cookies to a request using the `AddCookie` method: + +```csharp +request.AddCookie("foo", "bar"); +``` + +The simple two-parameter form defers domain resolution until execution time — the cookie domain is inferred from the request URL. If you need to specify the path and domain explicitly, use the four-parameter overload: + +```csharp +request.AddCookie("foo", "bar", "/path", "example.com"); +``` + +RestSharp will add cookies from the request as cookie headers and then extract the matching cookies from the response. You can observe and extract response cookies using the `RestResponse.Cookies` properties, which has the `CookieCollection` type. + +There is a `CookieContainer` instance on the request level. You can either assign the pre-populated container to `request.CookieContainer`, or let the container be created automatically at execution time. The four-parameter `AddCookie` overload populates the container immediately, while the two-parameter form stores cookies in `PendingCookies` until the request is executed. The container is used to extract all the cookies from it and create cookie headers for the request instead of using the container directly. It's because the cookie container is normally configured on the `HttpClientHandler` level and cookies are shared between requests made by the same client. In most of the cases this behaviour can be harmful. + +If your use case requires sharing cookies between requests made by the client instance, you can use the client-level `CookieContainer`, which you must provide as the options' property. You can add cookies to the container using the container API. No response cookies, however, would be auto-added to the container, but you can do it in code by getting cookies from the `Cookies` property of the response and adding them to the client-level container available via `IRestClient.Options.CookieContainer` property. + +## Request Body + +RestSharp supports multiple ways to add a request body: +- `AddJsonBody` for JSON payloads +- `AddXmlBody` for XML payloads +- `AddStringBody` for pre-serialized payloads + +We recommend using `AddJsonBody` or `AddXmlBody` methods instead of `AddParameter` with type `BodyParameter`. Those methods will set the proper request type and do the serialization work for you. + +When you make a `POST`, `PUT` or `PATCH` request and added `GetOrPost` [parameters](#get-or-post-parameters), RestSharp will send them as a URL-encoded form request body by default. When a request also has files, it will send a `multipart/form-data` request. You can also instruct RestSharp to send the body as `multipart/form-data` by setting the `AlwaysMultipartFormData` property to `true`. + +You can specify a custom body content type if necessary. The `contentType` argument is available in all the overloads that add a request body. + +It is not possible to add client-level default body parameters. + +### String body + +If you have a pre-serialized payload like a JSON string, you can use `AddStringBody` to add it as a body parameter. You need to specify the content type, so the remote endpoint knows what to do with the request body. For example: + +```csharp +const json = "{ data: { foo: \"bar\" } }"; +request.AddStringBody(json, ContentType.Json); +``` + +### JSON body + +When you call `AddJsonBody`, it does the following for you: + +- Instructs the RestClient to serialize the object parameter as JSON when making a request +- Sets the content type to `application/json` +- Sets the internal data type of the request body to `DataType.Json` + +Here is the example: + +```csharp +var param = new MyClass { IntData = 1, StringData = "test123" }; +request.AddJsonBody(param); +``` + +It is possible to override the default content type by supplying the `contentType` argument. For example: + +```csharp +request.AddJsonBody(param, "text/x-json"); +``` + +If you use a pre-serialized string with `AddJsonBody`, it will be sent as-is. The `AddJsonBody` will detect if the parameter is a string and will add it as a string body with JSON content type. +Essentially, it means that top-level strings won't be serialized as JSON when you use `AddJsonBody`. To overcome this issue, you can use an overload of `AddJsonBody`, which allows you to tell RestSharp to serialize the string as JSON: + +```csharp +const string payload = @" +""requestBody"": { + ""content"": { + ""application/json"": { + ""schema"": { + ""type"": ""string"" + } + } + } +},"; +request.AddJsonBody(payload, forceSerialize: true); // the string will be serialized +request.AddJsonBody(payload); // the string will NOT be serialized and will be sent as-is +``` + +### XML body + +When you call `AddXmlBody`, it does the following for you: + +- Instructs the RestClient to serialize the object parameter as XML when making a request +- Sets the content type to `application/xml` +- Sets the internal data type of the request body to `DataType.Xml` + +:::warning +Do not send XML string to `AddXmlBody`; it won't work! +::: + +## Uploading files + +To add a file to the request you can use the `RestRequest` function called `AddFile`. The main function accepts the `FileParameter` argument: + +```csharp +request.AddFile(fileParameter); +``` + +You can instantiate the file parameter using `FileParameter.Create` that accepts a bytes array, or `FileParameter.FromFile`, which will load the file from disk. + +There are also extension functions that wrap the creation of `FileParameter` inside: + +```csharp +// Adds a file from disk +AddFile(parameterName, filePath, contentType); + +// Adds an array of bytes +AddFile(parameterName, bytes, fileName, contentType); + +// Adds a stream returned by the getFile function +AddFile(parameterName, getFile, fileName, contentType); +``` + +Remember that `AddFile` will set all the necessary headers, so please don't try to set content headers manually. + +You can also provide file upload options to the `AddFile` call. The options are: +- `DisableFilenameEncoding` (default `false`): if set to `true`, RestSharp will not encode the file name in the `Content-Disposition` header +- `DisableFilenameStar` (default `true`): if set to `true`, RestSharp will not add the `filename*` parameter to the `Content-Disposition` header + +Example of using the options: + +```csharp +var options = new FileParameterOptions { + DisableFilenameEncoding = true, + DisableFilenameStar = false +}; +request.AddFile("file", filePath, options: options); +``` + +The options specified in the snippet above usually help when you upload files with non-ASCII characters in their names. diff --git a/docs/versioned_docs/version-v112/usage/response.md b/docs/versioned_docs/version-v112/usage/response.md new file mode 100644 index 000000000..dbaf302b4 --- /dev/null +++ b/docs/versioned_docs/version-v112/usage/response.md @@ -0,0 +1,36 @@ +--- +sidebar_position: 6 +title: Handling responses +--- + +All `Execute{Method}Async` functions return an instance of `RestResponse`. Similarly, `Execute{Method}Async` return a generic instance of `RestResponse` where `T` is the response object type. + +Response object contains the following properties: + +| Property | Type | Description | +|--------------------------|-----------------------------------------------------|------------------------------------------------------------------------------------------| +| `Request` | `RestRequest` | Request instance that was used to get the response. | +| `ContentType` | `string?` | Response content type. `Null` if response has no content. | +| `ContentLength` | `long?` | Response content length. `Null` if response has no content. | +| `ContentEncoding` | `ICollection` | Content encoding collection. Empty if response has no content. | +| `Content` | `string?` | Response content as string. `Null` if response has no content. | +| `IsSuccessfulStatusCode` | `bool` | Indicates if response was successful, so no errors were reported by the server. | +| `ResponseStatus` | `None`, `Completed`, `Error`, `TimedOut`, `Aborted` | Response completion status. Note that completed responses might still return errors. | +| `IsSuccessful` | `bool` | `True` when `IsSuccessfulStatusCode` is `true` and `ResponseStatus` is `Completed`. | +| `StatusDescription` | `string?` | Response status description, if available. | +| `RawBytes` | `byte[]?` | Response content as byte array. `Null` if response has no content. | +| `ResponseUri` | `Uri?` | URI of the response, which might be different from request URI in case of redirects. | +| `Server` | `string?` | Server header value of the response. | +| `Cookies` | `CookieCollection?` | Collection of cookies received with the response, if any. | +| `Headers` | Collection of `HeaderParameter` | Response headers. | +| `ContentHeaders` | Collection of `HeaderParameter` | Response content headers. | +| `ErrorMessage` | `string?` | Transport or another non-HTTP error generated while attempting request. | +| `ErrorException` | `Exception?` | Exception thrown when executing the request, if any. | +| `Version` | `Version?` | HTTP protocol version of the request. | +| `RootElement` | `string?` | Root element of the serialized response content, only works if deserializer supports it. | + +In addition, `RestResponse` has one additional property: + +| Property | Type | Description | +|----------|------|-----------------------------------------------------------------------------------------------------------------------------------------------------------| +| `Data` | `T?` | Deserialized response object. `Null` if there's no content in the response, deserializer failed to understand the response content, or if request failed. | diff --git a/docs/versioned_docs/version-v113/advanced/_category_.json b/docs/versioned_docs/version-v113/advanced/_category_.json new file mode 100644 index 000000000..f395bdfe4 --- /dev/null +++ b/docs/versioned_docs/version-v113/advanced/_category_.json @@ -0,0 +1,7 @@ +{ + "label": "Advanced topics", + "position": 4, + "link": { + "type": "generated-index" + } +} diff --git a/docs/versioned_docs/version-v113/advanced/authenticators.md b/docs/versioned_docs/version-v113/advanced/authenticators.md new file mode 100644 index 000000000..14196d97c --- /dev/null +++ b/docs/versioned_docs/version-v113/advanced/authenticators.md @@ -0,0 +1,185 @@ +# Authenticators + +RestSharp includes authenticators for basic HTTP, OAuth1 and token-based (JWT and OAuth2). + +There are two ways to set the authenticator: client-wide or per-request. + +Set the client-wide authenticator by assigning the `Authenticator` property of `RestClientOptions`: + +```csharp +var options = new RestClientOptions("https://example.com") { + Authenticator = new HttpBasicAuthenticator("username", "password") +}; +var client = new RestClient(options); +``` + +To set the authenticator per-request, assign the `Authenticator` property of `RestRequest`: + +```csharp +var request = new RestRequest("/api/users/me") { + Authenticator = new HttpBasicAuthenticator("username", "password") +}; +var response = await client.ExecuteAsync(request, cancellationToken); +``` + +## Basic authentication + +The `HttpBasicAuthenticator` allows you pass a username and password as a basic `Authorization` header using a base64 encoded string. + +```csharp +var options = new RestClientOptions("https://example.com") { + Authenticator = new HttpBasicAuthenticator("username", "password") +}; +var client = new RestClient(options); +``` + +## OAuth1 + +For OAuth1 authentication the `OAuth1Authenticator` class provides static methods to help generate an OAuth authenticator. +OAuth1 authenticator will add the necessary OAuth parameters to the request, including signature. + +The authenticator will use `HMAC SHA1` to create a signature by default. +Each static function to create the authenticator allows you to override the default and use another method to generate the signature. + +### Request token + +Getting a temporary request token is the usual first step in the 3-legged OAuth1 flow. +Use `OAuth1Authenticator.ForRequestToken` function to get the request token authenticator. +This method requires a `consumerKey` and `consumerSecret` to authenticate. + +```csharp +var options = new RestClientOptions("https://api.twitter.com") { + Authenticator = OAuth1Authenticator.ForRequestToken(consumerKey, consumerSecret) +}; +var client = new RestClient(options); +var request = new RestRequest("oauth/request_token"); +``` + +The response should contain the token and the token secret, which can then be used to complete the authorization process. +If you need to provide the callback URL, assign the `CallbackUrl` property of the authenticator to the callback destination. + +### Access token + +Getting an access token is the usual third step in the 3-legged OAuth1 flow. +This method retrieves an access token when provided `consumerKey`, `consumerSecret`, `oauthToken`, and `oauthTokenSecret`. +If you don't have a token for this call, you need to make a call to get the request token as described above. + +```csharp +var authenticator = OAuth1Authenticator.ForAccessToken( + consumerKey, consumerSecret, oauthToken, oauthTokenSecret +); +var options = new RestClientOptions("https://api.twitter.com") { + Authenticator = authenticator +}; +var client = new RestClient(options); +var request = new RestRequest("oauth/access_token"); +``` + +If the second step in 3-leg OAuth1 flow returned a verifier value, you can use another overload of `ForAccessToken`: + +```csharp +var authenticator = OAuth1Authenticator.ForAccessToken( + consumerKey, consumerSecret, oauthToken, oauthTokenSecret, verifier +); +``` + +The response should contain the access token that can be used to make calls to protected resources. + +For refreshing access tokens, use one of the two overloads of `ForAccessToken` that accept `sessionHandle`. + +### Protected resource + +When the access token is available, use `ForProtectedResource` function to get the authenticator for accessing protected resources. + +```csharp +var authenticator = OAuth1Authenticator.ForAccessToken( + consumerKey, consumerSecret, accessToken, accessTokenSecret +); +var options = new RestClientOptions("https://api.twitter.com/1.1") { + Authenticator = authenticator +}; +var client = new RestClient(options); +var request = new RestRequest("statuses/update.json", Method.Post) + .AddParameter("status", "Hello Ladies + Gentlemen, a signed OAuth request!") + .AddParameter("include_entities", "true"); +``` + +### xAuth + +xAuth is a simplified version of OAuth1. It allows sending the username and password as `x_auth_username` and `x_auth_password` request parameters and directly get the access token. xAuth is not widely supported, but RestSharp still allows using it. + +Create an xAuth authenticator using `OAuth1Authenticator.ForClientAuthentication` function: + +```csharp +var authenticator = OAuth1Authenticator.ForClientAuthentication( + consumerKey, consumerSecret, username, password +); +``` + +### 0-legged OAuth + +The access token authenticator can be used in 0-legged OAuth scenarios by providing `null` for the `consumerSecret`. + +```csharp +var authenticator = OAuth1Authenticator.ForAccessToken( + consumerKey, null, oauthToken, oauthTokenSecret +); +``` + +## OAuth2 + +RestSharp has two very simple authenticators to send the access token as part of the request. + +`OAuth2UriQueryParameterAuthenticator` accepts the access token as the only constructor argument, and it will send the provided token as a query parameter `oauth_token`. + +`OAuth2AuthorizationRequestHeaderAuthenticator` has two constructors. One only accepts a single argument, which is the access token. The other constructor also allows you to specify the token type. The authenticator will then add an `Authorization` header using the specified token type or `OAuth` as the default token type, and the token itself. + +For example: + +```csharp +var authenticator = new OAuth2AuthorizationRequestHeaderAuthenticator( + token, "Bearer" +); +var options = new RestClientOptions("https://example.com") { + Authenticator = authenticator +}; +var client = new RestClient(options); +``` + +The code above will tell RestSharp to send the bearer token with each request as a header. Essentially, the code above does the same as the sample for `JwtAuthenticator` below. + +As those authenticators don't do much to get the token itself, you might be interested in looking at our [sample OAuth2 authenticator](../usage/example.md#authenticator), which requests the token on its own. + +## JWT + +The JWT authentication can be supported by using `JwtAuthenticator`. It is a very simple class that can be constructed like this: + +```csharp +var authenticator = new JwtAuthenticator(myToken); +var options = new RestClientOptions("https://example.com") { + Authenticator = authenticator +}; +var client = new RestClient(options); +``` + +For each request, it will add an `Authorization` header with the value `Bearer `. + +As you might need to refresh the token from, you can use the `SetBearerToken` method to update the token. + +## Custom authenticator + +You can write your own implementation by implementing `IAuthenticator` and +registering it with your RestClient: + +```csharp +var authenticator = new SuperAuthenticator(); // implements IAuthenticator +var options = new RestClientOptions("https://example.com") { + Authenticator = authenticator +}; +var client = new RestClient(options); +``` + +The `Authenticate` method is the very first thing called upon calling `RestClient.Execute` or `RestClient.Execute`. +It gets the `RestRequest` currently being executed giving you access to every part of the request data (headers, parameters, etc.) + +You can find an example of a custom authenticator that fetches and uses an OAuth2 bearer token [here](../usage/example.md#authenticator). diff --git a/docs/versioned_docs/version-v113/advanced/configuration.md b/docs/versioned_docs/version-v113/advanced/configuration.md new file mode 100644 index 000000000..f15f56d7f --- /dev/null +++ b/docs/versioned_docs/version-v113/advanced/configuration.md @@ -0,0 +1,230 @@ +--- +title: Configuration +description: Learn how to configure RestClient for non-trivial use cases. +sidebar_position: 1 +--- + +# Configuring RestClient + +This page describes how to create and configure `RestClient`. + +## Basic configuration + +The primary `RestClient` constructor accepts an instance of `RestClientOptions`. Most of the time, default option values don't need to be changed. However, in some cases, you'd want to configure the client differently, so you'd need to change some of the options in your code. The constructor also contains a few optional parameters for additional configuration that is not covered by client options. Here's the constructor signature: + +```csharp +public RestClient( + RestClientOptions options, + ConfigureHeaders? configureDefaultHeaders = null, + ConfigureSerialization? configureSerialization = null, + bool useClientFactory = false +) +``` + +Constructor parameters are: + +| Name | Description | Mandatory | +|-------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------| +| options | Client options | Yes | +| configureDefaultHeaders | Function to configure headers. Allows to configure default headers for `HttpClient`. Most of the time you'd prefer using `client.AddDefaultHeader` instead. | No | +| configureSerialization | Function to configure client serializers with non-default options or to use a different serializer ([learn more](serialization.md)) | No | +| useClientFactory | Instructs the client to use `SimpleFactory` ([learn more](../usage/client.md#simple-factory)) to get an `HttpClient` instance | No | + +Here's an example of how to create a client using client options: + +```csharp +var options = new RestClientOptions("https://localhost:5000/api") { + DisableCharset = true +}; +var client = new RestClient(options); +``` + +When you only need to set the base URL, you can use a simplified constructor: + +```csharp +var client = new RestClient("https://localhost:5000/api"); +``` + +The simplified constructor will create an instance of client options and set the base URL provided as the constructor argument. + +Finally, you can override properties of default options using a configuration function. Here's the constructor signature that supports this method: + +```csharp +public RestClient( + ConfigureRestClient? configureRestClient = null, + ConfigureHeaders? configureDefaultHeaders = null, + ConfigureSerialization? configureSerialization = null, + bool useClientFactory = false +) +``` + +For example: + +```csharp +var client = new RestClient(options => { + options.BaseUrl = new Uri("https://localhost:5000/api"); + options.DisableCharset = true +}); +``` + +You can also provide the base URL as a constructor argument like this: + +```csharp +var client = new RestClient("https://localhost:5000/api", options => { + options.DisableCharset = true +}); +``` + +## Using custom HttpClient + +By default, RestSharp creates an instance of `HttpClient` configured using the client options, and keeps it during the lifetime of the client. When the `RestClient` instance gets disposed, it also disposes the `HttpClient` instance. + +There might be a case when you need to provide your own `HttpClient`. For example, you would want to use `HttpClient` created by HTTP client factory. RestSharp allows you to do it by using additional constructors. These constructors are: + +```csharp +// Create a client using an existing HttpClient and RestClientOptions (optional) +public RestClient( + HttpClient httpClient, + RestClientOptions? options, + bool disposeHttpClient = false, + ConfigureSerialization? configureSerialization = null +) + +// Create a client using an existing HttpClient and optional RestClient configuration function +public RestClient( + HttpClient httpClient, + bool disposeHttpClient = false, + ConfigureRestClient? configureRestClient = null, + ConfigureSerialization? configureSerialization = null +) +``` + +The `disposeHttpClient` argument tells the client to dispose `HttpClient` when the client itself gets disposed. It's set to `false` by default as when the `HttpClient` is provided from the outside, it should normally be disposed on the outside as well. + +## Using custom message handler + +Unless you use an external instance of `HttpClient`, the `RestClient` creates one when being constructed, and it will use the default HTTP message handler, configured using `RestClientOptions`. Normally, you'd get a `SocketHttpHandler` with modern .NET, and `WinHttpHandler` with .NET Framework. + +There might be a case when you need to configure the HTTP message handler. For example, you want to add a delegating message handler. RestSharp allows you to do it by using additional constructors. There's one constructor that allows you to pass the custom `HttpMessageHandler`: + +```csharp +public RestClient( + HttpMessageHandler handler, + bool disposeHandler = true, + ConfigureRestClient? configureRestClient = null, + ConfigureSerialization? configureSerialization = null +) +``` + +This constructor will create a new `HttpClient` instance using the provided message handler. As RestSharp will dispose the `HttpClient` instance when the `RestClient` instance gets disposed, the handler will be disposed as well. If you want to change that and keep the handler, set the `disposeHandler` parameter to `false`. + +:::note +When using a custom message handler, RestSharp **will not** configure it with client options, which are normally used to configure the handler created by RestSharp. +::: + +Another way to customize the message handler is to allow RestSharp to create a handler, but then configure it, or wrap it in a delegating handler. It can be done by using the `RestClientOptions.ConfigureMessageHandler` property. It can be set to a function that receives the handler created by RestSharp and returned either the same handler with different settings, or a new handler. + +For example, if you want to use `MockHttp` and its handler for testing, you can do it like this: + +```csharp +var mockHttp = new MockHttpMessageHandler(); +// Configure the MockHttp handler to do the checks +... + +var options = new RestClientOptions(Url) { + ConfigureMessageHandler = _ => mockHttp +}; +using var client = new RestClient(options); +``` + +In this example, we are reassigning the handler to MockHttp, so the handler created by RestSharp isn't used. In other cases you want to use delegating handlers as middleware, so you'd pass the handler created by RestSharp to the delegating handler: + +```csharp +var options = new RestClientOptions(Url) { + ConfigureMessageHandler = handler => new MyDelegatingHandler(handler) +}; +using var client = new RestClient(options); +``` + +## Client options + +RestSharp allows configuring `RestClient` using client options, as mentioned at the beginning of this page. Below, you find more details about available options. + +| Option | Description | +|----------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| `BaseUrl` | Client base URL. It can also be provided as the `RestClientOptions` constructor argument. | +| `ConfigureMessageHandler` | Configures the HTTP message handler (see above). | +| `CalculateResponseStatus` | Function to calculate a different response status from `HttpResponseMessage`. By default, the request is considered as complete if it returns a successful status code or 404. | +| `Authenticator` | Client-level authenticator. Read more about authenticators [here](authenticators.md). | +| `Interceptors` | A collector of interceptors. Read more about interceptors [here](interceptors.md). | +| `Credentials` | Instance of `ICredentials` used for NTLM or Kerberos authentication. Not supported in browsers. | +| `UseDefaultCredentials` | Whether to use default OS credentials for NTLM or Kerberos authentication. Not supported in browsers. | +| `DisableCharset` | When set to `true`, the `Content-Type` header won't have the `charset` portion. Some older web servers don't understand the `charset` portion in the header and fail to process the request. | +| `AutomaticDecompression` | Allows customizing supported decompression methods. Default is `All` except for .NET Framework that only support `GZip`. Not supported in browsers. | +| `MaxRedirects` | The number of redirects to follow. Not supported in browsers. | +| `ClientCertificates` | A collection of X.509 client certificates to be used for authentication. Not supported in browsers. | +| `Proxy` | Can be used if the client needs to use an explicit, non-default proxy. Not supported in browsers, on iOS and tvOS. | +| `CachePolicy` | Shortcut for setting the default value for `Cache-Control` header. | +| `FollowRedirects` | Instructs the client to follow redirects. Default is `true`. | +| `Expect100Continue` | Gets or sets a value that indicates if the `Expect` header for an HTTP request contains `Continue`. | +| `UserAgent` | Allows overriding the default value for `User-Agent` header, which is `RestSharp/{version}`. | +| `PreAuthenticate` | Gets or sets a value that indicates whether the client sends an `Authorization` header with the request. Not supported in browsers. | +| `RemoteCertificateValidationCallback` | Custom function to validate the server certificate. Normally, it's used when the server uses a certificate that isn't trusted by default. | +| `BaseHost` | Value for the `Host` header sent with each request. | +| `CookieContainer` | Custom cookie container that will be shared among all calls made by the client. Normally not required as RestSharp handles cookies without using a client-level cookie container. | +| `MaxTimeout` | Client-level timeout in milliseconds. If the request timeout is also set, this value isn't used. | +| `Encoding` | Default request encoding. Override it only if you don't use UTF-8. | +| `ThrowOnDeserializationError` | Forces the client to throw if it fails to deserialize the response. Remember that not all deserialization issues forces the serializer to throw. Default is `false`, so the client will return a `RestResponse` with deserialization exception details. Only relevant for `Execute...` functions. | +| `FailOnDeserializationError` | When set to `true`, if the client fails to deserialize the response, the response object will have status `Failed`, although the HTTP calls might have been successful. Default is `true`. | +| `ThrowOnAnyError` | When set to `true`, the client will re-throw any exception from `HttpClient`. Default is `false`. Only applies for `Execute...` functions. | +| `AllowMultipleDefaultParametersWithSameName` | By default, adding parameters with the same name is not allowed. You can override this behaviour by setting this property to `true`. | +| `Encode` | A function to encode URLs, the default is a custom RestSharp function based on `Uri.EscapeDataString()`. Set it if you need a different way to do the encoding. | +| `EncodeQuery` | A function to encode URL query parameters. The default is the same function as for `Encode` property. | + +Some of the options are used by RestSharp code, but some are only used to configure the `HttpMessageHandler`. These options are: +- `Credentials` +- `UseDefaultCredentials` +- `AutomaticDecompression` +- `PreAuthenticate` +- `MaxRedirects` +- `RemoteCertificateValidationCallback` +- `ClientCertificates` +- `FollowRedirects` +- `Proxy` + +:::note +If setting these options to non-default values produce no desirable effect, check if your framework and platform supports them. RestSharp doesn't change behaviour based on values of those options. +::: + +The `IRestClient` interface exposes the `Options` property, so any option can be inspected at runtime. However, RestSharp converts the options object provided to the client constructor to an immutable object. Therefore, no client option can be changed after the client is instantiated. It's because changing client options at runtime can produce issues in concurrent environments, effectively rendering the client as not thread-safe. Apart from that, changing the options that are used to create the message handler would require re-creating the handler, and also `HttpClient`, which should not be done at runtime. + +## Configuring requests + +Client options apply to all requests made by the client. Sometimes, you want to fine-tune particular requests, so they execute with custom configuration. It's possible to do using properties of `RestRequest`, described below. + +| Name | Description | +|------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| `AlwaysMultipartFormData` | When set to `true`, the request will be sent as a multipart form, even though it's not required. By default, RestSharp only sends requests with multiple attachments as multipart forms. Default is `false`. | +| `AlwaysSingleFileAsContent` | When set to true, the request with file attachment will not be sent as a multipart form, but as plain content. Default is `false`. It cannot be set to `true` when `AlwaysMultipartFormData` is set to `true`, or when the request has `POST` parameters. | +| `MultipartFormQuoteBoundary` | Default is `true`, which means that the form boundary string will be wrapped in quotes. If the server has an issue with that, setting this to `false` will remove quotes around the boundary. | +| `FormBoundary` | Allows specifying a custom multipart form boundary instead of using the default random string. | +| `RequestParameters` | Collection of request parameters. Normally, you won't need to use it as parameters are added to the request using `Add...` functions. | +| `CookieContainer` | Custom request-level cookie container. Default is `null`. You can still set request cookies using `AddCookie` and get response cookies from the response object without using cooking container. | +| `Authenticator` | Overrides the client-level authenticator. | +| `Files` | Collection of file parameters, read-only. Use `AddFile` for adding files to the request. | +| `Method` | Request HTTP method, default is `GET`. Only needed when using `Execute` or `ExecuteAsync` as other functions like `ExecutePostAsync` will override the request method. | +| `TImeout` | Overrides the client-level timeout. | +| `Resource` | Resource part of the remote endpoint URL. For example, when using the client-level base URL `https://localhost:5000/api` and `Resource` set to `weather`, the request will be sent to `https://localhost:5000/api/weather`. It can container resource placeholders to be used in combination with `AddUrlSegment` | +| `RequestFormat` | Identifies the request as JSON, XML, binary, or none. Rarely used because the client will set the request format based on the body type if functions like `AddJsonBody` or `AddXmlBody` are used. | +| `RootElement` | Used by the default deserializers to determine where to start deserializing from. Only supported for XML responses. Does not apply to requests. | +| `OnBeforeDeserialization` | **Obsolete** A function to be called before the response is deserializer. Allows changing the content before calling the deserializer. Use [interceptors](interceptors.md) instead. | +| `OnBeforeRequest` | **Obsolete** A function to be called right before the request is executed by `HttpClient`. It receives an instance of `HttpRequestMessage`. Use [interceptors](interceptors.md) instead. | +| `OnAfterRequest` | **Obsolete** A function to be called right after the request is executed by `HttpClient`. It receives an instance of `HttpResponseMessage`. Use [interceptors](interceptors.md) instead. | +| `Attempts` | When the request is being resent to retry, the property value increases by one. | +| `CompletionOption` | Instructs the client on when it should consider the request to be completed. The default is `ResponseContentRead`. It is automatically changed to `ResponseHeadersRead` when using async download functions or streaming. | +| `CachePolicy` | Overrides the client cache policy. | +| `ResponseWriter` | Allows custom handling of the response stream. The function gets the raw response stream and returns another stream or `null`. Cannot be used in combination with `AdvancedResponseWriter`. | +| `AdvancedResponseWriter` | Allows custom handling of the response. The function gets an instance of `HttpResponseMessage` and an instance of `RestRequest`. It must return an instance of `RestResponse`, so it effectively overrides RestSharp default functionality for creating responses. | +| `Interceptors` | Allows adding interceptors to the request. Both client-level and request-level interceptors will be called. | + +The table below contains all configuration properties of `RestRequest`. To learn more about adding request parameters, check the [usage page](../usage/request.md) page about creating requests with parameters. diff --git a/docs/versioned_docs/version-v113/advanced/error-handling.md b/docs/versioned_docs/version-v113/advanced/error-handling.md new file mode 100644 index 000000000..80e822dcc --- /dev/null +++ b/docs/versioned_docs/version-v113/advanced/error-handling.md @@ -0,0 +1,71 @@ +# Error handling + +If there is a network transport error (network is down, failed DNS lookup, etc.), or any kind of server error (except 404), `RestResponse.ResponseStatus` will be set to `ResponseStatus.Error`, otherwise it will be `ResponseStatus.Completed`. + +If an API returns a 404, `ResponseStatus` will still be `Completed`. If you need access to the HTTP status code returned, you will find it at `RestResponse.StatusCode`. +The `Status` property is an indicator of completion independent of the API error handling. + +Normally, RestSharp doesn't throw an exception if the request fails. + +However, it is possible to configure RestSharp to throw in different situations when it normally doesn't throw +in favor of giving you the error as a property. + +| Property | Behavior | +|-------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| `FailOnDeserializationError` | Changes the default behavior when failed deserialization results in a successful response with an empty `Data` property of the response. Setting this property to `true` will tell RestSharp to consider failed deserialization as an error and set the `ResponseStatus` to `Error` accordingly. | +| `ThrowOnDeserializationError` | Changes the default behavior when failed deserialization results in empty `Data` property of the response. Setting this property to `true` will tell RestSharp to throw when deserialization fails. | +| `ThrowOnAnyError` | Setting this property to `true` changes the default behavior and forces RestSharp to throw if any errors occurs when making a request or during deserialization. | + +Those properties are available for the `RestClientOptions` and will be used for all request made with the client instance. + +For example, you can configure the client to throw an exception if any error occurs when making a request or when a request returns a non-successful HTTP status code: + +```csharp +var options = new RestClientOptions(url) { + ThrowOnAnyError = true +}; +var client = new RestClient(options); +var request = new RestRequest("resource/{id}").AddUrlSegment("id", 123); + +// 👇 will throw if the request fails +var deserialized = await client.GetAsync(request); + +// 👇 will NOT throw if the request fails, inspect the response to find out what happened +var response = await client.ExecuteGetAsync(request); +``` + +:::warning +Please be aware that deserialization failures will only work if the serializer throws an exception when deserializing the response. +Many serializers don't throw by default, and just return a `null` result. RestSharp is unable to figure out why `null` is returned, so it won't fail in this case. +Check the serializer documentation to find out if it can be configured to throw on deserialization error. +::: + +There are also slight differences on how different overloads handle exceptions. + +Asynchronous generic methods `GetAsync`, `PostAsync` and so on, which aren't a part of `RestClient` API (those methods are extension methods) return `Task`. It means that there's no `RestResponse` to set the response status to error. We decided to throw an exception when such a request fails. It is a trade-off between the API consistency and usability of the library. Usually, you only need the content of `RestResponse` instance to diagnose issues and most of the time the exception would tell you what's wrong. + +Below, you can find how different extensions deal with errors. Note that functions, which don't throw by default, will throw exceptions when `ThrowOnAnyError` is set to `true`. + +| Function | Throws on errors | +|:----------------------|:-----------------| +| `ExecuteAsync` | No | +| `ExecuteGetAsync` | No | +| `ExecuteGetAsync` | No | +| `ExecutePostAsync` | No | +| `ExecutePostAsync` | No | +| `ExecutePutAsync` | No | +| `ExecutePutAsync` | No | +| `GetAsync` | Yes | +| `GetAsync` | Yes | +| `PostAsync` | Yes | +| `PostAsync` | Yes | +| `PatchAsync` | Yes | +| `PatchAsync` | Yes | +| `DeleteAsync` | Yes | +| `DeleteAsync` | Yes | +| `OptionsAsync` | Yes | +| `OptionsAsync` | Yes | +| `HeadAsync` | Yes | +| `HeadAsync` | Yes | + +In addition, all the functions for JSON requests, like `GetJsonAsync` and `PostJsonAsync` throw an exception if the HTTP call fails. diff --git a/docs/versioned_docs/version-v113/advanced/interceptors.md b/docs/versioned_docs/version-v113/advanced/interceptors.md new file mode 100644 index 000000000..a3bf7a9bc --- /dev/null +++ b/docs/versioned_docs/version-v113/advanced/interceptors.md @@ -0,0 +1,84 @@ +--- +title: Interceptors +--- + +## Intercepting requests and responses + +Interceptors are a powerful feature of RestSharp that allows you to modify requests and responses before they are sent or received. You can use interceptors to add headers, modify the request body, or even cancel the request. You can also use interceptors to modify the response before it is returned to the caller. + +### Implementing an interceptor + +To implement an interceptor, you need to create a class that inherits the `Interceptor` base class. The base class implements all interceptor methods as virtual, so you can override them in your derived class. + +Methods that you can override are: +- `BeforeRequest(RestRequest request, CancellationToken cancellationToken)` +- `AfterRequest(RestResponse response, CancellationToken cancellationToken)` +- `BeforeHttpRequest(HttpRequestMessage requestMessage, CancellationToken cancellationToken)` +- `AfterHttpRequest(HttpResponseMessage responseMessage, CancellationToken cancellationToken)` +- `BeforeDeserialization(RestResponse response, CancellationToken cancellationToken)` + +All those functions must return a `ValueTask` instance. + +Here's an example of an interceptor that adds a header to a request: + +```csharp +// This interceptor adds a header to the request +// You'd not normally use this interceptor, as RestSharp already has a method +// to add headers to the request +class HeaderInterceptor(string headerName, string headerValue) : Interceptors.Interceptor { + public override ValueTask BeforeHttpRequest(HttpRequestMessage requestMessage, CancellationToken cancellationToken) { + requestMessage.Headers.Add(headerName, headerValue); + return ValueTask.CompletedTask; + } +} +``` + +Because interceptor functions return `ValueTask`, you can use `async` and `await` inside them. + +### Using an interceptor + +It's possible to add as many interceptors as you want, both to the client and to the request. The interceptors are executed in the order they were added. + +Adding interceptors to the client is done via the client options: + +```csharp +var options = new RestClientOptions("https://api.example.com") { + Interceptors = [new HeaderInterceptor("Authorization", token)] +}; +var client = new RestClient(options); +``` + +When you add an interceptor to the client, it will be executed for every request made by that client. + +You can also add an interceptor to a specific request: + +```csharp +var request = new RestRequest("resource") { + Interceptors = [new HeaderInterceptor("Authorization", token)] +}; +``` + +In this case, the interceptor will only be executed for that specific request. + +### Deprecation notice + +Interceptors aim to replace the existing request hooks available in RestSharp prior to version 111.0. Those hooks are marked with `Obsolete` attribute and will be removed in the future. If you are using those hooks, we recommend migrating to interceptors as soon as possible. + +To make the migration easier, RestSharp provides a class called `CompatibilityInterceptor`. It has properties for the hooks available in RestSharp 110.0 and earlier. You can use it to migrate your code to interceptors without changing the existing logic. + +For example, a code that uses `OnBeforeRequest` hook: + +```csharp +var request = new RestRequest("success"); +request.OnBeforeDeserialization += _ => throw new Exception(exceptionMessage); +``` + +Can be migrated to interceptors like this: + +```csharp +var request = new RestRequest("success") { + Interceptors = [new CompatibilityInterceptor { + OnBeforeDeserialization = _ => throw new Exception(exceptionMessage) + }] +}; +``` \ No newline at end of file diff --git a/docs/versioned_docs/version-v113/advanced/serialization.md b/docs/versioned_docs/version-v113/advanced/serialization.md new file mode 100644 index 000000000..b7092519a --- /dev/null +++ b/docs/versioned_docs/version-v113/advanced/serialization.md @@ -0,0 +1,148 @@ +# Serialization + +One of the most common reasons to choose RestSharp over plain `HttpClient` is its rich build-in serialization support. RestSharp allows adding complex objects as request body to be serialized when making a call to an API endpoint, and deserializing the response to a given .NET type. RestSharp supports JSON and XML serialization and deserialization by default. In addition, you can use a CSV serializer or write your own. + +In contrast to `System.Net.Http.Json` package that contains `HttpClient` extensions to make `GET` or `POST` calls using JSON, RestSharp support JSON responses for all HTTP methods, not just for `GET`. + +## Configuration + +:::tip +The default behavior of RestSharp is to swallow deserialization errors and return `null` in the `Data` +property of the response. Read more about it in the [Error Handling](error-handling.md). +::: + +You can tell RestSharp to use a custom serializer by using the `configureSerialization` constructor parameter: + +```csharp +var client = new RestClient( + options, + configureSerialization: s => s.UseSerializer(() => new CustomSerializer()); +); +``` + +All RestSharp serializers implement the `IRestSerializer` interface. Among other things, the interface requires implementing the `AcceptedContentTypes` property, which must return a collection of content types supported by the serializer. Being configured to use certain serializers, RestSharp populates the `Accept` header accordingly, so it doesn't need to be set manually. + +When making a call, RestSharp sets the request content type according to the request body type. For example, when you use `AddJsonBody`, the content type is set to `application/json`. Normally, you won't need to set the `Content-Type` header manually. If you need to set a custom content type for a JSON call, you can use the optional `contentType` argument of `AddJsonBody`, for example: + +```csharp +request.AddJsonBody(data, "text/json"); +``` + +## JSON + +The default JSON serializer uses `System.Text.Json`, which is a part of .NET since .NET 6. For earlier versions, it is added as a dependency. There are also a few serializers provided as additional packages. + +By default, RestSharp will use `JsonSerializerDefaults.Web` configuration. If necessary, you can specify your own options: + +```csharp +var client = new RestClient( + options, + configureSerialization: s => s.UseSystemTextJson(new JsonSerializerOptions {...}) +); +``` + +## XML + +The default XML serializer is `DotNetXmlSerializer`, which uses `System.Xml.Serialization` library from .NET. + +In previous versions of RestSharp, the default XML serializer was a custom RestSharp XML serializer. To make the code library size smaller, that serializer is now available as a separate package [`RestSharp.Serializers.Xml`](https://www.nuget.org/packages/RestSharp.Serializers.Xml). +You can add it back if necessary by installing the package and adding it to the client: + +```csharp +var client = new RestClient( + options, + configureSerialization: s => s.UseXmlSerializer() +); +``` + +As before, you can supply three optional arguments for a custom namespace, custom root element, and if you want to use `SerializeAs` and `DeserializeAs` attributed. + +## NewtonsoftJson (aka Json.Net) + +The `NewtonsoftJson` package is the most popular JSON serializer for .NET. It handles all possible scenarios and is very configurable. Such a flexibility comes with the cost of performance. If you need speed, keep the default JSON serializer. + +RestSharp support Json.Net serializer via a separate package [`RestSharp.Serializers.NewtonsoftJson`](https://www.nuget.org/packages/RestSharp.Serializers.NewtonsoftJson). + +:::warning +Please note that `RestSharp.Newtonsoft.Json` package is not provided by RestSharp, is marked as obsolete on NuGet, and no longer supported by its creator. +::: + +Use the extension method provided by the package to configure the client: + +```csharp +var client = new RestClient( + options, + configureSerialization: s => s.UseNewtonsoftJson() +); +``` + +The serializer configures some options by default: + +```csharp +JsonSerializerSettings DefaultSettings = new JsonSerializerSettings { + ContractResolver = new CamelCasePropertyNamesContractResolver(), + DefaultValueHandling = DefaultValueHandling.Include, + TypeNameHandling = TypeNameHandling.None, + NullValueHandling = NullValueHandling.Ignore, + Formatting = Formatting.None, + ConstructorHandling = ConstructorHandling.AllowNonPublicDefaultConstructor +}; +``` + +If you need to use different settings, you can supply your instance of +`JsonSerializerSettings` as a parameter for the extension method. + +## CSV + +A separate package `RestSharp.Serializers.CsvHelper` provides a CSV serializer for RestSharp. It is based on the +`CsvHelper` library. + +Use the extension method provided by the package to configure the client: + +```csharp +var client = new RestClient( + options, + configureSerialization: s => s.UseCsvHelper() +); +``` + +You can also supply your instance of `CsvConfiguration` as a parameter for the extension method. + +```csharp +var client = new RestClient( + options, + configureSerialization: s => s.UseCsvHelper( + new CsvConfiguration(CultureInfo.InvariantCulture) {...} + ) +); +``` + +## Custom + +You can also implement your custom serializer. To support both serialization and +deserialization, you must implement the `IRestSerializer` interface. + +Here is an example of a custom serializer that uses `System.Text.Json`: + +```csharp +public class SimpleJsonSerializer : IRestSerializer { + public string? Serialize(object? obj) => obj == null ? null : JsonSerializer.Serialize(obj); + + public string? Serialize(Parameter bodyParameter) => Serialize(bodyParameter.Value); + + public T? Deserialize(RestResponse response) => JsonSerializer.Deserialize(response.Content!); + + public ContentType ContentType { get; set; } = ContentType.Json; + + public ISerializer Serializer => this; + public IDeserializer Deserializer => this; + public DataFormat DataFormat => DataFormat.Json; + public string[] AcceptedContentTypes => ContentType.JsonAccept; + public SupportsContentType SupportsContentType + => contentType => contentType.Value.EndsWith("json", StringComparison.InvariantCultureIgnoreCase); +} +``` + +The `SupportedContentTypes` function will be used to check if the serializer is able to deserialize the response based on the `Content-Type` response header. + +The `ContentType` property will be used when making a request so the server knows how to handle the payload. diff --git a/docs/versioned_docs/version-v113/changelog.md b/docs/versioned_docs/version-v113/changelog.md new file mode 100644 index 000000000..ea7346cf5 --- /dev/null +++ b/docs/versioned_docs/version-v113/changelog.md @@ -0,0 +1,29 @@ +--- +title: What's new +description: List of changes for the current major version +sidebar_position: 1 +--- + +# Changelog + +For release notes of previous versions, please check the [Releases page](https://github.com/restsharp/RestSharp/releases) in RestSharp GitHub repository. + +Changes between major versions are documented in the documentation for each version on this website. + +# v112.0 + +* Security fix for [CVE-2024-45302](https://github.com/restsharp/RestSharp/security/advisories/GHSA-4rr6-2v9v-wcpc). Header values cannot contain `CRLF`. + +## v112.1 + +* Follow up on v112.0 security fix: remove `\t` from the list of forbidden characters in headers. + +# v113.0 + +* Added support for .NET 9 and .NET 10 +* Upgraded `System.Text.Json` to v10 for all target frameworks +* Added support for Microsoft dependency injection and HTTP client factory +* For responses with 404 (not found) status code the `IsSuccessful` is set to `false` +* When the new option `ErrorWhenUnsuccessfulStatusCode` is set to `false`, the error message and the exception won't be added to the response. Default for this option is `true` for backwards compatibility. +* When `AddUrlSegment` is called more than once with the same name, the last value will be used. +* The new package `RestSharp.Extensions.DependencyInjection` integrates RestSharp with Microsoft DI container and `IHttpClientFactory`. \ No newline at end of file diff --git a/docs/versioned_docs/version-v113/intro.md b/docs/versioned_docs/version-v113/intro.md new file mode 100644 index 000000000..961c5350a --- /dev/null +++ b/docs/versioned_docs/version-v113/intro.md @@ -0,0 +1,112 @@ +--- +sidebar_position: 2 +title: Quick start +--- + +## Introduction + +:::warning +RestSharp v107+ changes the library API surface and its behaviour significantly. We advise looking at [migration](/migration) docs to understand how to migrate to the latest version of RestSharp. +::: + +The main purpose of RestSharp is to make synchronous and asynchronous calls to remote resources over HTTP. As the name suggests, the main audience of RestSharp are developers who use REST APIs. However, RestSharp can call any API over HTTP, as long as you have the resource URI and request parameters that you want to send comply with W3C HTTP standards. + +One of the main challenges of using HTTP APIs for .NET developers is to work with requests and responses of different kinds and translate them to complex C# types. RestSharp can take care of serializing the request body to JSON or XML and deserialize the response. It can also form a valid request URI based on different parameter kinds: path, query, form or body. + +## Getting Started + +Before you can use RestSharp in your application, you need to add the NuGet package. You can do it using your IDE or the command line: + +``` +dotnet add package RestSharp +``` + +### Basic Usage + +If you only have a small number of one-off API requests to perform, you can use RestSharp like this: + +```csharp +using RestSharp; +using RestSharp.Authenticators; + +var options = new RestClientOptions("https://api.twitter.com/1.1") { + Authenticator = new HttpBasicAuthenticator("username", "password") +}; +var client = new RestClient(options); +var request = new RestRequest("statuses/home_timeline.json"); +// The cancellation token comes from the caller. You can still make a call without it. +var response = await client.GetAsync(request, cancellationToken); +``` + +It will return a `RestResponse` back, which contains all the information returned from the remote server. +You have access to the headers, content, HTTP status and more. + +You can also use generic overloads like `Get` to automatically deserialize the response into a .NET class. + +For example: + +```csharp +using RestSharp; +using RestSharp.Authenticators; + +var options = new RestClientOptions("https://api.twitter.com/1.1") { + Authenticator = new HttpBasicAuthenticator("username", "password") +}; +var client = new RestClient(options); + +var request = new RestRequest("statuses/home_timeline.json"); + +// The cancellation token comes from the caller. You can still make a call without it. +var timeline = await client.GetAsync(request, cancellationToken); +``` + +Both snippets above use the `GetAsync` extension, which is a wrapper about `ExecuteGetAsync`, which, in turn, is a wrapper around `ExecuteAsync`. +All `ExecuteAsync` overloads and return the `RestResponse` or `RestResponse`. + +The most important difference is that async methods named after HTTP methods (like `GetAsync` or `PostAsync`) return `Task` instead of `Task>`. It means that you won't get an error response if the request fails as those methods throw an exception for unsuccessful HTTP calls. For keeping the API consistent, non-generic functions like `GetAsync` or `PostAsync` also throw an exception if the request fails, although they return the `Task`. + +Read [here](advanced/error-handling.md) about how RestSharp handles exceptions. + +RestSharp also offers simple ways to call APIs that accept and return JSON payloads. You can use the `GetJsonAsync` and `PostJsonAsync` extension methods, which will automatically serialize the request body to JSON and deserialize the response to the specified type. + +```csharp +var client = new RestClient(options); +var timeline = await client.GetJsonAsync("statuses/home_timeline.json", cancellationToken); +``` + +Read [here](usage/execute.md#json-requests) about making JSON calls without preparing a request object. + +### Content type + +RestSharp supports sending XML or JSON body as part of the request. To add a body to the request, simply call `AddJsonBody` or `AddXmlBody` method of the `RestRequest` object. + +There is no need to set the `Content-Type` or add the `DataFormat` parameter to the request when using those methods, RestSharp will do it for you. + +RestSharp will also handle both XML and JSON responses and perform all necessary deserialization tasks, depending on the server response type. Therefore, you only need to add the `Accept` header if you want to deserialize the response manually. + +For example, only you'd only need these lines to make a request with JSON body: + +```csharp +var request = new RestRequest("address/update").AddJsonBody(updatedAddress); +var response = await client.PostAsync(request); +``` + +It's also possible to make the same call using `PostAsync` shorter syntax: + +```csharp +var response = await PostJsonAsync( + "address/update", request, cancellationToken +); +``` + +Read more about serialization and deserialization [here](advanced/serialization.md). + +### Response + +When you use `ExecuteAsync`, you get an instance of `RestResponse` back. The response object has the `Content` property, which contains the response as string. You can find other useful properties there, like `StatusCode`, `ContentType` and so on. If the request wasn't successful, you'd get a response back with `IsSuccessful` property set to `false` and the error explained in the `ErrorException` and `ErrorMessage` properties. + +When using typed `ExecuteAsync`, you get an instance of `RestResponse` back, which is identical to `RestResponse` but also contains the `T Data` property with the deserialized response. + +None of `ExecuteAsync` overloads throw if the remote server returns an error. You can inspect the response and find the status code, error message, and, potentially, an exception. + +Extensions like `GetAsync` will not return the whole `RestResponse` but just a deserialized response. These extensions will throw an exception if the remote server returns an error. The exception details contain the status code returned by the server. diff --git a/docs/versioned_docs/version-v113/usage/_category_.json b/docs/versioned_docs/version-v113/usage/_category_.json new file mode 100644 index 000000000..bd2045cd6 --- /dev/null +++ b/docs/versioned_docs/version-v113/usage/_category_.json @@ -0,0 +1,7 @@ +{ + "label": "Using RestSharp", + "position": 3, + "link": { + "type": "generated-index" + } +} diff --git a/docs/versioned_docs/version-v113/usage/basics.md b/docs/versioned_docs/version-v113/usage/basics.md new file mode 100644 index 000000000..6bbb5594a --- /dev/null +++ b/docs/versioned_docs/version-v113/usage/basics.md @@ -0,0 +1,23 @@ +--- +sidebar_position: 2 +--- + +# RestSharp basics + +This page describes some of the essential properties and features of RestSharp. + +## What RestSharp does + +Essentially, RestSharp is a wrapper around `HttpClient` that allows you to do the following: +- Add default parameters of any kind (not just headers) to the client, once +- Add parameters of any kind to each request (query, URL segment, form, attachment, serialized body, header) in a straightforward way +- Serialize the payload to JSON or XML if necessary +- Set the correct content headers (content type, disposition, length, etc.) +- Handle the remote endpoint response +- Deserialize the response from JSON or XML if necessary + +## API client + +The best way to call an external HTTP API is to create a typed client, which encapsulates RestSharp calls and doesn't expose the `RestClient` instance in public. + +You can find an example of a Twitter API client on the [Example](example.md) page. diff --git a/docs/versioned_docs/version-v113/usage/client.md b/docs/versioned_docs/version-v113/usage/client.md new file mode 100644 index 000000000..bdcc10727 --- /dev/null +++ b/docs/versioned_docs/version-v113/usage/client.md @@ -0,0 +1,123 @@ +--- +sidebar_position: 3 +title: Creating the client +--- + +## Constructors + +A RestSharp client can be instantiated by one of its constructors. Two most commonly used constructors are: + +#### Only specify the base URL + +You can create an instance of `RestClient` with only a single parameter: the base URL. Even that isn't required as base URL can be left empty. In that case, you'd need to specify the absolute path for each call. When the base URL is set, you can use both relative and absolute path. + +```csharp +// Creates a client with default options to call a given base URL +var client = new RestClient("https://localhost:5000"); +``` + +#### Provide client options + +The most common way to create a client is to use the constructor with options. The options object has the type of `RestClientOptions`. +Here's an example of how to create a client using the same base path as in the previous sample, but with a couple additional settings: + +```csharp +// Creates a client using the options object +var options = new RestClientOptions("https://localhost:5000") { + MaxTimeout = 1000 +}; +var client = new RestClient(options); +``` + +#### Advanced configuration + +RestSharp can be configured with more tweaks, including default request options, how it should handle responses, how serialization works, etc. You can also provide your own instance of `HttpClient` or `HttpMessageHandler`. + +Read more about the advanced configuration of RestSharp on a [dedicated page](../advanced/configuration.md). + +## Simple factory + +Another way to create the client instance is to use a simple client factory. The factory will use the `BaseUrl` property of the client options to cache `HttpClient` instances. Every distinct base URL will get its own `HttpClient` instance. Other options don't affect the caching. Therefore, if you use different options for the same base URL, you'll get the same `HttpClient` instance, which will not be configured with the new options. Options that aren't applied _after_ the first client instance is created are: + +* `Credentials` +* `UseDefaultCredentials` +* `AutomaticDecompression` +* `PreAuthenticate` +* `FollowRedirects` +* `RemoteCertificateValidationCallback` +* `ClientCertificates` +* `MaxRedirects` +* `MaxTimeout` +* `UserAgent` +* `Expect100Continue` + +Constructor parameters to configure the `HttpMessageHandler` and default `HttpClient` headers configuration are also ignored for the cached instance as the factory only configures the handler once. + +You need to set the `useClientFactory` parameter to `true` in the `RestClient` constructor to enable the factory. + +```csharp +var options = new RestClientOptions("https://api.twitter.com/2"); +var client = new RestClient(options, useClientFactory: true); +``` + +## Dependency Injection + +Since version 113.0, RestSharp provides integration with Microsoft Dependency Injection container using `RestSharp.Extensions.DepndencyInjection` package. It also allows using `IHttpClientFactory`, which manages the lifecycle of HTTP message handlers, avoiding socket exhaustion when RestClient is used as a transient dependency. It also resolves the issue with DNS changes when RestClient is used as a singleton. The latter is solved by using RestClient as a transient dependency and letting the client factory to deal with message handlers lifecycle. + +Learn more about registering the client in the DI container [here](./di.md). + +## Reusing HttpClient + +RestSharp uses `HttpClient` internally to make HTTP requests. It's possible to reuse the same `HttpClient` instance for multiple `RestClient` instances. This is useful when you want to share the same connection pool between multiple `RestClient` instances. + +One way of doing it is to use `RestClient` constructors that accept an instance of `HttpClient` or `HttpMessageHandler` as an argument. Note that in that case not all the options provided via `RestClientOptions` will be used. Here is the list of options that will work: + +- `BaseAddress` is be used to set the base address of the `HttpClient` instance if base address is not set there already. +- `MaxTimeout` is used to cancel the call using the cancellation token source, so +- `UserAgent` will be added to the `RestClient.DefaultParameters` list as a HTTP header. This will be added to each request made by the `RestClient`, and the `HttpClient` instance will not be modified. This is to allow the `HttpClient` instance to be reused for scenarios where different `User-Agent` headers are required. +- `Expect100Continue` + +The second option is to use a simple HTTP client factory as described [above](#simple-factory). + +Finally, you can use `IHttpClientFactory` that properly manages the client message handler lifecycle. Read more [here](./di.md). + +## Blazor support + +Inside a Blazor webassembly app, you can make requests to external API endpoints. Microsoft examples show how to do it with `HttpClient`, and it's also possible to use RestSharp for the same purpose. + +You need to remember that webassembly has some platform-specific limitations. Therefore, you won't be able to instantiate `RestClient` using all of its constructors. In fact, you can only use `RestClient` constructors that accept `HttpClient` or `HttpMessageHandler` as an argument. If you use the default parameterless constructor, it will call the option-based constructor with default options. The options-based constructor will attempt to create an `HttpMessageHandler` instance using the options provided, and it will fail with Blazor, as some of those options throw thw "Unsupported platform" exception. + +Here is an example how to register the `RestClient` instance globally as a singleton: + +```csharp +builder.Services.AddSingleton(new RestClient(new HttpClient())); +``` + +Then, on a page you can inject the instance: + +```html +@page "/fetchdata" +@using RestSharp +@inject RestClient _restClient +``` + +And then use it: + +```csharp +@code { + private WeatherForecast[]? forecasts; + + protected override async Task OnInitializedAsync() { + forecasts = await _restClient.GetJsonAsync("http://localhost:5104/weather"); + } + + public class WeatherForecast { + public DateTime Date { get; set; } + public int TemperatureC { get; set; } + public string? Summary { get; set; } + public int TemperatureF => 32 + (int)(TemperatureC / 0.5556); + } +} +``` + +In this case, the call will be made to a WebAPI server hosted at `http://localhost:5104/weather`. Remember that if the WebAPI server is not hosting the webassembly itself, it needs to have a CORS policy configured to allow the webassembly origin to access the API endpoint from the browser. diff --git a/docs/versioned_docs/version-v113/usage/di.md b/docs/versioned_docs/version-v113/usage/di.md new file mode 100644 index 000000000..a6e8e77ae --- /dev/null +++ b/docs/versioned_docs/version-v113/usage/di.md @@ -0,0 +1,99 @@ +--- +sidebar_position: 7 +title: Dependency Injection +--- + +RestSharp integrates with the Microsoft [Dependency Injection](ttps://learn.microsoft.com/en-us/aspnet/core/fundamentals/dependency-injection) container and `IHttpClientFactory` via a separate package `RestSharp.Extensions.DependencyInjection`. + +You can register RestClient in the container as a transient dependency, and it will use `IHttpClientFactory` via `IRestClientFactory` for creating HTTP clients and message handlers that are managed by the factory. This approach offers the following benefits: + +* Provides a central location for naming and configuring logical RestClient instances. For example, a client named `github` could be registered and configured to access GitHub. A default client can be registered for general access. +* Manages the pooling and lifetime of underlying `HttpClientMessageHandler` instances. Automatic management avoids common DNS problems that occur when manually managing RestClient lifetime. + +Examples below are for a basic ASP.NET Core bootstrap with `WebApplicationBuilder`. + +## Default client + +Register `IHttpClientFactory`, `IRestClientFactory`, and `IRestClient` by calling `AddRestClient` in `Program.cs`: + +```csharp +var builder = WebApplication.CreateBuilder(args); + +// Add services to the container. +builder.Services.AddRestClient(); +``` + +Then, you can get `IRestClient` injected to your services: + +```csharp +public class GetReposModel(IRestClient client) : PageModel { + public IEnumerable? GitHubBranches { get; set; } + + public async Task OnGet() { + var request = new RestRequest("https://api.github.com/repos/RestSharp/RestSharp/branches"); + var response = await client.ExecuteGetAsync>(request); + + if (response.IsSuccessful) { + GitHubBranches = response.Data; + } + } +} +``` + +It's possible to provide client options when registering the default client using one of the extensions: + +```csharp +// Specify the base URL +builder.Services.AddRestClient(new Uri("https://api.github.com")); + +// Provide custom options +var options = new RestClientOptions("https://api.github.com") { + Timeout = TimeSpan.FromSeconds(5); +} +builder.Services.AddRestClient(options); +``` + +## Named client + +Named clients are needed when you need multiple clients to be configured differently, which are then used in different parts of the application. For example, you need one client to call the GitHub API, and another client to call the Twilio API. Registering clients using meaningful names allows to retrieve them from `IRestClientFactory`. + +For example, a GitHub-specific client can be registered with `github` name: + +```csharp +var options = new RestClientOptions("https://api.github.com") { + Timeout = TimeSpan.FromSeconds(5); +} +builder.Services.AddRestClient("github", options); +``` + +Then, an application component can use the client factory to get the client instance: + +```csharp +public class GetReposModel(IRestClientFactory factory) : PageModel { + public IEnumerable? GitHubBranches { get; set; } + + public async Task OnGet() { + var request = new RestRequest("/repos/RestSharp/RestSharp/branches"); + var client = factory.CreateClient("github"); + var response = await client.ExecuteGetAsync>(request); + + if (response.IsSuccessful) { + GitHubBranches = response.Data; + } + } +} +``` + +As the default client, named clients can be registered with a base URL and with custom options. The most versatile extension allows configuring anything at named client registration: + +```csharp +builder.Services.AddRestClient( + "my-client", + options => { + options.BaseUrl = new Uri("https://api.github.com"); + options.Timeout = TimeSpan.FromSeconds(1); + options.Authenticator = new GitHubAuthenticator(builder.Configuration["GitHub:ApiToken"]); + }, + serialization => serialization.UseNewtonsoftJson() +); +``` \ No newline at end of file diff --git a/docs/versioned_docs/version-v113/usage/example.md b/docs/versioned_docs/version-v113/usage/example.md new file mode 100644 index 000000000..6182d8ff3 --- /dev/null +++ b/docs/versioned_docs/version-v113/usage/example.md @@ -0,0 +1,152 @@ +--- +sidebar_position: 1 +--- + +# Example + +RestSharp works best as the foundation for a proxy class for your API. Each API would most probably require different settings for `RestClient`. Hence, a dedicated API class (and its interface) gives you sound isolation between different `RestClient` instances and make them testable. + +For example, let's look at a simple Twitter API v2 client, which uses OAuth2 machine-to-machine authentication. For it to work, you would need to have access to the Twitter Developers portal, a project, and an approved application inside the project with OAuth2 enabled. + +## Client model + +Before implementing an API client, we need to have a model for it. The model includes an abstraction for the client, which has functions for the API calls we are interested to implement. In addition, the client model would include the necessary request and response models. Usually those are simple classes or records without logic, which are often referred to as DTOs (data transfer objects). + +This example starts with a single function that retrieves one Twitter user. Lets being by defining the API client interface: + +```csharp +public interface ITwitterClient { + Task GetUser(string user); +} +``` + +As the function returns a `TwitterUser` instance, we need to define it as a model: + +```csharp +public record TwitterUser(string Id, string Name, string Username); +``` + +## Client implementation + +When that is done, we can implement the interface and add all the necessary code blocks to get a working API client. + +The client class needs the following: +- A constructor for passing API credentials +- A wrapped `RestClient` instance with the Twitter API base URI pre-configured +- An authenticator to support authorizing the client using Twitter OAuth2 authentication +- The actual function to get the user (to implement the `ITwitterClient` interface) + +Creating an authenticator is described [below](#authenticator). + +Here's how the client implementation could look like: + +```csharp +public class TwitterClient : ITwitterClient, IDisposable { + readonly RestClient _client; + + public TwitterClient(string apiKey, string apiKeySecret) { + var options = new RestClientOptions("https://api.twitter.com/2"); + _client = new RestClient(options); + } + + public async Task GetUser(string user) { + var response = await _client.GetAsync>( + "users/by/username/{user}", + new { user } + ); + return response!.Data; + } + + record TwitterSingleObject(T Data); + + public void Dispose() { + _client?.Dispose(); + GC.SuppressFinalize(this); + } +} +``` + +It is also possible to use ASP.NET Core Options for configuring the client, instead of passing the credentials as strings. For example, we can add a class for Twitter client options, and use it in a constructor: + +```csharp +public class TwitterClientOptions(string ApiKey, string ApiSecret); + +public TwitterClient(IOptions options) { + var opt = new RestClientOptions("https://api.twitter.com/2"); + _client = new RestClient(options); +} +``` + +Then, you can register and configure the client using ASP.NET Core dependency injection container. + +Right now, the client won't really work as Twitter API requires authentication. It's covered in the next section. + +## Authenticator + +Before we can call the API itself, we need to get a bearer token. Twitter exposes an endpoint `https://api.twitter.com/oauth2/token`. As it follows the OAuth2 conventions, the code can be used to create an authenticator for some other vendors. + +First, we need a model for deserializing the token endpoint response. OAuth2 uses snake case for property naming, so we need to decorate model properties with `JsonPropertyName` attribute: + +```csharp +record TokenResponse { + [JsonPropertyName("token_type")] + public string TokenType { get; init; } + [JsonPropertyName("access_token")] + public string AccessToken { get; init; } +} +``` + +Next, we create the authenticator itself. It needs the API key and API key secret to call the token endpoint using basic HTTP authentication. In addition, we can extend the list of parameters with the base URL to convert it to a more generic OAuth2 authenticator. + +The easiest way to create an authenticator is to inherit from the `AuthenticatorBase` base class: + +```csharp +public class TwitterAuthenticator : AuthenticatorBase { + readonly string _baseUrl; + readonly string _clientId; + readonly string _clientSecret; + + public TwitterAuthenticator(string baseUrl, string clientId, string clientSecret) : base("") { + _baseUrl = baseUrl; + _clientId = clientId; + _clientSecret = clientSecret; + } + + protected override async ValueTask GetAuthenticationParameter(string accessToken) { + Token = string.IsNullOrEmpty(Token) ? await GetToken() : Token; + return new HeaderParameter(KnownHeaders.Authorization, Token); + } +} +``` + +During the first call made by the client using the authenticator, it will find out that the `Token` property is empty. It will then call the `GetToken` function to get the token once and reuse the token going forward. + +Now, we need to implement the `GetToken` function in the class: + +```csharp +async Task GetToken() { + var options = new RestClientOptions(_baseUrl){ + Authenticator = new HttpBasicAuthenticator(_clientId, _clientSecret), + }; + using var client = new RestClient(options); + + var request = new RestRequest("oauth2/token") + .AddParameter("grant_type", "client_credentials"); + var response = await client.PostAsync(request); + return $"{response!.TokenType} {response!.AccessToken}"; +} +``` + +As we need to make a call to the token endpoint, we need our own short-lived instance of `RestClient`. Unlike the actual Twitter client, it will use the `HttpBasicAuthenticator` to send the API key and secret as the username and password. The client then gets disposed as we only use it once. + +Here we add a POST parameter `grant_type` with `client_credentials` as its value. At the moment, it's the only supported value. + +The POST request will use the `application/x-www-form-urlencoded` content type by default. + +::: note +Sample code provided on this page is a production code. For example, the authenticator might produce undesired side effect when multiple requests are made at the same time when the token hasn't been obtained yet. It can be solved rather than simply using semaphores or synchronized invocation. +::: + +## Final words + +This page demonstrates how an API client can be implemented as a typed, configurable client with its own interface. Usage of the client in applications is not covered here as different application types and target frameworks have their own idiomatic ways to use HTTP clients. \ No newline at end of file diff --git a/docs/versioned_docs/version-v113/usage/execute.md b/docs/versioned_docs/version-v113/usage/execute.md new file mode 100644 index 000000000..36343f793 --- /dev/null +++ b/docs/versioned_docs/version-v113/usage/execute.md @@ -0,0 +1,172 @@ +--- +sidebar_position: 5 +title: Making calls +--- + +## Executing requests + +Once you've added all the parameters to your `RestRequest`, you are ready to make a request. + +`RestClient` has a single function for this: + +```csharp +public async Task ExecuteAsync( + RestRequest request, + CancellationToken cancellationToken = default +) +``` + +You can also avoid setting the request method upfront and use one of the overloads: + +```csharp +Task ExecuteGetAsync(RestRequest request, CancellationToken cancellationToken) +Task ExecutePostAsync(RestRequest request, CancellationToken cancellationToken) +Task ExecutePutAsync(RestRequest request, CancellationToken cancellationToken) +Task ExecuteDeleteAsync(RestRequest request, CancellationToken cancellationToken) +Task ExecuteHeadAsync(RestRequest request, CancellationToken cancellationToken) +Task ExecuteOptionsAsync(RestRequest request, CancellationToken cancellationToken) +``` + +When using any of those methods, you will get the response content as string in `response.Content`. + +RestSharp can deserialize the response for you. To use that feature, use one of the generic overloads: + +```csharp +Task> ExecuteAsync(RestRequest request, CancellationToken cancellationToken) +Task> ExecuteGetAsync(RestRequest request, CancellationToken cancellationToken) +Task> ExecutePostAsync(RestRequest request, CancellationToken cancellationToken) +Task> ExecutePutAsync(RestRequest request, CancellationToken cancellationToken) +Task> ExecuteDeleteAsync(RestRequest request, CancellationToken cancellationToken) +Task> ExecuteHeadAsync(RestRequest request, CancellationToken cancellationToken) +Task> ExecuteOptionsAsync(RestRequest request, CancellationToken cancellationToken) +``` + +:::note Beware of errors +All the overloads with names starting with `Execute` don't throw an exception if the server returns an error. Read more about it [here](../advanced/error-handling.md). +It allows you to inspect responses and handle remote server errors gracefully. Overloads without `Execute` prefix throw exceptions in case of any error, so you'd need to ensure to handle exceptions properly. +::: + +If you just need a deserialized response, you can use one of the extensions: + +```csharp +Task GetAsync(RestRequest request, CancellationToken cancellationToken) +Task PostAsync(RestRequest request, CancellationToken cancellationToken) +Task PutAsync(RestRequest request, CancellationToken cancellationToken) +Task PatchAsync(RestRequest request, CancellationToken cancellationToken) +Task DeleteAsync(RestRequest request, CancellationToken cancellationToken) +Task HeadAsync(RestRequest request, CancellationToken cancellationToken) +Task OptionsAsync(RestRequest request, CancellationToken cancellationToken) +``` + +Those extensions will throw an exception if the server returns an error, as there's no other way to float the error back to the caller. + +The `IRestClient` interface also has extensions for making requests without deserialization, which throw an exception if the server returns an error even if the client is configured to not throw exceptions. + +```csharp +Task GetAsync(RestRequest request, CancellationToken cancellationToken) +Task PostAsync(RestRequest request, CancellationToken cancellationToken) +Task PutAsync(RestRequest request, CancellationToken cancellationToken) +Task PatchAsync(RestRequest request, CancellationToken cancellationToken) +Task DeleteAsync(RestRequest request, CancellationToken cancellationToken) +Task HeadAsync(RestRequest request, CancellationToken cancellationToken) +Task OptionsAsync(RestRequest request, CancellationToken cancellationToken) +``` + +### Sync calls + +The preferred way for making requests is to execute them asynchronously as HTTP calls are IO-bound operations. +If you are unable to make async calls, all the functions about have sync overloads, which have the same names without `Async` suffix. +For example, for making a sync `GET` call you can use `ExecuteGet(request)` or `Get`, etc. + +## Requests without body + +Some HTTP methods don't suppose to be used with request body. For those methods, RestSharp supports making simplified calls without using `RestRequest`. All you need is to provide the resource path as a string. + +For example, you can make a `DELETE` call like this: + +```csharp +var response = await client.ExecuteDeleteAsync($"order/delete/{orderId}", cancellationToken); +``` + +Similarly, you can make `GET` calls with or without deserialization of the response using `ExecuteGetAsync(resource)`, `GetAsync(resource)`, `ExecuteGetAsync(resource)`, and `GetAsync(resource)` (see below). + +## JSON requests + +RestSharp provides an easier API for making calls to endpoints that accept and return JSON. + +### GET calls + +To make a simple `GET` call and get a deserialized JSON response with a pre-formed resource string, use this: + +```csharp +var response = await client.GetAsync("endpoint?foo=bar", cancellationToken); +``` + +:::note +In v111, `GetJsonAsync` is renamed to `GetAsync`. +::: + +You can also use a more advanced extension that uses an object to compose the resource string: + +```csharp +var client = new RestClient("https://example.org"); +var args = new { + id = "123", + foo = "bar" +}; +// Will make a call to https://example.org/endpoint/123?foo=bar +var response = await client.GetAsync("endpoint/{id}", args, cancellationToken); +``` + +It will search for the URL segment parameters matching any of the object properties and replace them with values. All the other properties will be used as query parameters. + +One note about `GetAsync` is that it will deserialize the response with any supported content type, not only JSON. + +### POST calls + +Similar things are available for `POST` requests. + +```csharp +var request = new CreateOrder("123", "foo", 10100); +// Will post the request object as JSON to "orders" and returns a +// JSON response deserialized to OrderCreated +var result = client.PostJsonAsync("orders", request, cancellationToken); +``` + +```csharp +var request = new CreateOrder("123", "foo", 10100); +// Will post the request object as JSON to "orders" and returns a +// status code, not expecting any response body +var statusCode = client.PostJsonAsync("orders", request, cancellationToken); +``` + +The same two extensions also exist for `PUT` requests (`PutJsonAsync`); + +## Downloading binary data + +There are two functions that allow you to download binary data from the remote API. + +First, there's `DownloadDataAsync`, which returns `Task`. This function allows you to open a stream reader and asynchronously stream large responses to memory or disk. + +## JSON streaming + +For HTTP API endpoints that stream the response data (like [Twitter search stream](https://developer.twitter.com/en/docs/twitter-api/tweets/filtered-stream/api-reference/get-tweets-search-stream)) you can use RestSharp with `StreamJsonAsync`, which returns an `IAsyncEnumerable`: + +```csharp +public async IAsyncEnumerable SearchStream( + [EnumeratorCancellation] CancellationToken cancellationToken = default +) { + var response = _client.StreamJsonAsync>( + "tweets/search/stream", cancellationToken + ); + + await foreach (var item in response.WithCancellation(cancellationToken)) { + yield return item.Data; + } +} +``` + +The main limitation of this function is that it expects each JSON object to be returned as a single line. It is unable to parse the response by combining multiple lines into a JSON string. + diff --git a/docs/versioned_docs/version-v113/usage/request.md b/docs/versioned_docs/version-v113/usage/request.md new file mode 100644 index 000000000..27961951f --- /dev/null +++ b/docs/versioned_docs/version-v113/usage/request.md @@ -0,0 +1,356 @@ +--- +sidebar_position: 4 +title: Preparing requests +--- + +## Create a request + +Before making a request using `RestClient`, you need to create a request instance: + +```csharp +var request = new RestRequest(resource); // resource is the sub-path of the client base path +``` + +The default request type is `GET` and you can override it by setting the `Method` property. You can also set the method using the constructor overload: + +```csharp +var request = new RestRequest(resource, Method.Post); +``` + +After you've created a `RestRequest`, you can add parameters to it. Below, you can find all the parameter types supported by RestSharp. + +## Request headers + +Adds the header parameter as an HTTP header that is sent along with the request. The header name is the parameter's name and the header value is the value. + +You can use one of the following request methods to add a header parameter: + +```csharp +AddHeader(string name, string value); +AddHeader(string name, T value); // value will be converted to string +AddOrUpdateHeader(string name, string value); // replaces the header if it already exists +``` + +For example: + +```csharp +var request = new RestRequest("/path").AddHeader("X-Key", someKey); +``` + +You can also add header parameters to the client, and they will be added to every request made by the client. This is useful for adding authentication headers, for example. + +```csharp +client.AddDefaultHeader(string name, string value); +``` + +:::warning Avoid setting Content-Type header +RestSharp will use the correct content type by default. Avoid adding the `Content-Type` header manually to your requests unless you are absolutely sure it is required. You can add a custom content type to the [body parameter](#request-body) itself. +::: + +## Get or Post parameters + +The default RestSharp parameter type is `GetOrPostParameter`. You can add `GetOrPost` parameter to the request using the `AddParameter` function: + +```csharp +request + .AddParameter("name1", "value1") + .AddParameter("name2", "value2"); +``` + +`GetOrPost` behaves differently based on the HTTP method. If you execute a `GET` call, RestSharp will append the parameters to the URL in the form `url?name1=value1&name2=value2`. + +On a `POST` or `PUT` requests, it depends on whether you have files attached to a request. +If not, the parameters will be sent as the body of the request in the form `name1=value1&name2=value2`. Also, the request will be sent as `application/x-www-form-urlencoded`. + +In both cases, name and value will automatically be URL-encoded, unless specified otherwise: + +```csharp +request.AddParameter("name", "Væ üé", false); // don't encode the value +``` + +If you have files, RestSharp will send a `multipart/form-data` request. Your parameters will be part of this request in the form: + +``` +Content-Type: text/plain; charset=utf-8 +Content-Disposition: form-data; name="parameterName" + +ParameterValue +``` + +Sometimes, you need to override the default content type for the parameter when making a multipart form call. It's possible to do by setting the `ContentType` property of the parameter object. As an example, the code below will create a POST parameter with JSON value, and set the appropriate content type: + +```csharp +var parameter = new GetOrPostParameter("someJson", "{\"attributeFormat\":\"pdf\"}") { + ContentType = "application/json" +}; +request.AddParameter(parameter); +``` + +When the request is set to use multipart content, the parameter will be sent as part of the request with the specified content type: + +``` +Content-Type: application/json; charset=utf-8 +Content-Disposition: form-data; name="someJson" + +{"attributeFormat":"pdf"} +``` + +You can also add `GetOrPost` parameter as a default parameter to the client. This will add the parameter to every request made by the client. + +```csharp +client.AddDefaultParameter("foo", "bar"); +``` + +It will work the same way as request parameters, except that it will be added to every request. + +## Query string + +`QueryString` works like `GetOrPost`, except that it always appends the parameters to the url in the form `url?name1=value1&name2=value2`, regardless of the request method. + +Example: + +```csharp +var client = new RestClient("https://search.me"); +var request = new RestRequest("search") + .AddParameter("foo", "bar"); +var response = await client.GetAsync(request); +``` + +It will send a `GET` request to `https://search.me/search?foo=bar`. + +For `POST`-style requests you need to add the query string parameter explicitly: + +```csharp +request.AddQueryParameter("foo", "bar"); +``` + +In some cases, you might need to prevent RestSharp from encoding the query string parameter. +To do so, set the `encode` argument to `false` when adding the parameter: + +```csharp +request.AddQueryParameter("foo", "bar/fox", false); +``` + +You can also add a query string parameter as a default parameter to the client. This will add the parameter to every request made by the client. + +```csharp +client.AddDefaultQueryParameter("foo", "bar"); +``` + +The line above will result in all the requests made by that client instance to have `foo=bar` in the query string for all the requests made by that client. + +## Using AddObject + +You can avoid calling `AddParameter` multiple times if you collect all the parameters in an object, and then use `AddObject`. +For example, this code: + +```csharp +var params = new { + status = 1, + priority = "high", + ids = new [] { "123", "456" } +}; +request.AddObject(params); +``` + +is equivalent to: + +```csharp +request.AddParameter("status", 1); +request.AddParameter("priority", "high"); +request.AddParameter("ids", "123,456"); +``` + +Remember that `AddObject` only works if your properties have primitive types. It also works with collections of primitive types as shown above. + +If you need to override the property name or format, you can do it using the `RequestProperty` attribute. For example: + +```csharp +public class RequestModel { + // override the name and the format + [RequestProperty(Name = "from_date", Format = "d")] + public DateTime FromDate { get; set; } +} + +// add it to the request +request.AddObject(new RequestModel { FromDate = DateTime.Now }); +``` + +In this case, the request will get a GET or POST parameter named `from_date` and its value would be the current date in short date format. + +## Using AddObjectStatic + +Request function `AddObjectStatic(...)` allows using pre-compiled expressions for getting property values. Compared to `AddObject` that uses reflections for each call, `AddObjectStatic` caches functions to retrieve properties from an object of type `T`, so it works much faster. + +You can instruct `AddObjectStatic` to use custom parameter names and formats, as well as supply the list of properties than need to be used as parameters. The last option could be useful if the type `T` has properties that don't need to be sent with HTTP call. + +To use custom parameter name or format, use the `RequestProperty` attribute. For example: + +```csharp +class TestObject { + [RequestProperty(Name = "some_data")] + public string SomeData { get; set; } + + [RequestProperty(Format = "d")] + public DateTime SomeDate { get; set; } + + [RequestProperty(Name = "dates", Format = "d")] + public DateTime[] DatesArray { get; set; } + + public int Plain { get; set; } + public DateTime[] PlainArray { get; set; } +} +``` + +## URL segment parameter + +Unlike `GetOrPost`, URL segment parameter replaces placeholder values in the request URL: + +```csharp +var request = new RestRequest("health/{entity}/status") + .AddUrlSegment("entity", "s2"); +``` + +When the request executes, RestSharp will try to match any `{placeholder}` with a parameter of that name (without the `{}`) and replace it with the value. So the above code results in `health/s2/status` being the URL. + +You can also add `UrlSegment` parameter as a default parameter to the client. This will add the parameter to every request made by the client. + +```csharp +client.AddDefaultUrlSegment("foo", "bar"); +``` + +## Cookies + +You can add cookies to a request using the `AddCookie` method: + +```csharp +request.AddCookie("foo", "bar"); +``` + +The simple two-parameter form defers domain resolution until execution time — the cookie domain is inferred from the request URL. If you need to specify the path and domain explicitly, use the four-parameter overload: + +```csharp +request.AddCookie("foo", "bar", "/path", "example.com"); +``` + +RestSharp will add cookies from the request as cookie headers and then extract the matching cookies from the response. You can observe and extract response cookies using the `RestResponse.Cookies` properties, which has the `CookieCollection` type. + +There is a `CookieContainer` instance on the request level. You can either assign the pre-populated container to `request.CookieContainer`, or let the container be created automatically at execution time. The four-parameter `AddCookie` overload populates the container immediately, while the two-parameter form stores cookies in `PendingCookies` until the request is executed. The container is used to extract all the cookies from it and create cookie headers for the request instead of using the container directly. It's because the cookie container is normally configured on the `HttpClientHandler` level and cookies are shared between requests made by the same client. In most of the cases this behaviour can be harmful. + +If your use case requires sharing cookies between requests made by the client instance, you can use the client-level `CookieContainer`, which you must provide as the options' property. You can add cookies to the container using the container API. No response cookies, however, would be auto-added to the container, but you can do it in code by getting cookies from the `Cookies` property of the response and adding them to the client-level container available via `IRestClient.Options.CookieContainer` property. + +## Request Body + +RestSharp supports multiple ways to add a request body: +- `AddJsonBody` for JSON payloads +- `AddXmlBody` for XML payloads +- `AddStringBody` for pre-serialized payloads + +We recommend using `AddJsonBody` or `AddXmlBody` methods instead of `AddParameter` with type `BodyParameter`. Those methods will set the proper request type and do the serialization work for you. + +When you make a `POST`, `PUT` or `PATCH` request and added `GetOrPost` [parameters](#get-or-post-parameters), RestSharp will send them as a URL-encoded form request body by default. When a request also has files, it will send a `multipart/form-data` request. You can also instruct RestSharp to send the body as `multipart/form-data` by setting the `AlwaysMultipartFormData` property to `true`. + +You can specify a custom body content type if necessary. The `contentType` argument is available in all the overloads that add a request body. + +It is not possible to add client-level default body parameters. + +### String body + +If you have a pre-serialized payload like a JSON string, you can use `AddStringBody` to add it as a body parameter. You need to specify the content type, so the remote endpoint knows what to do with the request body. For example: + +```csharp +const json = "{ \"data\": { \"foo\": \"bar\" } }"; +request.AddStringBody(json, ContentType.Json); +``` + +### JSON body + +When you call `AddJsonBody`, it does the following for you: + +- Instructs the RestClient to serialize the object parameter as JSON when making a request +- Sets the content type to `application/json` +- Sets the internal data type of the request body to `DataType.Json` + +Here is the example: + +```csharp +var param = new MyClass { IntData = 1, StringData = "test123" }; +request.AddJsonBody(param); +``` + +It is possible to override the default content type by supplying the `contentType` argument. For example: + +```csharp +request.AddJsonBody(param, "text/x-json"); +``` + +If you use a pre-serialized string with `AddJsonBody`, it will be sent as-is. The `AddJsonBody` will detect if the parameter is a string and will add it as a string body with JSON content type. +Essentially, it means that top-level strings won't be serialized as JSON when you use `AddJsonBody`. To overcome this issue, you can use an overload of `AddJsonBody`, which allows you to tell RestSharp to serialize the string as JSON: + +```csharp +const string payload = @" +""requestBody"": { + ""content"": { + ""application/json"": { + ""schema"": { + ""type"": ""string"" + } + } + } +},"; +request.AddJsonBody(payload, forceSerialize: true); // the string will be serialized +request.AddJsonBody(payload); // the string will NOT be serialized and will be sent as-is +``` + +### XML body + +When you call `AddXmlBody`, it does the following for you: + +- Instructs the RestClient to serialize the object parameter as XML when making a request +- Sets the content type to `application/xml` +- Sets the internal data type of the request body to `DataType.Xml` + +:::warning +Do not send XML string to `AddXmlBody`; it won't work! +::: + +## Uploading files + +To add a file to the request you can use the `RestRequest` function called `AddFile`. The main function accepts the `FileParameter` argument: + +```csharp +request.AddFile(fileParameter); +``` + +You can instantiate the file parameter using `FileParameter.Create` that accepts a bytes array, or `FileParameter.FromFile`, which will load the file from disk. + +There are also extension functions that wrap the creation of `FileParameter` inside: + +```csharp +// Adds a file from disk +AddFile(parameterName, filePath, contentType); + +// Adds an array of bytes +AddFile(parameterName, bytes, fileName, contentType); + +// Adds a stream returned by the getFile function +AddFile(parameterName, getFile, fileName, contentType); +``` + +Remember that `AddFile` will set all the necessary headers, so please don't try to set content headers manually. + +You can also provide file upload options to the `AddFile` call. The options are: +- `DisableFilenameEncoding` (default `false`): if set to `true`, RestSharp will not encode the file name in the `Content-Disposition` header +- `DisableFilenameStar` (default `true`): if set to `true`, RestSharp will not add the `filename*` parameter to the `Content-Disposition` header + +Example of using the options: + +```csharp +var options = new FileParameterOptions { + DisableFilenameEncoding = true, + DisableFilenameStar = false +}; +request.AddFile("file", filePath, options: options); +``` + +The options specified in the snippet above usually help when you upload files with non-ASCII characters in their names. diff --git a/docs/versioned_docs/version-v113/usage/response.md b/docs/versioned_docs/version-v113/usage/response.md new file mode 100644 index 000000000..dbaf302b4 --- /dev/null +++ b/docs/versioned_docs/version-v113/usage/response.md @@ -0,0 +1,36 @@ +--- +sidebar_position: 6 +title: Handling responses +--- + +All `Execute{Method}Async` functions return an instance of `RestResponse`. Similarly, `Execute{Method}Async` return a generic instance of `RestResponse` where `T` is the response object type. + +Response object contains the following properties: + +| Property | Type | Description | +|--------------------------|-----------------------------------------------------|------------------------------------------------------------------------------------------| +| `Request` | `RestRequest` | Request instance that was used to get the response. | +| `ContentType` | `string?` | Response content type. `Null` if response has no content. | +| `ContentLength` | `long?` | Response content length. `Null` if response has no content. | +| `ContentEncoding` | `ICollection` | Content encoding collection. Empty if response has no content. | +| `Content` | `string?` | Response content as string. `Null` if response has no content. | +| `IsSuccessfulStatusCode` | `bool` | Indicates if response was successful, so no errors were reported by the server. | +| `ResponseStatus` | `None`, `Completed`, `Error`, `TimedOut`, `Aborted` | Response completion status. Note that completed responses might still return errors. | +| `IsSuccessful` | `bool` | `True` when `IsSuccessfulStatusCode` is `true` and `ResponseStatus` is `Completed`. | +| `StatusDescription` | `string?` | Response status description, if available. | +| `RawBytes` | `byte[]?` | Response content as byte array. `Null` if response has no content. | +| `ResponseUri` | `Uri?` | URI of the response, which might be different from request URI in case of redirects. | +| `Server` | `string?` | Server header value of the response. | +| `Cookies` | `CookieCollection?` | Collection of cookies received with the response, if any. | +| `Headers` | Collection of `HeaderParameter` | Response headers. | +| `ContentHeaders` | Collection of `HeaderParameter` | Response content headers. | +| `ErrorMessage` | `string?` | Transport or another non-HTTP error generated while attempting request. | +| `ErrorException` | `Exception?` | Exception thrown when executing the request, if any. | +| `Version` | `Version?` | HTTP protocol version of the request. | +| `RootElement` | `string?` | Root element of the serialized response content, only works if deserializer supports it. | + +In addition, `RestResponse` has one additional property: + +| Property | Type | Description | +|----------|------|-----------------------------------------------------------------------------------------------------------------------------------------------------------| +| `Data` | `T?` | Deserialized response object. `Null` if there's no content in the response, deserializer failed to understand the response content, or if request failed. | diff --git a/docs/versioned_sidebars/version-v110-sidebars.json b/docs/versioned_sidebars/version-v110-sidebars.json new file mode 100644 index 000000000..caea0c03b --- /dev/null +++ b/docs/versioned_sidebars/version-v110-sidebars.json @@ -0,0 +1,8 @@ +{ + "tutorialSidebar": [ + { + "type": "autogenerated", + "dirName": "." + } + ] +} diff --git a/docs/versioned_sidebars/version-v111-sidebars.json b/docs/versioned_sidebars/version-v111-sidebars.json new file mode 100644 index 000000000..caea0c03b --- /dev/null +++ b/docs/versioned_sidebars/version-v111-sidebars.json @@ -0,0 +1,8 @@ +{ + "tutorialSidebar": [ + { + "type": "autogenerated", + "dirName": "." + } + ] +} diff --git a/docs/versioned_sidebars/version-v112-sidebars.json b/docs/versioned_sidebars/version-v112-sidebars.json new file mode 100644 index 000000000..caea0c03b --- /dev/null +++ b/docs/versioned_sidebars/version-v112-sidebars.json @@ -0,0 +1,8 @@ +{ + "tutorialSidebar": [ + { + "type": "autogenerated", + "dirName": "." + } + ] +} diff --git a/docs/versioned_sidebars/version-v113-sidebars.json b/docs/versioned_sidebars/version-v113-sidebars.json new file mode 100644 index 000000000..caea0c03b --- /dev/null +++ b/docs/versioned_sidebars/version-v113-sidebars.json @@ -0,0 +1,8 @@ +{ + "tutorialSidebar": [ + { + "type": "autogenerated", + "dirName": "." + } + ] +} diff --git a/docs/versions.json b/docs/versions.json new file mode 100644 index 000000000..53c8813a5 --- /dev/null +++ b/docs/versions.json @@ -0,0 +1,6 @@ +[ + "v113", + "v112", + "v111", + "v110" +] diff --git a/gen/SourceGenerator/Extensions.cs b/gen/SourceGenerator/Extensions.cs new file mode 100644 index 000000000..0e740eb6e --- /dev/null +++ b/gen/SourceGenerator/Extensions.cs @@ -0,0 +1,46 @@ +// Copyright (c) .NET Foundation and Contributors +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// http://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. + +namespace SourceGenerator; + +static class Extensions { + extension(Compilation compilation) { + public IEnumerable FindClasses(Func predicate) + => compilation.SyntaxTrees + .Select(tree => compilation.GetSemanticModel(tree)) + .SelectMany(model => model.SyntaxTree.GetRoot().DescendantNodes().OfType()) + .Where(predicate); + + public IEnumerable FindAnnotatedClasses(string attributeName, bool strict) { + return compilation.FindClasses( + syntax => syntax.AttributeLists.Any(list => list.Attributes.Any(CheckAttribute)) + ); + + bool CheckAttribute(AttributeSyntax attr) { + var name = attr.Name.ToString(); + return strict ? name == attributeName : name.StartsWith(attributeName); + } + } + } + + public static IEnumerable GetBaseTypesAndThis(this ITypeSymbol type) { + var current = type; + + while (current != null) { + yield return current; + + current = current.BaseType; + } + } +} \ No newline at end of file diff --git a/gen/SourceGenerator/ImmutableGenerator.cs b/gen/SourceGenerator/ImmutableGenerator.cs new file mode 100644 index 000000000..e0860bd67 --- /dev/null +++ b/gen/SourceGenerator/ImmutableGenerator.cs @@ -0,0 +1,104 @@ +// Copyright (c) .NET Foundation and Contributors +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// http://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. +// + +namespace SourceGenerator; + +[Generator(LanguageNames.CSharp)] +public class ImmutableGenerator : IIncrementalGenerator { + public void Initialize(IncrementalGeneratorInitializationContext context) { + var c = context.CompilationProvider.SelectMany((x, _) => GetImmutableClasses(x)); + + context.RegisterSourceOutput( + c.Collect(), + static (ctx, sources) => { + foreach (var source in sources) { + ctx.AddSource(source.Item1, source.Item2); + } + } + ); + return; + + IEnumerable<(string, SourceText)> GetImmutableClasses(Compilation compilation) { + var mutableClasses = compilation.FindAnnotatedClasses("GenerateImmutable", strict: true); + + foreach (var mutableClass in mutableClasses) { + var immutableClass = GenerateImmutableClass(mutableClass, compilation); + yield return ($"ReadOnly{mutableClass.Identifier.Text}.cs", SourceText.From(immutableClass, Encoding.UTF8)); + } + } + } + + static string GenerateImmutableClass(TypeDeclarationSyntax mutableClass, Compilation compilation) { + var containingNamespace = compilation.GetSemanticModel(mutableClass.SyntaxTree).GetDeclaredSymbol(mutableClass)!.ContainingNamespace; + var namespaceName = containingNamespace.ToDisplayString(); + var className = mutableClass.Identifier.Text; + var usings = mutableClass.SyntaxTree.GetCompilationUnitRoot().Usings.Select(u => u.ToString()); + + var properties = GetDefinitions(SyntaxKind.SetKeyword) + .Select( + prop => { + var xml = prop.GetLeadingTrivia().FirstOrDefault(x => x.IsKind(SyntaxKind.SingleLineDocumentationCommentTrivia)).GetStructure(); + return $"/// {xml} public {prop.Type} {prop.Identifier.Text} {{ get; }}"; + } + ) + .ToArray(); + + var props = GetDefinitions(SyntaxKind.SetKeyword).ToArray(); + + const string argName = "inner"; + + var mutableProperties = props.Select(prop => $" {prop.Identifier.Text} = {argName}.{prop.Identifier.Text};"); + + var constructor = $$""" + public ReadOnly{{className}}({{className}} {{argName}}) { + {{string.Join("\n", mutableProperties)}} + CopyAdditionalProperties({{argName}}); + } + """; + + const string template = """ + {Usings} + + namespace {Namespace}; + + public partial class ReadOnly{ClassName} { + {Constructor} + + partial void CopyAdditionalProperties({ClassName} {ArgName}); + + {Properties} + } + """; + + var code = template + .Replace("{Usings}", string.Join("\n", usings)) + .Replace("{Namespace}", namespaceName) + .Replace("{ClassName}", className) + .Replace("{Constructor}", constructor) + .Replace("{ArgName}", argName) + .Replace("{Properties}", string.Join("\n", properties)); + + return code; + + IEnumerable GetDefinitions(SyntaxKind kind) + => mutableClass.Members + .OfType() + .Where( + prop => + prop.AccessorList!.Accessors.Any(accessor => accessor.Keyword.IsKind(kind)) && + prop.AttributeLists.All(list => list.Attributes.All(attr => attr.Name.ToString() != "Exclude")) + ); + } +} \ No newline at end of file diff --git a/gen/SourceGenerator/InheritedCloneGenerator.cs b/gen/SourceGenerator/InheritedCloneGenerator.cs new file mode 100644 index 000000000..1e3843ff9 --- /dev/null +++ b/gen/SourceGenerator/InheritedCloneGenerator.cs @@ -0,0 +1,132 @@ +// Copyright (c) .NET Foundation and Contributors +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// http://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. + +namespace SourceGenerator; + +[Generator(LanguageNames.CSharp)] +public class InheritedCloneGenerator : IIncrementalGenerator { + const string AttributeName = "GenerateClone"; + + public void Initialize(IncrementalGeneratorInitializationContext context) { + var c = context.CompilationProvider.SelectMany((x, _) => GetClones(x)); + + context.RegisterSourceOutput( + c.Collect(), + static (ctx, sources) => { + foreach (var source in sources) { + ctx.AddSource(source.Item1, source.Item2); + } + } + ); + return; + + IEnumerable<(string, SourceText)> GetClones(Compilation compilation) { + var candidates = compilation.FindAnnotatedClasses(AttributeName, false); + + foreach (var candidate in candidates) { + var semanticModel = compilation.GetSemanticModel(candidate.SyntaxTree); + var genericClassSymbol = semanticModel.GetDeclaredSymbol(candidate); + if (genericClassSymbol == null) continue; + + var attributeData = genericClassSymbol.GetAttributes().FirstOrDefault(a => a.AttributeClass?.Name == $"{AttributeName}Attribute"); + var methodName = (string)attributeData.NamedArguments.FirstOrDefault(arg => arg.Key == "Name").Value.Value; + var baseType = attributeData.NamedArguments.FirstOrDefault(arg => arg.Key == "BaseType").Value.Value; + var maybeMutate = attributeData.NamedArguments.FirstOrDefault(arg => arg.Key == "Mutate").Value.Value; + var mutate = maybeMutate as bool? ?? false; + + // Get the generic argument type where properties need to be copied from + var attributeSyntax = candidate.AttributeLists + .SelectMany(l => l.Attributes) + .FirstOrDefault(a => a.Name.ToString().StartsWith(AttributeName)); + if (attributeSyntax == null) continue; // This should never happen + + var code = GenerateMethod(candidate, genericClassSymbol, (INamedTypeSymbol)baseType, methodName, (bool)mutate!); + yield return ($"{genericClassSymbol.Name}.Clone.g.cs", SourceText.From(code, Encoding.UTF8)); + } + } + } + + static string GenerateMethod( + TypeDeclarationSyntax classToExtendSyntax, + INamedTypeSymbol classToExtendSymbol, + INamedTypeSymbol classToClone, + string methodName, + bool mutate + ) { + var namespaceName = classToExtendSymbol.ContainingNamespace.ToDisplayString(); + var className = classToExtendSyntax.Identifier.Text; + var genericTypeParameters = string.Join(", ", classToExtendSymbol.TypeParameters.Select(tp => tp.Name)); + var classDeclaration = classToExtendSymbol.TypeParameters.Length > 0 ? $"{className}<{genericTypeParameters}>" : className; + + var all = classToClone.GetBaseTypesAndThis(); + var props = all.SelectMany(x => x.GetMembers().OfType()).ToArray(); + var usings = classToExtendSyntax.SyntaxTree.GetCompilationUnitRoot().Usings.Select(u => u.ToString()); + + var constructorParams = classToExtendSymbol.Constructors.First().Parameters.ToArray(); + var constructorArgs = string.Join(", ", constructorParams.Select(p => $"original.{GetPropertyName(p.Name, props)}")); + var constructorParamNames = constructorParams.Select(p => p.Name).ToArray(); + + var endLine = mutate ? ";" : ","; + var spaces = string.Empty.PadRight(mutate ? 8 : 12); + var properties = props + // ReSharper disable once PossibleUnintendedLinearSearchInSet + .Where(prop => !constructorParamNames.Contains(prop.Name, StringComparer.OrdinalIgnoreCase) && prop.SetMethod != null) + .Select(prop => $"{spaces}{prop.Name} = original.{prop.Name}{endLine}") + .ToArray(); + + const string immutableTemplate = + """ + {Usings} + + namespace {Namespace}; + + public partial class {ClassDeclaration} { + public static {ClassDeclaration} {MethodName}({OriginalClassName} original) { + return new {ClassDeclaration}({ConstructorArgs}) { + {Properties} + }; + } + } + """; + const string mutableTemplate = + """ + {Usings} + + namespace {Namespace}; + + public partial class {ClassDeclaration} { + public void {MethodName}({OriginalClassName} original) { + {Properties} + } + } + """; + var template = mutate ? mutableTemplate : immutableTemplate; + + var code = template + .Replace("{Usings}", string.Join("\n", usings)) + .Replace("{Namespace}", namespaceName) + .Replace("{ClassDeclaration}", classDeclaration) + .Replace("{OriginalClassName}", classToClone.Name) + .Replace("{MethodName}", methodName) + .Replace("{ConstructorArgs}", constructorArgs) + .Replace("{Properties}", string.Join("\n", properties).TrimEnd(',')); + + return code; + + static string GetPropertyName(string parameterName, IPropertySymbol[] properties) { + var property = properties.FirstOrDefault(p => string.Equals(p.Name, parameterName, StringComparison.OrdinalIgnoreCase)); + return property?.Name ?? parameterName; + } + } +} \ No newline at end of file diff --git a/gen/SourceGenerator/Properties/launchSettings.json b/gen/SourceGenerator/Properties/launchSettings.json new file mode 100644 index 000000000..cd06df480 --- /dev/null +++ b/gen/SourceGenerator/Properties/launchSettings.json @@ -0,0 +1,9 @@ +{ + "$schema": "http://json.schemastore.org/launchsettings.json", + "profiles": { + "Generators": { + "commandName": "DebugRoslynComponent", + "targetProject": "../../src/RestSharp/RestSharp.csproj" + } + } +} \ No newline at end of file diff --git a/gen/SourceGenerator/SourceGenerator.csproj b/gen/SourceGenerator/SourceGenerator.csproj new file mode 100644 index 000000000..2d26b1392 --- /dev/null +++ b/gen/SourceGenerator/SourceGenerator.csproj @@ -0,0 +1,26 @@ + + + netstandard2.0 + preview + enable + disable + false + true + false + + + + + + + + + + + + + + + + + diff --git a/props/Common.props b/props/Common.props new file mode 100644 index 000000000..f0ee2b686 --- /dev/null +++ b/props/Common.props @@ -0,0 +1,13 @@ + + + $([System.IO.Directory]::GetParent($(MSBuildThisFileDirectory)).Parent.FullName) + $(RepoRoot)\RestSharp.snk + true + preview + enable + enable + + + + + \ No newline at end of file diff --git a/readme.txt b/readme.txt deleted file mode 100644 index 1b5637e38..000000000 --- a/readme.txt +++ /dev/null @@ -1,25 +0,0 @@ -*** IMPORTANT CHANGE IN RESTSHARP VERSION 103 *** - -In 103.0, JSON.NET was removed as a dependency. - -If this is still installed in your project and no other libraries depend on -it you may remove it from your installed packages. - -There is one breaking change: the default Json*Serializer* is no longer -compatible with Json.NET. To use Json.NET for serialization, copy the code -from https://github.com/restsharp/RestSharp/blob/86b31f9adf049d7fb821de8279154f41a17b36f7/RestSharp/Serializers/JsonSerializer.cs -and register it with your request: - - var request = new RestRequest(); - request.JsonSerializer = new Shared.JsonSerializer(); - -then you can use it in a client: - - var client = new RestClient(); - client.Post(request); - -The default Json*Deserializer* is mostly compatible, but it does not support -all features which Json.NET has (like the ability to support a custom [JsonConverter] -by decorating a certain property with an attribute). If you need these features, you -must take care of the deserialization yourself to get it working. - diff --git a/releasenotes.md b/releasenotes.md deleted file mode 100644 index d99681454..000000000 --- a/releasenotes.md +++ /dev/null @@ -1,172 +0,0 @@ -# RestSharp Release Notes - -## 105.2.2 - -* Added nuget targets for windows phone 8 and 8.1, monotouch10, monoandroid10, xamarin.ios10, net46 -* fixed the silverlight target to be sl5 -* added all projects to the solution -* cleaned up and consolidated the build and packaging scripts -* **Code clean-up and namespace patching may cause breaking changes** - -To see all commits for this version, [click here](https://github.com/RestSharp/RestSharp/compare/105.2.1...105.2.2). - -## 105.2.1 - -* **Code clean-up and namespace patching may cause breaking changes** - -To see all commits for this version, [click here](https://github.com/RestSharp/RestSharp/compare/105.1.0...105.2.1). - -## 105.1.0 - -To see all commits for this version, [click here](https://github.com/RestSharp/RestSharp/compare/105.0...105.1.0). - -## 105.0.1 - -To see all commits for this version, [click here](https://github.com/RestSharp/RestSharp/compare/105.0...105.0.1). - -### Bug Fixes - -* Reverted changes to parameter encoding - -## 105.0.0 - -To see all commits for this version, [click here](https://github.com/RestSharp/RestSharp/compare/104.5.0...105.0). - -### New Features/Improvements - -* Converted the BaseUrl to be a URI rather than a string **(potential breaking change)** -* Updated the SimpleJson package to the latest version **(potential breaking change)** -* Converted the use of tabs to spaces -* Added support for the DeserializeAs attribute on XML -* Added ability to deserialize into structs -* Added additional methods on RestRequest - * `IRestRequest.AddJsonBody` - * `IRestRequest.AddXmlBody` - * `IRestRequest.AddQueryParameter` -* Added support for multi-part form request to allow both a request body and files - -### Bug Fixes - -* Fixed potential Null Reference Exceptions on the parameters in RestClient (ToString usage) - -## 104.5.0 - -To see all commits for this version, [click here](https://github.com/RestSharp/RestSharp/compare/104.4.0...104.5.0). - -## 104.4.0 - -To see all commits for this version, [click here](https://github.com/RestSharp/RestSharp/compare/104.3.3...104.4.0). - -## 104.3.3 - -To see all commits for this version, [click here](https://github.com/RestSharp/RestSharp/compare/104.2...104.3.3). - -### New Features/Improvements - -* Support for query string parameters on POST requests -* Deserialize an integer to a bool property -* Enable Task extensions for Monotouch and Monodroid platforms -* Support for deserializing a dictionary of lists - -### Bug Fixes - -* Fixed regression that prevented deserializing requests when non-protocol errors occurred -* Properly URL encode strings longer than 32766 characters - -## 104.2 - -To see all commits for this version, [click here](https://github.com/RestSharp/RestSharp/compare/104.1...104.2). - -### New Features - -* Allow specifying the body of a `PUT` or `POST` to be specified as a byte array. -* Added `ExecuteAsync` overloads that return `Task` -* Improved handling of nullable types -* Support `DateTimeOffset` to `XmlDeserializer` - -### Bug Fixes - -* Crash if an XML attribute contains empty string -* Adding array of int to request -* Support XAuth parameters for OAuth parameter handling -* Memory leak around handling of Accepts header -* `ConfigureProxy` was not being called for async request -* Serialization for classes with `IList` properties -* Exception when executing async requests on multiple threads with one `RestClient` -* ResponseStatus.Aborted was not being set if request was aborted -* ClientCertificate threw `NotImplementedException` on Mono -* Fix decimal parsing for small decimal values - -## 104.1 - -* Fixed bug where ExecuteAsync sometimes doesn't send data - -## 104.0 - -* Fixed Windows Phone and Silverlight to use culture when calling Convert.ChangeType() (thanks trydis) -* Added support for non-standard HTTP methods (thanks jhoerr) - New API methods include: - * `IRestClient.ExecuteAsyncGet()` - * `IRestClient.ExecuteAsyncPost()` - * `IRestClient.ExecuteAsyncGet()` - * `IRestClient.ExecuteAsyncPost()` - - See [groups discussion](https://groups.google.com/forum/?fromgroups=#!topic/restsharp/FCLGE5By7AU) for more info - -* Resolved an xAuth support issue in the OAuth1Authenticator (thanks artema) -* Change AddDefaultParameter methods to be extension methods (thanks haacked) - Added `RestClientExtensions.AddDefaultParameter()` with 4 overloads. See pull request [#311](https://github.com/restsharp/RestSharp/pull/311) for more info - -* Adding support for deserializing enums from integer representations (thanks dontjee) - -## 103.4 - -* Version bump to fix assembly versioning - -## 103.3 - -* Added in the check for it being generic before calling GetGenericType Definition() (thanks nicwise) -* Add support for deserializing properties with an underscore prefix (thanks psampaio) -* BaseUrl is now virtual (thanks Haacked) -* Fixed List json deserialization, when T was a something like DateTime, Timespan, Guid, etc. (thanks PedroLamas) -* Improve support for parsing iso8601 dates (thanks friism) - -## 103.2 - -### New Features - -* Allow deserializing a single item into a List field, for JSON that only uses a list when there's more than one item for a given field (thanks petejohanson) -* Extended NtlmAuthenticator so that it can also impersonate a user (thanks kleinron) -* Added support for mapping JSON objects to Dictionary (thanks petejohanson) -* Added ability to set Host and Date when built for .NET 4.0 (thanks lukebakken) -* Allow deserializing lists with null in them. Should resolve pull request (thanks petejohanson) -* Add support for deserializing JSON to subclasses of List (thanks abaybuzskiy) - -### Bugs fixed -* Fixed invalid OAuth1 signature for GET request (thanks trilobyte) -* Added some missing OAuth files to the .NET4 and Silverlight projects (thanks PedroLamas) -* Removed unused NewtonsoftJsonMonoTouch.dll and Newtonsoft.Json.MonoDroid.dll binaries (thanks attilah) -* Fixed various issues with MonoTouch/Droid ports (thanks attilah) -* Add ability to set Host and Date when built for .NET 4.0 (thanks lukebakken) -* Fixed XmlDeserializer issue not handling lowercase + dash root elements in some cases -* Fixed an issue where RestResponse.Request was not populated (thanks mattleibow) -* Don't crash on captive networks that intercept SSL (thanks aroben) - -## 103.1 - -* #267 Added CLS Compliance -* #263 Fixed InvalidCastException -* #218 Handles connection failures better -* #231 OAuth now complies with rfc3986 url hex encoding - -## 103.0 - Remove dependency on Json.NET - -* Remove WP7.0 support (7.1 Mango remains). - -## 102.7 - -* Updating Json.NET to 4.0.8, misc fixes - -## 102.6 - -* Updating Json.NET reference to 4.0.5 diff --git a/src/Directory.Build.props b/src/Directory.Build.props new file mode 100644 index 000000000..614781bf3 --- /dev/null +++ b/src/Directory.Build.props @@ -0,0 +1,41 @@ + + + + netstandard2.0;net471;net48;net8.0;net9.0;net10.0 + restsharp.png + Apache-2.0 + https://restsharp.dev + https://github.com/restsharp/RestSharp.git + git + Simple REST and HTTP API Client + .NET Foundation and Contributors + Copyright © $(Authors) $([System.DateTime]::Now.Year) + true + true + true + snupkg + true + $(NoWarn);1591 + README.md + + + + true + true + + + + + + + + + + + + + $(MinVerMajor).$(MinVerMinor).$(MinVerPatch) + $(MinVerMajor).$(MinVerMinor).$(MinVerPatch) + + + \ No newline at end of file diff --git a/src/RestSharp.Extensions.DependencyInjection/Constants.cs b/src/RestSharp.Extensions.DependencyInjection/Constants.cs new file mode 100644 index 000000000..058cad26e --- /dev/null +++ b/src/RestSharp.Extensions.DependencyInjection/Constants.cs @@ -0,0 +1,21 @@ +// Copyright (c) .NET Foundation and Contributors +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// http://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. + +namespace RestSharp.Extensions.DependencyInjection; + +static class Constants { + public const string DefaultRestClient = "DefaultRestClient"; + + public static string GetConfigName(string name) => $"{name}$RestClient"; +} \ No newline at end of file diff --git a/src/RestSharp.Extensions.DependencyInjection/DefaultRestClientFactory.cs b/src/RestSharp.Extensions.DependencyInjection/DefaultRestClientFactory.cs new file mode 100644 index 000000000..124257f7e --- /dev/null +++ b/src/RestSharp.Extensions.DependencyInjection/DefaultRestClientFactory.cs @@ -0,0 +1,25 @@ +// Copyright (c) .NET Foundation and Contributors +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// http://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. + +using Microsoft.Extensions.Options; + +namespace RestSharp.Extensions.DependencyInjection; + +class DefaultRestClientFactory(IHttpClientFactory httpClientFactory, IOptionsMonitor optionsMonitor) : IRestClientFactory { + public IRestClient CreateClient(string name) { + var options = optionsMonitor.Get(Constants.GetConfigName(name)); + var httpClient = httpClientFactory.CreateClient(name); + return new RestClient(httpClient, true, options.ConfigureRestClient, options.ConfigureSerialization); + } +} \ No newline at end of file diff --git a/src/RestSharp.Extensions.DependencyInjection/IRestClientFactory.cs b/src/RestSharp.Extensions.DependencyInjection/IRestClientFactory.cs new file mode 100644 index 000000000..2462e515a --- /dev/null +++ b/src/RestSharp.Extensions.DependencyInjection/IRestClientFactory.cs @@ -0,0 +1,19 @@ +// Copyright (c) .NET Foundation and Contributors +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// http://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. + +namespace RestSharp.Extensions.DependencyInjection; + +public interface IRestClientFactory { + IRestClient CreateClient(string name); +} \ No newline at end of file diff --git a/src/RestSharp.Extensions.DependencyInjection/README.md b/src/RestSharp.Extensions.DependencyInjection/README.md new file mode 100644 index 000000000..498c5fac2 --- /dev/null +++ b/src/RestSharp.Extensions.DependencyInjection/README.md @@ -0,0 +1,45 @@ +# About + +The `RestSharp.Extensions.DependencyInjection` library provides integration with `Microsoft.Extensions.DependencyInjection` components as well as integrates with `IHttpClientFactory`. + +# How to use + +Use the extension method provided by the package to configure the client: + +```csharp +// Add a default client with no base URL, with default options +services.AddRestClient(); + +// Add a client with a base URL +services.AddRestClient(new Uri("https://example.com")); + +// Add a client with a base URL and custom options +services.AddRestClient(options => +{ + options.BaseUrl = new Uri("https://example.com"); + options.Timeout = TimeSpan.FromSeconds(30); +}); +``` + +When the above registrations are used, the `IRestClient` interface can be injected into any class. + +In addition, the package supports registering named clients: + +```csharp +services.AddRestClient("my-client", options => +{ + options.BaseUrl = new Uri("https://example.com"); + options.Timeout = TimeSpan.FromSeconds(30); +}); +``` + +When the above registrations are used, resolving the client instance should be done using the `IRestClientFactory`: + +```csharp +public class MyClass(IRestClientFactory restClientFactory) +{ + IRestClient client = restClientFactory.CreateClient("my-client"); + + // Use the client in your code +} +``` \ No newline at end of file diff --git a/src/RestSharp.Extensions.DependencyInjection/RestClientConfigOptions.cs b/src/RestSharp.Extensions.DependencyInjection/RestClientConfigOptions.cs new file mode 100644 index 000000000..6ba35f6ce --- /dev/null +++ b/src/RestSharp.Extensions.DependencyInjection/RestClientConfigOptions.cs @@ -0,0 +1,20 @@ +// Copyright (c) .NET Foundation and Contributors +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// http://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. + +namespace RestSharp.Extensions.DependencyInjection; + +class RestClientConfigOptions { + public ConfigureRestClient? ConfigureRestClient { get; set; } + public ConfigureSerialization? ConfigureSerialization { get; set; } +} \ No newline at end of file diff --git a/src/RestSharp.Extensions.DependencyInjection/RestSharp.Extensions.DependencyInjection.csproj b/src/RestSharp.Extensions.DependencyInjection/RestSharp.Extensions.DependencyInjection.csproj new file mode 100644 index 000000000..32210a920 --- /dev/null +++ b/src/RestSharp.Extensions.DependencyInjection/RestSharp.Extensions.DependencyInjection.csproj @@ -0,0 +1,15 @@ + + + + + + + + + + + true + / + + + diff --git a/src/RestSharp.Extensions.DependencyInjection/ServiceCollectionExtensions.cs b/src/RestSharp.Extensions.DependencyInjection/ServiceCollectionExtensions.cs new file mode 100644 index 000000000..d1f13c36d --- /dev/null +++ b/src/RestSharp.Extensions.DependencyInjection/ServiceCollectionExtensions.cs @@ -0,0 +1,107 @@ +using Microsoft.Extensions.DependencyInjection; +using Microsoft.Extensions.DependencyInjection.Extensions; + +namespace RestSharp.Extensions.DependencyInjection; + +public static class ServiceCollectionExtensions { + extension(IServiceCollection services) { + /// + /// Adds a named RestClient to the service collection. + /// + /// Client name + /// Optional: function to configure the client options. + /// Optional: function to configure serializers. + [PublicAPI] + public void AddRestClient( + string name, + ConfigureRestClient? configureRestClient = null, + ConfigureSerialization? configureSerialization = null + ) { + Ensure.NotEmptyString(name, nameof(name)); + Ensure.NotNull(services, nameof(services)); + + var options = new RestClientOptions(); + var configure = configureRestClient ?? (_ => { }); + configure(options); + + services + .AddHttpClient(name) + .ConfigureHttpClient(client => RestClient.ConfigureHttpClient(client, options)) + .ConfigurePrimaryHttpMessageHandler(() => { + var handler = new HttpClientHandler(); + RestClient.ConfigureHttpMessageHandler(handler, options); + return handler; + } + ); + + services.TryAddSingleton(); + + if (name == Constants.DefaultRestClient) { + services.AddTransient(sp => { + var client = sp.GetRequiredService().CreateClient(name); + return new RestClient(client, options); + } + ); + } + else { + services.Configure( + Constants.GetConfigName(name), + o => { + o.ConfigureRestClient = configureRestClient; + o.ConfigureSerialization = configureSerialization; + } + ); + } + } + + /// + /// Adds a RestClient to the service collection with default options. + /// + [PublicAPI] + public void AddRestClient() => services.AddRestClient(Constants.DefaultRestClient); + + /// + /// Adds a RestClient to the service collection with a base URL. + /// + /// The base URL for the RestClient. + [PublicAPI] + public void AddRestClient(Uri baseUrl) => services.AddRestClient(Constants.DefaultRestClient, o => o.BaseUrl = baseUrl); + + /// + /// Adds a RestClient to the service collection with custom options. + /// + /// Custom options for the RestClient. + [PublicAPI] + public void AddRestClient(RestClientOptions options) { + Ensure.NotNull(options, nameof(options)); + services.AddRestClient(Constants.DefaultRestClient, o => o.CopyFrom(options)); + } + + /// + /// Adds a RestClient to the service collection with custom options. + /// + /// Function to configure the RestClient options. + [PublicAPI] + public void AddRestClient(ConfigureRestClient configureRestClient) { + Ensure.NotNull(configureRestClient, nameof(configureRestClient)); + services.AddRestClient(Constants.DefaultRestClient, configureRestClient); + } + + /// + /// Adds a named RestClient to the service collection with base URL. + /// + /// Client name. + /// The base URL for the RestClient. + public void AddRestClient(string name, Uri baseUrl) => services.AddRestClient(name, o => o.BaseUrl = baseUrl); + + /// + /// Adds a named RestClient to the service collection with custom options. + /// + /// Client name. + /// Custom options for the RestClient. + public void AddRestClient(string name, RestClientOptions options) { + Ensure.NotNull(options, nameof(options)); + services.AddRestClient(name, o => o.CopyFrom(options)); + } + } +} \ No newline at end of file diff --git a/src/RestSharp.Serializers.CsvHelper/CsvHelperSerializer.cs b/src/RestSharp.Serializers.CsvHelper/CsvHelperSerializer.cs new file mode 100644 index 000000000..54e82ab2a --- /dev/null +++ b/src/RestSharp.Serializers.CsvHelper/CsvHelperSerializer.cs @@ -0,0 +1,89 @@ +using CsvHelper; +using CsvHelper.Configuration; +using System.Collections; +using System.Globalization; + +namespace RestSharp.Serializers.CsvHelper; + +public class CsvHelperSerializer(CsvConfiguration configuration) : IDeserializer, IRestSerializer, ISerializer { + public ISerializer Serializer => this; + + public IDeserializer Deserializer => this; + + public string[] AcceptedContentTypes => [ContentType.Csv, "application/x-download"]; + + public SupportsContentType SupportsContentType => x => Array.IndexOf(AcceptedContentTypes, x) != -1 || x.Value.Contains("csv"); + + public DataFormat DataFormat => DataFormat.None; + + public ContentType ContentType { get; set; } = ContentType.Csv; + + public CsvHelperSerializer() : this(new(CultureInfo.InvariantCulture)) { } + + public T? Deserialize(RestResponse response) { + try { + if (response.Content == null) + throw new InvalidOperationException(message: "Response content is null"); + + using var stringReader = new StringReader(response.Content); + using var csvReader = new CsvReader(stringReader, configuration); + + var @interface = typeof(T).GetInterface("IEnumerable`1"); + + if (@interface == null) { + csvReader.Read(); + return csvReader.GetRecord(); + } + + var itemType = @interface.GenericTypeArguments[0]; + T result; + + try { + result = Activator.CreateInstance(); + } + catch (MissingMethodException) { + throw new InvalidOperationException(message: "The type must contain a public, parameterless constructor."); + } + + var method = typeof(T).GetMethod(name: "Add"); + + if (method == null) { + throw new InvalidOperationException( + message: "If the type implements IEnumerable, then it must contain a public \"Add(T)\" method." + ); + } + + foreach (var record in csvReader.GetRecords(itemType)) { + method.Invoke(result, [record]); + } + + return result; + } + catch (Exception exception) { + throw new DeserializationException(response, exception); + } + } + + public string? Serialize(Parameter parameter) => Serialize(parameter.Value); + + public string? Serialize(object? obj) { + if (obj == null) { + return null; + } + + using var stringWriter = new StringWriter(); + using var csvWriter = new CsvWriter(stringWriter, configuration); + + if (obj is IEnumerable records) { + csvWriter.WriteRecords(records); + } + else { + csvWriter.WriteHeader(obj.GetType()); + csvWriter.NextRecord(); + csvWriter.WriteRecord(obj); + csvWriter.NextRecord(); + } + + return stringWriter.ToString(); + } +} \ No newline at end of file diff --git a/src/RestSharp.Serializers.CsvHelper/README.md b/src/RestSharp.Serializers.CsvHelper/README.md new file mode 100644 index 000000000..3c7d3815c --- /dev/null +++ b/src/RestSharp.Serializers.CsvHelper/README.md @@ -0,0 +1,24 @@ +# About + +The `RestSharp.Serializers.CsvHelper` library provides a CSV serializer for RestSharp. It is based on the +`CsvHelper` library. + +# How to use + +Use the extension method provided by the package to configure the client: + +```csharp +var client = new RestClient( + options, + configureSerialization: s => s.UseCsvHelper() +); +``` + +You can also supply your instance of `CsvConfiguration` as a parameter for the extension method. + +```csharp +var client = new RestClient( + options, + configureSerialization: s => s.UseCsvHelper(new CsvConfiguration(CultureInfo.InvariantCulture) {...}) +); +``` diff --git a/src/RestSharp.Serializers.CsvHelper/RestClientExtensions.cs b/src/RestSharp.Serializers.CsvHelper/RestClientExtensions.cs new file mode 100644 index 000000000..4d6456b76 --- /dev/null +++ b/src/RestSharp.Serializers.CsvHelper/RestClientExtensions.cs @@ -0,0 +1,13 @@ +using CsvHelper.Configuration; + +namespace RestSharp.Serializers.CsvHelper; + +[PublicAPI] +public static class RestClientExtensions { + extension(SerializerConfig config) { + public SerializerConfig UseCsvHelper() => config.UseSerializer(); + + public SerializerConfig UseCsvHelper(CsvConfiguration configuration) + => config.UseSerializer(() => new CsvHelperSerializer(configuration)); + } +} diff --git a/src/RestSharp.Serializers.CsvHelper/RestSharp.Serializers.CsvHelper.csproj b/src/RestSharp.Serializers.CsvHelper/RestSharp.Serializers.CsvHelper.csproj new file mode 100644 index 000000000..9c503dd50 --- /dev/null +++ b/src/RestSharp.Serializers.CsvHelper/RestSharp.Serializers.CsvHelper.csproj @@ -0,0 +1,14 @@ + + + + + + + + + + + + + + diff --git a/src/RestSharp.Serializers.NewtonsoftJson/JsonNetSerializer.cs b/src/RestSharp.Serializers.NewtonsoftJson/JsonNetSerializer.cs new file mode 100644 index 000000000..d5ee33046 --- /dev/null +++ b/src/RestSharp.Serializers.NewtonsoftJson/JsonNetSerializer.cs @@ -0,0 +1,83 @@ +// Copyright (c) .NET Foundation and Contributors +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// http://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. + +using Newtonsoft.Json.Serialization; + +namespace RestSharp.Serializers.NewtonsoftJson; + +public class JsonNetSerializer : IRestSerializer, ISerializer, IDeserializer { + /// + /// Default serialization settings: + /// - Camel-case contract resolver + /// - Type name handling set to none + /// - Null values ignored + /// - Non-indented formatting + /// - Allow using non-public constructors + /// + public static readonly JsonSerializerSettings DefaultSettings = new() { + ContractResolver = new CamelCasePropertyNamesContractResolver(), + DefaultValueHandling = DefaultValueHandling.Include, + TypeNameHandling = TypeNameHandling.None, + NullValueHandling = NullValueHandling.Ignore, + Formatting = Formatting.None, + ConstructorHandling = ConstructorHandling.AllowNonPublicDefaultConstructor + }; + + [ThreadStatic] static WriterBuffer? _writerBuffer; + + readonly JsonSerializer _serializer; + + /// + /// Create the new serializer that uses Json.Net with default settings + /// + public JsonNetSerializer() => _serializer = JsonSerializer.Create(DefaultSettings); + + /// + /// Create the new serializer that uses Json.Net with custom settings + /// + /// Json.Net serializer settings + public JsonNetSerializer(JsonSerializerSettings settings) => _serializer = JsonSerializer.Create(settings); + + public string? Serialize(object? obj) { + if (obj == null) return null; + + using var buffer = _writerBuffer ??= new(_serializer); + + _serializer.Serialize(buffer.GetJsonTextWriter(), obj, obj.GetType()); + + return buffer.GetStringWriter().ToString(); + } + + public string? Serialize(Parameter bodyParameter) => Serialize(bodyParameter.Value); + + public T? Deserialize(RestResponse response) { + if (response.Content == null) + throw new DeserializationException(response, new InvalidOperationException("Response content is null")); + + using var reader = new JsonTextReader(new StringReader(response.Content)) { CloseInput = true }; + + return _serializer.Deserialize(reader); + } + + public ISerializer Serializer => this; + public IDeserializer Deserializer => this; + + public string[] AcceptedContentTypes => ContentType.JsonAccept; + + public ContentType ContentType { get; set; } = ContentType.Json; + + public SupportsContentType SupportsContentType => contentType => contentType.Value.Contains("json"); + + public DataFormat DataFormat => DataFormat.Json; +} \ No newline at end of file diff --git a/src/RestSharp.Serializers.NewtonsoftJson/README.md b/src/RestSharp.Serializers.NewtonsoftJson/README.md new file mode 100644 index 000000000..5cc11a71b --- /dev/null +++ b/src/RestSharp.Serializers.NewtonsoftJson/README.md @@ -0,0 +1,19 @@ +# About + +This library allows using Newtonsoft.Json as a serializer for RestSharp instead of the default JSON serializer based +on `System.Text.Json`. + +# How to use + +The default JSON serializer uses `System.Text.Json`, which is a part of .NET since .NET 6. + +If you want to use Newtonsoft.Json, you can install the `RestSharp.Serializers.NewtonsoftJson` package and configure +the +client to use it: + +```csharp +var client = new RestClient( + options, + configureSerialization: s => s.UseNewtonsoftJson() +); +``` \ No newline at end of file diff --git a/src/RestSharp.Serializers.NewtonsoftJson/RestClientExtensions.cs b/src/RestSharp.Serializers.NewtonsoftJson/RestClientExtensions.cs new file mode 100644 index 000000000..7f6e6ffec --- /dev/null +++ b/src/RestSharp.Serializers.NewtonsoftJson/RestClientExtensions.cs @@ -0,0 +1,35 @@ +// Copyright (c) .NET Foundation and Contributors +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// http://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. + +namespace RestSharp.Serializers.NewtonsoftJson; + +[PublicAPI] +public static class RestClientExtensions { + /// + extension(SerializerConfig config) { + /// + /// Use Newtonsoft.Json serializer with default settings + /// + /// + public SerializerConfig UseNewtonsoftJson() => config.UseSerializer(() => new JsonNetSerializer()); + + /// + /// Use Newtonsoft.Json serializer with custom settings + /// + /// Newtonsoft.Json serializer settings + /// + public SerializerConfig UseNewtonsoftJson(JsonSerializerSettings settings) + => config.UseSerializer(() => new JsonNetSerializer(settings)); + } +} \ No newline at end of file diff --git a/src/RestSharp.Serializers.NewtonsoftJson/RestSharp.Serializers.NewtonsoftJson.csproj b/src/RestSharp.Serializers.NewtonsoftJson/RestSharp.Serializers.NewtonsoftJson.csproj new file mode 100644 index 000000000..45bcf8ca9 --- /dev/null +++ b/src/RestSharp.Serializers.NewtonsoftJson/RestSharp.Serializers.NewtonsoftJson.csproj @@ -0,0 +1,15 @@ + + + + + + + + + + + + + + + diff --git a/src/RestSharp.Serializers.NewtonsoftJson/WriterBuffer.cs b/src/RestSharp.Serializers.NewtonsoftJson/WriterBuffer.cs new file mode 100644 index 000000000..a1505a869 --- /dev/null +++ b/src/RestSharp.Serializers.NewtonsoftJson/WriterBuffer.cs @@ -0,0 +1,36 @@ +// Copyright (c) .NET Foundation and Contributors +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// http://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. + +using System.Globalization; + +namespace RestSharp.Serializers.NewtonsoftJson; + +sealed class WriterBuffer : IDisposable { + readonly StringWriter _stringWriter; + readonly JsonTextWriter _jsonTextWriter; + + public WriterBuffer(JsonSerializer jsonSerializer) { + _stringWriter = new(new(256), CultureInfo.InvariantCulture); + + _jsonTextWriter = new(_stringWriter) { + Formatting = jsonSerializer.Formatting, CloseOutput = false + }; + } + + public JsonTextWriter GetJsonTextWriter() => _jsonTextWriter; + + public StringWriter GetStringWriter() => _stringWriter; + + public void Dispose() => _stringWriter.GetStringBuilder().Clear(); +} \ No newline at end of file diff --git a/src/RestSharp.Serializers.Xml/DeserializeAsAttribute.cs b/src/RestSharp.Serializers.Xml/DeserializeAsAttribute.cs new file mode 100644 index 000000000..ecb235e90 --- /dev/null +++ b/src/RestSharp.Serializers.Xml/DeserializeAsAttribute.cs @@ -0,0 +1,37 @@ +// Copyright (c) .NET Foundation and Contributors +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// http://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. + +// ReSharper disable once CheckNamespace +namespace RestSharp.Serializers; + +/// +/// Allows control how class and property names and values are deserialized by XmlAttributeDeserializer +/// +[AttributeUsage(AttributeTargets.Property | AttributeTargets.Class, Inherited = false)] +public sealed class DeserializeAsAttribute : Attribute { + /// + /// The name to use for the serialized element + /// + public string? Name { get; set; } + + /// + /// Sets if the property to Deserialize is an Attribute or Element (Default: false) + /// + public bool Attribute { get; set; } + + /// + /// Sets if the property to Deserialize is a content of current Element (Default: false) + /// + public bool Content { get; set; } +} \ No newline at end of file diff --git a/src/RestSharp.Serializers.Xml/README.md b/src/RestSharp.Serializers.Xml/README.md new file mode 100644 index 000000000..63a7f53cc --- /dev/null +++ b/src/RestSharp.Serializers.Xml/README.md @@ -0,0 +1,22 @@ +# About + +This package is a custom XML serializer for RestSharp. It is based on the original XML serializer that was part of RestSharp but was removed in version 107.0.0. + +# How to use + +The default XML serializer in RestSharp is `DotNetXmlSerializer`, which uses `System.Xml.Serialization` library from . +NET. + +In previous versions of RestSharp, the default XML serializer was a custom RestSharp XML serializer. To make the +code library size smaller, the custom serializer was removed from RestSharp. + +You can add it back if necessary by installing the `RestSharp.Serializers.Xml` package and adding it to the client: + +```csharp +var client = new RestClient( + options, + configureSerialization: s => s.UseXmlSerializer() +); +``` + +As before, you can supply three optional arguments for a custom namespace, custom root element, and if you want to use `SerializeAs` and `DeserializeAs` attributed. diff --git a/src/RestSharp.Serializers.Xml/RestSharp.Serializers.Xml.csproj b/src/RestSharp.Serializers.Xml/RestSharp.Serializers.Xml.csproj new file mode 100644 index 000000000..42ee74306 --- /dev/null +++ b/src/RestSharp.Serializers.Xml/RestSharp.Serializers.Xml.csproj @@ -0,0 +1,14 @@ + + + RestSharp.Serializers.Xml + + + + + + + + + + + diff --git a/src/RestSharp.Serializers.Xml/SerializeAsAttribute.cs b/src/RestSharp.Serializers.Xml/SerializeAsAttribute.cs new file mode 100644 index 000000000..598f446b5 --- /dev/null +++ b/src/RestSharp.Serializers.Xml/SerializeAsAttribute.cs @@ -0,0 +1,80 @@ +// Copyright (c) .NET Foundation and Contributors +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// http://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. + +using System.Globalization; +using RestSharp.Extensions; +// ReSharper disable AutoPropertyCanBeMadeGetOnly.Global +// ReSharper disable MemberCanBePrivate.Global + +// ReSharper disable once CheckNamespace +namespace RestSharp.Serializers; + +/// +/// Allows control how class and property names and values are serialized by XmlSerializer +/// Currently not supported with the JsonSerializer +/// When specified at the property level the class-level specification is overridden +/// +[AttributeUsage(AttributeTargets.Property | AttributeTargets.Class, Inherited = false)] +public sealed class SerializeAsAttribute : Attribute { + /// + /// The name to use for the serialized element + /// + public string? Name { get; set; } + + /// + /// Sets the value to be serialized as an Attribute instead of an Element + /// + public bool Attribute { get; set; } + + /// + /// Sets the value to be serialized as text content of current Element instead of an new Element + /// + public bool Content { get; set; } + + /// + /// The culture to use when serializing + /// + public CultureInfo Culture { get; set; } = CultureInfo.InvariantCulture; + + /// + /// Transforms the casing of the name based on the selected value. + /// + public NameStyle NameStyle { get; set; } = NameStyle.AsIs; + + /// + /// The order to serialize the element. Default is int.MaxValue. + /// + public int Index { get; set; } = int.MaxValue; + + /// + /// Called by the attribute when NameStyle is speficied + /// + /// The string to transform + /// String + public string TransformName(string input) { + var name = Name ?? input; + + return NameStyle switch { + NameStyle.CamelCase => name.ToCamelCase(Culture), + NameStyle.PascalCase => name.ToPascalCase(Culture), + NameStyle.LowerCase => name.ToLower(Culture), + _ => input + }; + } +} + +/// +/// Options for transforming casing of element names +/// +public enum NameStyle { AsIs, CamelCase, LowerCase, PascalCase } \ No newline at end of file diff --git a/src/RestSharp.Serializers.Xml/XmlAttributeDeserializer.cs b/src/RestSharp.Serializers.Xml/XmlAttributeDeserializer.cs new file mode 100644 index 000000000..b2677f014 --- /dev/null +++ b/src/RestSharp.Serializers.Xml/XmlAttributeDeserializer.cs @@ -0,0 +1,39 @@ +// Copyright (c) .NET Foundation and Contributors +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// http://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. + +using System.Reflection; +using System.Xml.Linq; +using RestSharp.Extensions; + +namespace RestSharp.Serializers.Xml; + +public class XmlAttributeDeserializer : XmlDeserializer { + protected override object? GetValueFromXml(XElement? root, XName? name, PropertyInfo prop, bool useExactName) { + var isAttribute = false; + + //Check for the DeserializeAs attribute on the property + var options = prop.GetAttribute(); + + if (options != null) { + name = options.Name ?? name; + isAttribute = options.Attribute; + } + + if (!isAttribute) return base.GetValueFromXml(root, name, prop, useExactName); + + var attributeVal = GetAttributeByName(root!, name!, useExactName); + + return attributeVal?.Value ?? base.GetValueFromXml(root, name, prop, useExactName); + } +} \ No newline at end of file diff --git a/src/RestSharp.Serializers.Xml/XmlDeserializer.cs b/src/RestSharp.Serializers.Xml/XmlDeserializer.cs new file mode 100644 index 000000000..4b5a43d35 --- /dev/null +++ b/src/RestSharp.Serializers.Xml/XmlDeserializer.cs @@ -0,0 +1,531 @@ +// Copyright (c) .NET Foundation and Contributors +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// http://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. + +using System.Collections; +using System.ComponentModel; +using System.Globalization; +using System.Reflection; +using System.Xml; +using System.Xml.Linq; +using RestSharp.Extensions; +// ReSharper disable VirtualMemberNeverOverridden.Global + +namespace RestSharp.Serializers.Xml; + +public class XmlDeserializer : IXmlDeserializer, IWithRootElement, IWithDateFormat { + public CultureInfo Culture { get; set; } = CultureInfo.InvariantCulture; + + public string? RootElement { get; set; } + + public string? Namespace { get; set; } + + public string? DateFormat { get; set; } + + public virtual T? Deserialize(RestResponse response) { + if (string.IsNullOrEmpty(response.Content)) + return default; + + var doc = XDocument.Parse(response.Content!); + var root = doc.Root; + var rootElement = response.RootElement ?? RootElement; + + if (rootElement != null && doc.Root != null) { + var namespacedRoot = rootElement.AsNamespaced(Namespace); + // Prefer the shallowest match to avoid nested elements with the same name + root = namespacedRoot != null + ? doc.Root.Element(namespacedRoot) + ?? doc.Root.DescendantsAndSelf(namespacedRoot) + .OrderBy(e => e.Ancestors().Count()) + .FirstOrDefault() + : null; + } + + // autodetect xml namespace + if (Namespace.IsEmpty()) + RemoveNamespace(doc); + + var x = Activator.CreateInstance(); + var objType = x!.GetType(); + + if (objType.IsSubclassOfRawGeneric(typeof(List<>))) + x = (T)HandleListDerivative(root!, objType.Name, objType); + else + x = (T)Map(x, root!); + + return x; + } + + static void RemoveNamespace(XDocument xdoc) { + if (xdoc.Root == null) return; + + foreach (var e in xdoc.Root.DescendantsAndSelf()) { + if (e.Name.Namespace != XNamespace.None) + e.Name = XNamespace.None.GetName(e.Name.LocalName); + + if (!e.Attributes().Any(a => a.IsNamespaceDeclaration || a.Name.Namespace != XNamespace.None)) continue; + + e.ReplaceAttributes( + e.Attributes() + .Select( + a => a.IsNamespaceDeclaration + ? null + : a.Name.Namespace != XNamespace.None + ? new(XNamespace.None.GetName(a.Name.LocalName), a.Value) + : a + ) + .Where(a => a != null) + ); + } + } + + static bool IsValidXmlElementName(string name) => + // Generic type names contain backtick (e.g., "List`1") which is invalid in XML element names + !name.Contains('`'); + + protected virtual object Map(object x, XElement? root) { + var objType = x.GetType(); + var props = objType.GetProperties(); + + var deserializeFromContentAttributeAlreadyUsed = false; + + foreach (var prop in props) { + var type = prop.PropertyType.GetTypeInfo(); + var typeIsPublic = type.IsPublic || type.IsNestedPublic; + + if (!typeIsPublic || !prop.CanWrite) + continue; + + var deserializeFromContent = false; + var isNameDefinedInAttribute = false; + XName? name = null; + var attributes = prop.GetCustomAttributes(typeof(DeserializeAsAttribute), false); + + if (attributes.Any()) { + var attribute = (DeserializeAsAttribute)attributes.First(); + + name = attribute.Name.AsNamespaced(Namespace); + isNameDefinedInAttribute = !string.IsNullOrEmpty(name?.LocalName); + + deserializeFromContent = attribute.Content; + + if (deserializeFromContentAttributeAlreadyUsed && deserializeFromContent) + throw new ArgumentException("Class cannot have two properties marked with SerializeAs(Content = true) attribute."); + + deserializeFromContentAttributeAlreadyUsed |= deserializeFromContent; + } + + if (name == null) name = prop.Name.AsNamespaced(Namespace); + + var value = GetValueFromXml(root, name, prop, isNameDefinedInAttribute); + + if (value == null) { + // special case for text content node + if (deserializeFromContent) { + var textNode = root!.Nodes().FirstOrDefault(n => n is XText); + + if (textNode != null) { + value = ((XText)textNode).Value; + prop.SetValue(x, value, null); + } + + continue; + } + + // special case for inline list items + if (type.IsGenericType) { + var genericType = type.GetGenericArguments()[0]; + var first = GetElementByName(root, genericType.Name); + var list = (IList)Activator.CreateInstance(type.AsType())!; + + if (first != null && root != null) { + var elements = root.Elements(first.Name); + + PopulateListFromElements(genericType, elements, list); + } + + prop.SetValue(x, list, null); + } + + continue; + } + + if (type.IsGenericType && type.GetGenericTypeDefinition() == typeof(Nullable<>)) { + // if the value is empty, set the property to null... + if (string.IsNullOrEmpty(value.ToString())) { + prop.SetValue(x, null, null); + continue; + } + + type = type.GetGenericArguments()[0].GetTypeInfo(); + } + + var asType = type.AsType(); + + if (asType == typeof(bool)) { + var toConvert = value.ToString()!.ToLower(Culture); + + prop.SetValue(x, XmlConvert.ToBoolean(toConvert), null); + } + else if (type.IsPrimitive) { + try { + prop.SetValue(x, value.ChangeType(asType), null); + } + catch (FormatException ex) { + throw new FormatException( + $"Couldn't parse the value of '{value}' into the '{prop.Name}'" + + $" property, because it isn't a type of '{prop.PropertyType}'.", + ex.InnerException + ); + } + } + else if (type.IsEnum) { + var converted = type.AsType().FindEnumValue(value.ToString(), Culture); + + prop.SetValue(x, converted, null); + } + else if (asType == typeof(Uri)) { + var uri = new Uri(value.ToString(), UriKind.RelativeOrAbsolute); + + prop.SetValue(x, uri, null); + } + else if (asType == typeof(string)) { + prop.SetValue(x, value, null); + } + else if (asType == typeof(DateTime)) { + value = DateFormat.IsNotEmpty() + ? DateTime.ParseExact(value.ToString(), DateFormat!, Culture) + : DateTime.Parse(value.ToString(), Culture); + + prop.SetValue(x, value, null); + } + else if (asType == typeof(DateTimeOffset)) { + var toConvert = value.ToString(); + + if (string.IsNullOrEmpty(toConvert)) continue; + + DateTimeOffset deserialisedValue; + + try { + deserialisedValue = XmlConvert.ToDateTimeOffset(toConvert); + prop.SetValue(x, deserialisedValue, null); + } + catch (Exception) { + if (TryGetFromString(toConvert, out var result, asType)) { + prop.SetValue(x, result, null); + } + else { + //fallback to parse + deserialisedValue = DateTimeOffset.Parse(toConvert); + prop.SetValue(x, deserialisedValue, null); + } + } + } + else if (asType == typeof(decimal)) { + value = decimal.Parse(value.ToString(), Culture); + prop.SetValue(x, value, null); + } + else if (asType == typeof(Guid)) { + var raw = value.ToString(); + + value = string.IsNullOrEmpty(raw) ? Guid.Empty : new(value.ToString()); + + prop.SetValue(x, value, null); + } + else if (asType == typeof(TimeSpan)) { + var timeSpan = XmlConvert.ToTimeSpan(value.ToString()); + + prop.SetValue(x, timeSpan, null); + } + else if (type.IsGenericType) { + var list = (IList)Activator.CreateInstance(asType)!; + XElement? container = null; + + // First check if root itself is the container (matches property name) + if (root != null && name?.LocalName != null) { + var rootName = root.Name.LocalName; + if (rootName.Equals(name.LocalName, StringComparison.OrdinalIgnoreCase)) { + container = root; + } + } + + // If root is not the container, try to find it as a child element + container ??= GetElementByName(root, name); + + if (container?.HasElements == true) { + var first = container.Elements().FirstOrDefault(); + + if (first != null) { + var t = type.GetGenericArguments()[0]; + var elements = container.Elements(first.Name); + + PopulateListFromElements(t, elements, list); + } + } + + prop.SetValue(x, list, null); + } + else if (asType.IsSubclassOfRawGeneric(typeof(List<>))) { + // handles classes that derive from List + // e.g. a collection that also has attributes + var list = HandleListDerivative(root!, prop.Name, asType); + + prop.SetValue(x, list, null); + } + else { + //fallback to type converters if possible + + if (TryGetFromString(value.ToString(), out var result, asType)) { + prop.SetValue(x, result, null); + } + else { + // nested property classes + if (root == null) continue; + + var element = GetElementByName(root, name); + + if (element == null) continue; + + var item = CreateAndMap(asType, element); + + prop.SetValue(x, item, null); + } + } + } + + return x; + } + + static bool TryGetFromString(string inputString, out object? result, Type type) { + var converter = TypeDescriptor.GetConverter(type); + + if (converter.CanConvertFrom(typeof(string))) { + result = converter.ConvertFromInvariantString(inputString); + return true; + } + + result = null; + return false; + } + + void PopulateListFromElements(Type t, IEnumerable elements, IList list) { + foreach (var item in elements.Select(element => CreateAndMap(t, element))) + list.Add(item); + } + + object HandleListDerivative(XElement root, string propName, Type type) { + var t = type.IsGenericType + ? type.GetGenericArguments()[0] + : type.BaseType!.GetGenericArguments()[0]; + + var list = (IList)Activator.CreateInstance(type)!; + + var name = t.Name; + var attribute = t.GetAttribute(); + + if (attribute != null) + name = attribute.Name; + + // Try to find a container element first using the property name + XElement? container = null; + + // Try the property name first (skip if it contains invalid XML name characters like ` in generic types) + if (IsValidXmlElementName(propName)) { + container = GetElementByName(root, propName.AsNamespaced(Namespace)); + } + + // Check if root itself matches the container naming + if (container == null && IsValidXmlElementName(propName)) { + var rootName = root.Name.LocalName; + + if (rootName.Equals(propName, StringComparison.OrdinalIgnoreCase)) { + container = root; + } + } + + IList elements; + + // If we found a specific container, use Elements() to get only direct children + // This prevents nested lists from being incorrectly flattened + if (container is { HasElements: true }) { + elements = TryFindElementsByNameVariations(container, t.Name, name, useDirectChildrenOnly: true); + } + else { + // No container found - use Descendants() for backward compatibility + // This handles cases where items are nested at varying depths without a clear container + elements = TryFindElementsByNameVariations(root, t.Name, name, useDirectChildrenOnly: false); + } + + PopulateListFromElements(t, elements, list); + + // get properties too, not just list items + // only if this isn't a generic type + if (!type.IsGenericType) + Map(list, root.Element(propName.AsNamespaced(Namespace)!) ?? root); + + return list; + } + + IList TryFindElementsByNameVariations(XElement source, string typeName, string? itemName, bool useDirectChildrenOnly) { + IList elements; + + if (useDirectChildrenOnly) { + // Use Elements() for direct children only + elements = source.Elements(typeName.AsNamespaced(Namespace)).ToList(); + + if (!elements.Any()) { + var lowerName = itemName?.ToLower(Culture).AsNamespaced(Namespace); + elements = source.Elements(lowerName).ToList(); + } + + if (!elements.Any()) { + var camelName = itemName?.ToCamelCase(Culture).AsNamespaced(Namespace); + elements = source.Elements(camelName).ToList(); + } + + if (!elements.Any()) { + elements = source.Elements() + .Where(e => e.Name.LocalName.RemoveUnderscoresAndDashes() == itemName) + .ToList(); + } + + if (!elements.Any()) { + var lowerName = itemName?.ToLower(Culture); + elements = source.Elements() + .Where(e => e.Name.LocalName.RemoveUnderscoresAndDashes() == lowerName) + .ToList(); + } + } + else { + // Use Descendants() for backward compatibility when no container is found + elements = source.Descendants(typeName.AsNamespaced(Namespace)).ToList(); + + if (!elements.Any()) { + var lowerName = itemName?.ToLower(Culture).AsNamespaced(Namespace); + elements = source.Descendants(lowerName).ToList(); + } + + if (!elements.Any()) { + var camelName = itemName?.ToCamelCase(Culture).AsNamespaced(Namespace); + elements = source.Descendants(camelName).ToList(); + } + + if (!elements.Any()) { + elements = source.Descendants() + .Where(e => e.Name.LocalName.RemoveUnderscoresAndDashes() == itemName) + .ToList(); + } + + if (!elements.Any()) { + var lowerName = itemName?.ToLower(Culture); + elements = source.Descendants() + .Where(e => e.Name.LocalName.RemoveUnderscoresAndDashes() == lowerName) + .ToList(); + } + } + + return elements; + } + + protected virtual object? CreateAndMap(Type t, XElement element) { + object? item; + + if (t == typeof(string)) { + item = element.Value; + } + else if (t.GetTypeInfo().IsPrimitive) { + item = element.Value.ChangeType(t); + } + else { + item = Activator.CreateInstance(t)!; + Map(item, element); + } + + return item; + } + + protected virtual object? GetValueFromXml(XElement? root, XName? name, PropertyInfo prop, bool useExactName) { + object? val = null; + if (root == null) return val; + + var element = GetElementByName(root, name); + + if (element == null) { + var attribute = GetAttributeByName(root, name!, useExactName); + + if (attribute != null) + val = attribute.Value; + } + else { + if (!element.IsEmpty || element.HasElements || element.HasAttributes) + val = element.Value; + } + + return val; + } + + protected virtual XElement? GetElementByName(XElement? root, XName? name) { + var lowerName = name?.LocalName.ToLower(Culture).AsNamespaced(name.NamespaceName); + var camelName = name?.LocalName.ToCamelCase(Culture).AsNamespaced(name.NamespaceName); + + if (root?.Element(name!) != null) + return root.Element(name!); + + if (root?.Element(lowerName!) != null) + return root.Element(lowerName!); + + if (root?.Element(camelName!) != null) + return root.Element(camelName!); + + // try looking for element that matches sanitized property name (Order by depth) + var orderedDescendants = root!.Descendants() + .OrderBy(d => d.Ancestors().Count()) + .ToList(); + + var element = orderedDescendants + .FirstOrDefault(d => d.Name.LocalName.RemoveUnderscoresAndDashes() == name?.LocalName) ?? + orderedDescendants + .FirstOrDefault( + d => string.Equals( + d.Name.LocalName.RemoveUnderscoresAndDashes(), + name?.LocalName, + StringComparison.OrdinalIgnoreCase + ) + ); + + return element == null && + name == "Value".AsNamespaced(name?.NamespaceName) && + (!root.HasAttributes || root.Attributes().All(x => x.Name != name)) + ? root + : element; + } + + protected virtual XAttribute? GetAttributeByName(XElement root, XName name, bool useExactName) { + var names = useExactName + ? null + : new List { + name.LocalName, + name.LocalName.ToLower(Culture).AsNamespaced(name.NamespaceName)!, + name.LocalName.ToCamelCase(Culture).AsNamespaced(name.NamespaceName)! + }; + + return root.DescendantsAndSelf() + .OrderBy(d => d.Ancestors().Count()) + .Attributes() + .FirstOrDefault( + d => useExactName + ? d.Name == name + : names?.Contains(d.Name.LocalName.RemoveUnderscoresAndDashes()) == true + ); + } +} \ No newline at end of file diff --git a/src/RestSharp.Serializers.Xml/XmlExtensions.cs b/src/RestSharp.Serializers.Xml/XmlExtensions.cs new file mode 100644 index 000000000..b988f7abb --- /dev/null +++ b/src/RestSharp.Serializers.Xml/XmlExtensions.cs @@ -0,0 +1,37 @@ +// Copyright (c) .NET Foundation and Contributors +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// http://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. + +using System.Xml.Linq; +using RestSharp.Extensions; + +namespace RestSharp.Serializers.Xml; + +/// +/// XML Extension Methods +/// +public static class XmlExtensions { + /// + /// Returns the name of an element with the namespace if specified + /// + /// Element name + /// XML Namespace + /// + public static XName? AsNamespaced(this string? name, string? @namespace) { + XName? xName = name; + + if (name != null && @namespace.IsNotEmpty()) xName = XName.Get(name, @namespace); + + return xName; + } +} \ No newline at end of file diff --git a/src/RestSharp.Serializers.Xml/XmlSerializer.cs b/src/RestSharp.Serializers.Xml/XmlSerializer.cs new file mode 100644 index 000000000..170954c28 --- /dev/null +++ b/src/RestSharp.Serializers.Xml/XmlSerializer.cs @@ -0,0 +1,245 @@ +// Copyright (c) .NET Foundation and Contributors +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// http://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. + +using System.Collections; +using System.Globalization; +using System.Reflection; +using System.Xml.Linq; +using RestSharp.Extensions; + +namespace RestSharp.Serializers.Xml; + +/// +/// Default XML Serializer +/// +public class XmlSerializer : IXmlSerializer, IWithRootElement, IWithDateFormat { + /// + /// Default constructor, does not specify namespace + /// + public XmlSerializer() { } + + /// + /// Specify the namespaced to be used when serializing + /// + /// XML namespace + [PublicAPI] + public XmlSerializer(string @namespace) => Namespace = @namespace; + + /// + /// Serialize the object as XML + /// + /// Object to serialize + /// XML as string + public string Serialize(object obj) { + var doc = new XDocument(); + var t = obj.GetType(); + var name = t.Name; + var options = t.GetAttribute(); + + if (options != null) + name = options.TransformName(options.Name ?? name); + + var root = new XElement(name.AsNamespaced(Namespace)!); + + if (obj is IList list) { + var itemTypeName = ""; + + foreach (var item in list) { + var type = item.GetType(); + var opts = type.GetAttribute(); + + if (opts != null) + itemTypeName = opts.TransformName(opts.Name ?? name); + + if (itemTypeName == "") + itemTypeName = type.Name; + + var instance = new XElement(itemTypeName.AsNamespaced(Namespace)!); + + Map(instance, item); + root.Add(instance); + } + } + else { + Map(root, obj); + } + + if (RootElement != null) { + var wrapper = new XElement(RootElement.AsNamespaced(Namespace)!, root); + doc.Add(wrapper); + } + else { + doc.Add(root); + } + + return doc.ToString(); + } + + /// + /// Name of the root element to use when serializing + /// + public string? RootElement { get; set; } + + /// + /// XML namespace to use when serializing + /// + public string? Namespace { get; set; } + + /// + /// Format string to use when serializing dates + /// + public string? DateFormat { get; set; } + + /// + /// Content type for serialized content + /// + public ContentType ContentType { get; set; } = ContentType.Xml; + + void Map(XContainer root, object obj) { + var objType = obj.GetType(); + + var props = objType.GetProperties() + .Select(p => new { p, indexAttribute = p.GetAttribute() }) + .Where(t => t.p is { CanRead: true, CanWrite: true }) + .OrderBy(t => t.indexAttribute?.Index ?? int.MaxValue) + .Select(t => t.p); + var globalOptions = objType.GetAttribute(); + var textContentAttributeAlreadyUsed = false; + + foreach (var prop in props) { + var name = prop.Name; + var rawValue = prop.GetValue(obj, null); + + if (rawValue == null) + continue; + + var propType = prop.PropertyType; + var useAttribute = false; + var setTextContent = false; + var options = prop.GetAttribute(); + + if (options != null) { + name = options.Name.IsNotEmpty() + ? options.Name + : name; + + name = options.TransformName(name!); + + useAttribute = options.Attribute; + + setTextContent = options.Content; + + if (textContentAttributeAlreadyUsed && setTextContent) + throw new ArgumentException("Class cannot have two properties marked with SerializeAs(Content = true) attribute."); + + textContentAttributeAlreadyUsed |= setTextContent; + } + else if (globalOptions != null) { + name = globalOptions.TransformName(name); + } + + var nsName = name.AsNamespaced(Namespace); + var element = new XElement(nsName!); + + if (propType.GetTypeInfo().IsPrimitive || + propType.GetTypeInfo().IsValueType || + propType == typeof(string)) { + var value = GetSerializedValue(rawValue); + + if (useAttribute) { + root.Add(new XAttribute(name, value)); + continue; + } + + if (setTextContent) { + root.Add(new XText(value)); + continue; + } + + element.Value = value; + } + else if (rawValue is IList items) { + foreach (var item in items) { + var type = item.GetType(); + var setting = type.GetAttribute(); + + var itemTypeName = setting != null && setting.Name.IsNotEmpty() + ? setting.Name + : type.Name; + + var instance = new XElement(itemTypeName.AsNamespaced(Namespace)!); + + Map(instance, item); + + if (setTextContent) { + root.Add(instance); + } + else { + element.Add(instance); + } + } + + if (setTextContent) { + continue; + } + } + else { + Map(element, rawValue); + } + + root.Add(element); + } + } + + string GetSerializedValue(object obj) { + var output = obj switch { + DateTime time when DateFormat.IsNotEmpty() => time.ToString(DateFormat, CultureInfo.InvariantCulture), + bool b => b.ToString().ToLowerInvariant(), + _ => obj + }; + + return IsNumeric(obj) ? SerializeNumber(obj) : output.ToString()!; + } + + static string SerializeNumber(object number) + => number switch { + long l => l.ToString(CultureInfo.InvariantCulture), + ulong @ulong => @ulong.ToString(CultureInfo.InvariantCulture), + int i => i.ToString(CultureInfo.InvariantCulture), + uint u => u.ToString(CultureInfo.InvariantCulture), + decimal @decimal => @decimal.ToString(CultureInfo.InvariantCulture), + float f => f.ToString(CultureInfo.InvariantCulture), + _ => Convert.ToDouble(number, CultureInfo.InvariantCulture).ToString("r", CultureInfo.InvariantCulture) + }; + + /// + /// Determines if a given object is numeric in any way + /// (can be integer, double, null, etc). + /// + static bool IsNumeric(object value) + => value switch { + sbyte => true, + byte => true, + short => true, + ushort => true, + int => true, + uint => true, + long => true, + ulong => true, + float => true, + double => true, + decimal => true, + _ => false + }; +} \ No newline at end of file diff --git a/src/RestSharp.Serializers.Xml/XmlSerializerClientExtensions.cs b/src/RestSharp.Serializers.Xml/XmlSerializerClientExtensions.cs new file mode 100644 index 000000000..72a651a0f --- /dev/null +++ b/src/RestSharp.Serializers.Xml/XmlSerializerClientExtensions.cs @@ -0,0 +1,38 @@ +// Copyright (c) .NET Foundation and Contributors +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// http://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. + +namespace RestSharp.Serializers.Xml; + +[PublicAPI] +public static class XmlSerializerClientExtensions { + public static SerializerConfig UseXmlSerializer( + this SerializerConfig config, + string? xmlNamespace = null, + string? rootElement = null, + bool useAttributeDeserializer = false + ) { + var xmlSerializer = new XmlSerializer { + Namespace = xmlNamespace, + RootElement = rootElement + }; + + var xmlDeserializer = useAttributeDeserializer ? new XmlAttributeDeserializer() : new XmlDeserializer(); + + var serializer = new XmlRestSerializer() + .WithXmlSerializer(xmlSerializer) + .WithXmlDeserializer(xmlDeserializer); + + return config.UseSerializer(() => serializer); + } +} diff --git a/src/RestSharp/AsyncHelpers.cs b/src/RestSharp/AsyncHelpers.cs new file mode 100644 index 000000000..5d3db9db4 --- /dev/null +++ b/src/RestSharp/AsyncHelpers.cs @@ -0,0 +1,127 @@ +// Copyright (c) .NET Foundation and Contributors +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// http://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. +// +// Adapted from Rebus + +using System.Collections.Concurrent; +using System.Runtime.ExceptionServices; + +namespace RestSharp; + +static class AsyncHelpers { + /// + /// Executes a task synchronously on the calling thread by installing a temporary synchronization context that queues continuations + /// + /// Callback for asynchronous task to run + static void RunSync(Func task) { + var currentContext = SynchronizationContext.Current; + var customContext = new CustomSynchronizationContext(task); + + try { + SynchronizationContext.SetSynchronizationContext(customContext); + customContext.Run(); + } + finally { + SynchronizationContext.SetSynchronizationContext(currentContext); + } + } + + /// + /// Executes a task synchronously on the calling thread by installing a temporary synchronization context that queues continuations + /// + /// Callback for asynchronous task to run + /// Return type for the task + /// Return value from the task + public static T RunSync(Func> task) { + T result = default!; + RunSync(async () => { result = await task(); }); + return result; + } + + /// + /// Synchronization context that can be "pumped" in order to have it execute continuations posted back to it + /// + class CustomSynchronizationContext : SynchronizationContext { + readonly ConcurrentQueue> _items = new(); + readonly AutoResetEvent _workItemsWaiting = new(false); + readonly Func _task; + ExceptionDispatchInfo? _caughtException; + bool _done; + + /// + /// Constructor for the custom context + /// + /// Task to execute + public CustomSynchronizationContext(Func task) => + _task = task ?? throw new ArgumentNullException(nameof(task), "Please remember to pass a Task to be executed"); + + /// + /// When overridden in a derived class, dispatches an asynchronous message to a synchronization context. + /// + /// Callback function + /// Callback state + public override void Post(SendOrPostCallback function, object? state) { + _items.Enqueue(Tuple.Create(function, state)); + _workItemsWaiting.Set(); + } + + /// + /// Enqueues the function to be executed and executes all resulting continuations until it is completely done + /// + public void Run() { + Post(PostCallback, null); + + while (!_done) { + if (_items.TryDequeue(out var task)) { + task.Item1(task.Item2); + if (_caughtException == null) { + continue; + } + _caughtException.Throw(); + } + else { + _workItemsWaiting.WaitOne(); + } + } + + return; + + async void PostCallback(object? _) { + try { + await _task().ConfigureAwait(false); + } + catch (Exception exception) { + _caughtException = ExceptionDispatchInfo.Capture(exception); + throw; + } + finally { + Post(_ => _done = true, null); + } + } + } + + /// + /// When overridden in a derived class, dispatches a synchronous message to a synchronization context. + /// + /// Callback function + /// Callback state + public override void Send(SendOrPostCallback function, object? state) => throw new NotSupportedException("Cannot send to same thread"); + + /// + /// When overridden in a derived class, creates a copy of the synchronization context. Not needed, so just return ourselves. + /// + /// Copy of the context + public override SynchronizationContext CreateCopy() => this; + } +} \ No newline at end of file diff --git a/src/RestSharp/Authenticators/AuthenticatorBase.cs b/src/RestSharp/Authenticators/AuthenticatorBase.cs new file mode 100644 index 000000000..dc765e8c7 --- /dev/null +++ b/src/RestSharp/Authenticators/AuthenticatorBase.cs @@ -0,0 +1,24 @@ +// Copyright (c) .NET Foundation and Contributors +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// http://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. + +namespace RestSharp.Authenticators; + +public abstract class AuthenticatorBase(string token) : IAuthenticator { + protected string Token { get; set; } = token; + + protected abstract ValueTask GetAuthenticationParameter(string accessToken); + + public async ValueTask Authenticate(IRestClient client, RestRequest request) + => request.AddOrUpdateParameter(await GetAuthenticationParameter(Token).ConfigureAwait(false)); +} \ No newline at end of file diff --git a/src/RestSharp/Authenticators/HttpBasicAuthenticator.cs b/src/RestSharp/Authenticators/HttpBasicAuthenticator.cs new file mode 100644 index 000000000..07d775664 --- /dev/null +++ b/src/RestSharp/Authenticators/HttpBasicAuthenticator.cs @@ -0,0 +1,37 @@ +// Copyright (c) .NET Foundation and Contributors +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// http://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. + +using System.Text; + +namespace RestSharp.Authenticators; + +/// +/// Allows "basic access authentication" for HTTP requests. +/// +/// +/// Encoding can be specified depending on what your server expect (see https://stackoverflow.com/a/7243567). +/// UTF-8 is used by default but some servers might expect ISO-8859-1 encoding. +/// +[PublicAPI] +public class HttpBasicAuthenticator(string username, string password, Encoding encoding) + : AuthenticatorBase(GetHeader(username, password, encoding)) { + public HttpBasicAuthenticator(string username, string password) : this(username, password, Encoding.UTF8) { } + + static string GetHeader(string username, string password, Encoding encoding) + => Convert.ToBase64String(encoding.GetBytes($"{username}:{password}")); + + // return ; + protected override ValueTask GetAuthenticationParameter(string accessToken) + => new(new HeaderParameter(KnownHeaders.Authorization, $"Basic {accessToken}")); +} \ No newline at end of file diff --git a/RestSharp/Authenticators/IAuthenticator.cs b/src/RestSharp/Authenticators/IAuthenticator.cs similarity index 73% rename from RestSharp/Authenticators/IAuthenticator.cs rename to src/RestSharp/Authenticators/IAuthenticator.cs index bad21cefd..b7cbe9606 100644 --- a/RestSharp/Authenticators/IAuthenticator.cs +++ b/src/RestSharp/Authenticators/IAuthenticator.cs @@ -1,6 +1,4 @@ -#region License - -// Copyright 2010 John Sheehan +// Copyright (c) .NET Foundation and Contributors // // Licensed under the Apache License, Version 2.0 (the "License"); // you may not use this file except in compliance with the License. @@ -14,12 +12,8 @@ // See the License for the specific language governing permissions and // limitations under the License. -#endregion +namespace RestSharp.Authenticators; -namespace RestSharp.Authenticators -{ - public interface IAuthenticator - { - void Authenticate(IRestClient client, IRestRequest request); - } -} +public interface IAuthenticator { + ValueTask Authenticate(IRestClient client, RestRequest request); +} \ No newline at end of file diff --git a/src/RestSharp/Authenticators/JwtAuthenticator.cs b/src/RestSharp/Authenticators/JwtAuthenticator.cs new file mode 100644 index 000000000..cadbd2a64 --- /dev/null +++ b/src/RestSharp/Authenticators/JwtAuthenticator.cs @@ -0,0 +1,34 @@ +// Copyright (c) .NET Foundation and Contributors +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// http://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. + +namespace RestSharp.Authenticators; + +/// +/// JSON WEB TOKEN (JWT) Authenticator class. +/// https://tools.ietf.org/html/draft-ietf-oauth-json-web-token +/// +public class JwtAuthenticator(string accessToken) : AuthenticatorBase(GetToken(accessToken)) { + /// + /// Set the new bearer token so the request gets the new header value + /// + /// + [PublicAPI] + public void SetBearerToken(string accessToken) => Token = GetToken(accessToken); + + static string GetToken(string accessToken) + => Ensure.NotEmptyString(accessToken, nameof(accessToken)).StartsWith("Bearer ") ? accessToken : $"Bearer {accessToken}"; + + protected override ValueTask GetAuthenticationParameter(string accessToken) + => new(new HeaderParameter(KnownHeaders.Authorization, accessToken)); +} \ No newline at end of file diff --git a/src/RestSharp/Authenticators/OAuth/Enums.cs b/src/RestSharp/Authenticators/OAuth/Enums.cs new file mode 100644 index 000000000..918aad64e --- /dev/null +++ b/src/RestSharp/Authenticators/OAuth/Enums.cs @@ -0,0 +1,23 @@ +// Copyright (c) .NET Foundation and Contributors +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// http://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. + +namespace RestSharp.Authenticators.OAuth; + +public enum OAuthSignatureMethod { HmacSha1, HmacSha256, PlainText, RsaSha1 } + +public enum OAuthSignatureTreatment { Escaped, Unescaped } + +public enum OAuthParameterHandling { HttpAuthorizationHeader, UrlOrPostParameters } + +public enum OAuthType { RequestToken, AccessToken, ProtectedResource, ClientAuthentication } \ No newline at end of file diff --git a/src/RestSharp/Authenticators/OAuth/Extensions/OAuthExtensions.cs b/src/RestSharp/Authenticators/OAuth/Extensions/OAuthExtensions.cs new file mode 100644 index 000000000..cca257f71 --- /dev/null +++ b/src/RestSharp/Authenticators/OAuth/Extensions/OAuthExtensions.cs @@ -0,0 +1,34 @@ +// Copyright (c) .NET Foundation and Contributors +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// http://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. + +using System.Security.Cryptography; +using System.Text; + +namespace RestSharp.Authenticators.OAuth.Extensions; + +static class OAuthExtensions { + public static string ToRequestValue(this OAuthSignatureMethod signatureMethod) { + var value = signatureMethod.ToString().ToUpperInvariant(); + var shaIndex = value.IndexOf("SHA", StringComparison.Ordinal); + + return shaIndex > -1 ? value.Insert(shaIndex, "-") : value; + } + + public static string HashWith(this string input, HashAlgorithm algorithm) { + var data = Encoding.UTF8.GetBytes(input); + var hash = algorithm.ComputeHash(data); + + return Convert.ToBase64String(hash); + } +} \ No newline at end of file diff --git a/src/RestSharp/Authenticators/OAuth/Extensions/StringExtensions.cs b/src/RestSharp/Authenticators/OAuth/Extensions/StringExtensions.cs new file mode 100644 index 000000000..3b6d557b0 --- /dev/null +++ b/src/RestSharp/Authenticators/OAuth/Extensions/StringExtensions.cs @@ -0,0 +1,31 @@ +// Copyright (c) .NET Foundation and Contributors +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// http://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. + +using System.Text; + +namespace RestSharp.Authenticators.OAuth.Extensions; + +static class StringExtensions { + extension(string left) { + public bool EqualsIgnoreCase(string right) => string.Equals(left, right, StringComparison.InvariantCultureIgnoreCase); + + public string Then(string value) => string.Concat(left, value); + + public Uri AsUri() => new(left); + + public byte[] GetBytes() => Encoding.UTF8.GetBytes(left); + + public string PercentEncode() => string.Join("", left.GetBytes().Select(x => $"%{x:X2}")); + } +} \ No newline at end of file diff --git a/src/RestSharp/Authenticators/OAuth/Extensions/TimeExtensions.cs b/src/RestSharp/Authenticators/OAuth/Extensions/TimeExtensions.cs new file mode 100644 index 000000000..8c40f5245 --- /dev/null +++ b/src/RestSharp/Authenticators/OAuth/Extensions/TimeExtensions.cs @@ -0,0 +1,22 @@ +// Copyright (c) .NET Foundation and Contributors +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// http://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. + +namespace RestSharp.Authenticators.OAuth.Extensions; + +static class TimeExtensions { + public static long ToUnixTime(this DateTime dateTime) { + var timeSpan = dateTime - new DateTime(1970, 1, 1); + return (long)timeSpan.TotalSeconds; + } +} \ No newline at end of file diff --git a/src/RestSharp/Authenticators/OAuth/OAuth1Authenticator.cs b/src/RestSharp/Authenticators/OAuth/OAuth1Authenticator.cs new file mode 100644 index 000000000..56906120f --- /dev/null +++ b/src/RestSharp/Authenticators/OAuth/OAuth1Authenticator.cs @@ -0,0 +1,313 @@ +// Copyright (c) .NET Foundation and Contributors +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// http://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. + +using RestSharp.Authenticators.OAuth; +using RestSharp.Extensions; +using System.Web; +// ReSharper disable PropertyCanBeMadeInitOnly.Global + +// ReSharper disable NotResolvedInText +// ReSharper disable CheckNamespace + +namespace RestSharp.Authenticators; + +/// RFC: The OAuth 1.0 Protocol +// ReSharper disable once ClassWithVirtualMembersNeverInherited.Global +public class OAuth1Authenticator : IAuthenticator { + public virtual string? Realm { get; set; } + public virtual OAuthParameterHandling ParameterHandling { get; set; } + public virtual OAuthSignatureMethod SignatureMethod { get; set; } + public virtual OAuthSignatureTreatment SignatureTreatment { get; set; } + public virtual OAuthType Type { get; set; } + public virtual string? ConsumerKey { get; set; } + public virtual string? ConsumerSecret { get; set; } + public virtual string? Token { get; set; } + public virtual string? TokenSecret { get; set; } + public virtual string? Verifier { get; set; } + public virtual string? Version { get; set; } + public virtual string? CallbackUrl { get; set; } + public virtual string? SessionHandle { get; set; } + public virtual string? ClientUsername { get; set; } + public virtual string? ClientPassword { get; set; } + + public ValueTask Authenticate(IRestClient client, RestRequest request) { + var workflow = new OAuthWorkflow { + ConsumerKey = ConsumerKey, + ConsumerSecret = ConsumerSecret, + ParameterHandling = ParameterHandling, + SignatureMethod = SignatureMethod, + SignatureTreatment = SignatureTreatment, + Verifier = Verifier, + Version = Version, + CallbackUrl = CallbackUrl, + SessionHandle = SessionHandle, + Token = Token, + TokenSecret = TokenSecret, + ClientUsername = ClientUsername, + ClientPassword = ClientPassword + }; + + AddOAuthData(client, request, workflow, Type, Realm); + return default; + } + + /// + /// Creates an authenticator to retrieve a request token. + /// + /// Consumer or API key + /// Consumer or API secret + /// Signature method, default is HMAC SHA1 + /// Authenticator instance + [PublicAPI] + public static OAuth1Authenticator ForRequestToken( + string consumerKey, + string? consumerSecret, + OAuthSignatureMethod signatureMethod = OAuthSignatureMethod.HmacSha1 + ) + => new() { + ParameterHandling = OAuthParameterHandling.HttpAuthorizationHeader, + SignatureMethod = signatureMethod, + SignatureTreatment = OAuthSignatureTreatment.Escaped, + ConsumerKey = consumerKey, + ConsumerSecret = consumerSecret, + Type = OAuthType.RequestToken + }; + + /// + /// Creates an authenticator to retrieve a request token with custom callback. + /// + /// Consumer or API key + /// Consumer or API secret + /// URL to where the user will be redirected to after authhentication + /// Authenticator instance + [PublicAPI] + public static OAuth1Authenticator ForRequestToken(string consumerKey, string? consumerSecret, string callbackUrl) { + var authenticator = ForRequestToken(consumerKey, consumerSecret); + + authenticator.CallbackUrl = callbackUrl; + + return authenticator; + } + + /// + /// Creates an authenticator to retrieve an access token using the request token. + /// + /// Consumer or API key + /// Consumer or API secret + /// Request token + /// Request token secret + /// Signature method, default is HMAC SHA1 + /// Authenticator instance + [PublicAPI] + public static OAuth1Authenticator ForAccessToken( + string consumerKey, + string? consumerSecret, + string token, + string tokenSecret, + OAuthSignatureMethod signatureMethod = OAuthSignatureMethod.HmacSha1 + ) + => new() { + ParameterHandling = OAuthParameterHandling.HttpAuthorizationHeader, + SignatureMethod = signatureMethod, + SignatureTreatment = OAuthSignatureTreatment.Escaped, + ConsumerKey = consumerKey, + ConsumerSecret = consumerSecret, + Token = token, + TokenSecret = tokenSecret, + Type = OAuthType.AccessToken + }; + + /// + /// Creates an authenticator to retrieve an access token using the request token and a verifier. + /// + /// Consumer or API key + /// Consumer or API secret + /// Request token + /// Request token secret + /// Verifier received from the API server + /// Authenticator instance + [PublicAPI] + public static OAuth1Authenticator ForAccessToken( + string consumerKey, + string? consumerSecret, + string token, + string tokenSecret, + string verifier + ) { + var authenticator = ForAccessToken(consumerKey, consumerSecret, token, tokenSecret); + + authenticator.Verifier = verifier; + + return authenticator; + } + + [PublicAPI] + public static OAuth1Authenticator ForAccessTokenRefresh( + string consumerKey, + string? consumerSecret, + string token, + string tokenSecret, + string sessionHandle + ) { + var authenticator = ForAccessToken(consumerKey, consumerSecret, token, tokenSecret); + + authenticator.SessionHandle = sessionHandle; + + return authenticator; + } + + [PublicAPI] + public static OAuth1Authenticator ForAccessTokenRefresh( + string consumerKey, + string? consumerSecret, + string token, + string tokenSecret, + string verifier, + string sessionHandle + ) { + var authenticator = ForAccessToken(consumerKey, consumerSecret, token, tokenSecret); + + authenticator.SessionHandle = sessionHandle; + authenticator.Verifier = verifier; + + return authenticator; + } + + [PublicAPI] + public static OAuth1Authenticator ForClientAuthentication( + string consumerKey, + string? consumerSecret, + string username, + string password, + OAuthSignatureMethod signatureMethod = OAuthSignatureMethod.HmacSha1 + ) + => new() { + ParameterHandling = OAuthParameterHandling.HttpAuthorizationHeader, + SignatureMethod = signatureMethod, + SignatureTreatment = OAuthSignatureTreatment.Escaped, + ConsumerKey = consumerKey, + ConsumerSecret = consumerSecret, + ClientUsername = username, + ClientPassword = password, + Type = OAuthType.ClientAuthentication + }; + + /// + /// Creates an authenticator to make calls to protected resources using the access token. + /// + /// Consumer or API key + /// Consumer or API secret + /// Access token + /// Access token secret + /// Signature method, default is HMAC SHA1 + /// Authenticator instance + [PublicAPI] + public static OAuth1Authenticator ForProtectedResource( + string consumerKey, + string? consumerSecret, + string accessToken, + string accessTokenSecret, + OAuthSignatureMethod signatureMethod = OAuthSignatureMethod.HmacSha1 + ) + => new() { + Type = OAuthType.ProtectedResource, + ParameterHandling = OAuthParameterHandling.HttpAuthorizationHeader, + SignatureMethod = signatureMethod, + SignatureTreatment = OAuthSignatureTreatment.Escaped, + ConsumerKey = consumerKey, + ConsumerSecret = consumerSecret, + Token = accessToken, + TokenSecret = accessTokenSecret + }; + + internal static void AddOAuthData( + IRestClient client, + RestRequest request, + OAuthWorkflow workflow, + OAuthType type, + string? realm + ) { + var requestUrl = client.BuildUriWithoutQueryParameters(request).AbsoluteUri; + + if (requestUrl.Contains('?')) + throw new ApplicationException( + "Using query parameters in the base URL is not supported for OAuth calls. Consider using AddDefaultQueryParameter instead." + ); + + var url = client.BuildUriString(request); + var queryStringStart = url.IndexOf('?'); + + if (queryStringStart != -1) url = url[..queryStringStart]; + + var method = request.Method.ToString().ToUpperInvariant(); + var parameters = new WebPairCollection(); + + var query = + request.AlwaysMultipartFormData || request.Files.Count > 0 + ? x => BaseQuery(x) && x.Name != null && x.Name.StartsWith("oauth_") + : (Func)BaseQuery; + + parameters.AddRange(client.DefaultParameters.Where(query).ToWebParameters()); + parameters.AddRange(request.Parameters.Where(query).ToWebParameters()); + + workflow.RequestUrl = url; + + var oauth = type switch { + OAuthType.RequestToken => workflow.BuildRequestTokenSignature(method, parameters), + OAuthType.AccessToken => workflow.BuildAccessTokenSignature(method, parameters), + OAuthType.ClientAuthentication => workflow.BuildClientAuthAccessTokenSignature(method, parameters), + OAuthType.ProtectedResource => workflow.BuildProtectedResourceSignature(method, parameters), + _ => throw new ArgumentOutOfRangeException(nameof(Type)) + }; + + oauth.Parameters.Add("oauth_signature", oauth.Signature); + + var oauthParameters = workflow.ParameterHandling switch { + OAuthParameterHandling.HttpAuthorizationHeader => CreateHeaderParameters(), + OAuthParameterHandling.UrlOrPostParameters => CreateUrlParameters(), + _ => throw new ArgumentOutOfRangeException(nameof(ParameterHandling)) + }; + + request.AddOrUpdateParameters(oauthParameters); + return; + + // include all GET and POST parameters before generating the signature + // according to the RFC 5849 - The OAuth 1.0 Protocol + // http://tools.ietf.org/html/rfc5849#section-3.4.1 + // if this change causes trouble we need to introduce a flag indicating the specific OAuth implementation level, + // or implement a separate class for each OAuth version + static bool BaseQuery(Parameter x) => x.Type is ParameterType.GetOrPost or ParameterType.QueryString; + + IEnumerable CreateHeaderParameters() => [new HeaderParameter(KnownHeaders.Authorization, GetAuthorizationHeader())]; + + IEnumerable CreateUrlParameters() => oauth.Parameters.Select(p => new GetOrPostParameter(p.Name, HttpUtility.UrlDecode(p.Value))); + + string GetAuthorizationHeader() { + var oathParameters = + oauth.Parameters + .OrderBy(x => x, WebPair.Comparer) + .Select(x => x.GetQueryParameter(true)) + .ToList(); + + if (!realm.IsEmpty()) oathParameters.Insert(0, $"realm=\"{OAuthTools.UrlEncodeRelaxed(realm)}\""); + + return $"OAuth {string.Join(",", oathParameters)}"; + } + } +} + +static class ParametersExtensions { + internal static IEnumerable ToWebParameters(this IEnumerable p) + => p.Select(x => new WebPair(Ensure.NotNull(x.Name, "Parameter name"), x.Value?.ToString())); +} \ No newline at end of file diff --git a/src/RestSharp/Authenticators/OAuth/OAuthTools.cs b/src/RestSharp/Authenticators/OAuth/OAuthTools.cs new file mode 100644 index 000000000..8b43f1dd0 --- /dev/null +++ b/src/RestSharp/Authenticators/OAuth/OAuthTools.cs @@ -0,0 +1,262 @@ +// Copyright (c) .NET Foundation and Contributors +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// http://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. + +using System.Diagnostics.CodeAnalysis; +using System.Security.Cryptography; +using System.Text; +using RestSharp.Authenticators.OAuth.Extensions; +using RestSharp.Extensions; +using static RestSharp.Authenticators.OAuth.OAuthSignatureMethod; + +namespace RestSharp.Authenticators.OAuth; + +static class OAuthTools { + const string AlphaNumeric = Upper + Lower + Digit; + const string Digit = "1234567890"; + const string Lower = "abcdefghijklmnopqrstuvwxyz"; + const string Unreserved = AlphaNumeric + "-._~"; + const string Upper = "ABCDEFGHIJKLMNOPQRSTUVWXYZ"; + + static readonly Random Random; + static readonly object RandomLock = new(); + static readonly RandomNumberGenerator Rng = RandomNumberGenerator.Create(); + static readonly Encoding Encoding = Encoding.UTF8; + + /// + /// The set of characters that are unreserved in RFC 2396 but are NOT unreserved in RFC 3986. + /// + static readonly string[] UriRfc3986CharsToEscape = ["!", "*", "'", "(", ")"]; + + static readonly string[] UriRfc3968EscapedHex = ["%21", "%2A", "%27", "%28", "%29"]; + + static OAuthTools() { + var bytes = new byte[4]; + + Rng.GetBytes(bytes); + Random = new(BitConverter.ToInt32(bytes, 0)); + } + + /// + /// Generates a random 16-byte lowercase alphanumeric string. + /// + /// + public static string GetNonce() { + const string chars = Lower + Digit; + + var nonce = new char[16]; + + lock (RandomLock) { + for (var i = 0; i < nonce.Length; i++) nonce[i] = chars[Random.Next(0, chars.Length)]; + } + + return new(nonce); + } + + /// + /// Generates a timestamp based on the current elapsed seconds since '01/01/1970 0000 GMT" + /// + /// + public static string GetTimestamp() => GetTimestamp(DateTime.UtcNow); + + /// + /// Generates a timestamp based on the elapsed seconds of a given time since '01/01/1970 0000 GMT" + /// + /// A specified point in time. + /// + static string GetTimestamp(DateTime dateTime) => dateTime.ToUnixTime().ToString(); + + /// + /// URL encodes a string based on section 5.1 of the OAuth spec. + /// Namely, percent encoding with [RFC3986], avoiding unreserved characters, + /// upper-casing hexadecimal characters, and UTF-8 encoding for text value pairs. + /// + /// The value to escape. + /// The escaped value. + [return: NotNullIfNotNull(nameof(value))] + public static string? UrlEncodeRelaxed(string? value) { + if (value == null) return null; + + // Do RFC 2396 escaping by calling the .NET method to do the work. + var escaped = Uri.EscapeDataString(value); + + // Escape RFC 3986 chars first. + var escapedRfc3986 = new StringBuilder(escaped); + + for (var i = 0; i < UriRfc3986CharsToEscape.Length; i++) { + var t = UriRfc3986CharsToEscape[i]; + + escapedRfc3986.Replace(t, UriRfc3968EscapedHex[i]); + } + + // Return the fully-RFC3986-escaped string. + return escapedRfc3986.ToString(); + } + + /// + /// URL encodes a string based on section 5.1 of the OAuth spec. + /// Namely, percent encoding with [RFC3986], avoiding unreserved characters, + /// upper-casing hexadecimal characters, and UTF-8 encoding for text value pairs. + /// + /// + // From oauth spec above: - + // Characters not in the unreserved character set ([RFC3986] + // (Berners-Lee, T., "Uniform Resource Identifiers (URI): + // Generic Syntax," .) section 2.3) MUST be encoded. + // ... + // unreserved = ALPHA, DIGIT, '-', '.', '_', '~' + [return: NotNullIfNotNull(nameof(value))] + public static string? UrlEncodeStrict(string? value) + => value == null ? null : string.Join("", value.Select(x => Unreserved.Contains(x) ? x.ToString() : $"%{(byte)x:X2}")); + + /// + /// Sorts a collection of key-value pairs by name, and then value if equal, + /// concatenating them into a single string. This string should be encoded + /// prior to, or after normalization is run. + /// + /// + /// + internal static string NormalizeRequestParameters(WebPairCollection parameters) => string.Join("&", SortParametersExcludingSignature(parameters)); + + /// + /// Sorts a by name, and then value if equal. + /// + /// A collection of parameters to sort + /// A sorted parameter collection + internal static IEnumerable SortParametersExcludingSignature(WebPairCollection parameters) + => parameters + .Where(x => !x.Name.EqualsIgnoreCase("oauth_signature")) + .Select(x => new WebPair(UrlEncodeStrict(x.Name), UrlEncodeRelaxed(x.Value))) + .OrderBy(x => x, WebPair.Comparer) + .Select(x => x.GetQueryParameter(false)); + + /// + /// Creates a request URL suitable for making OAuth requests. + /// Resulting URLs must exclude port 80 or port 443 when accompanied by HTTP and HTTPS, respectively. + /// Resulting URLs must be lower case. + /// + /// The original request URL + /// + static string ConstructRequestUrl(Uri url) { + Ensure.NotNull(url, nameof(url)); + + var basic = url is { Scheme: "http", Port : 80 }; + var secure = url is { Scheme: "https", Port: 443 }; + var port = basic || secure ? "" : $":{url.Port}"; + + // Decode the path to avoid double-encoding when the path contains already-encoded characters. + // For example, if a URL segment was added with AddUrlSegment("id", "value!"), it gets encoded + // to "value%21" in the URL. When we extract url.AbsolutePath, it contains "%21" (encoded). + // If we then call UrlEncodeRelaxed on it, Uri.EscapeDataString would encode the "%" to "%25", + // resulting in "%2521" (double-encoded). By decoding first, we ensure proper single encoding. + // + // Security note: This is safe because: + // - The url parameter is a validated Uri object constructed by RestSharp's BuildUri() + // - The decoded path is immediately re-encoded by UrlEncodeRelaxed before use + // - There is no direct user input involved in this internal OAuth signature calculation + var decodedPath = Uri.UnescapeDataString(url.AbsolutePath); + + return $"{url.Scheme}://{url.Host}{port}{decodedPath}"; + } + + /// + /// Creates a request elements concatenation value to send with a request. + /// This is also known as the signature base. + /// + /// The request HTTP method type + /// The request URL + /// The request parameters + /// A signature base string + public static string ConcatenateRequestElements(string method, string url, WebPairCollection parameters) { + // Separating &'s are not URL encoded + var requestMethod = method.ToUpperInvariant().Then("&"); + var requestUrl = UrlEncodeRelaxed(ConstructRequestUrl(url.AsUri())).Then("&"); + var requestParameters = UrlEncodeRelaxed(NormalizeRequestParameters(parameters)); + + return $"{requestMethod}{requestUrl}{requestParameters}"; + } + + /// + /// Creates a signature value given a signature base and the consumer secret. + /// This method is used when the token secret is currently unknown. + /// + /// The hashing method + /// The signature base + /// The consumer key + /// + public static string GetSignature( + OAuthSignatureMethod signatureMethod, + string signatureBase, + string? consumerSecret + ) + => GetSignature(signatureMethod, OAuthSignatureTreatment.Escaped, signatureBase, consumerSecret); + + /// + /// Creates a signature value given a signature base and the consumer secret and a known token secret. + /// + /// The hashing method + /// The treatment to use on a signature value + /// The signature base + /// The consumer secret + /// The token secret + /// + public static string GetSignature( + OAuthSignatureMethod signatureMethod, + OAuthSignatureTreatment signatureTreatment, + string signatureBase, + string? consumerSecret, + string? tokenSecret = null + ) { + if (tokenSecret.IsEmpty()) tokenSecret = string.Empty; + if (consumerSecret.IsEmpty()) consumerSecret = string.Empty; + + var unencodedConsumerSecret = consumerSecret; + consumerSecret = Uri.EscapeDataString(consumerSecret); + tokenSecret = Uri.EscapeDataString(tokenSecret); + + var signature = signatureMethod switch { + HmacSha1 => GetHmacSignature(new HMACSHA1(), consumerSecret, tokenSecret, signatureBase), + HmacSha256 => GetHmacSignature(new HMACSHA256(), consumerSecret, tokenSecret, signatureBase), + RsaSha1 => GetRsaSignature(), + PlainText => $"{consumerSecret}&{tokenSecret}", + _ => throw new NotImplementedException("Only HMAC-SHA1, HMAC-SHA256, and RSA-SHA1 are currently supported.") + }; + + var result = signatureTreatment == OAuthSignatureTreatment.Escaped + ? UrlEncodeRelaxed(signature) + : signature; + + return result; + + string GetRsaSignature() { + using var provider = new RSACryptoServiceProvider(); + provider.PersistKeyInCsp = false; + + provider.FromXmlString(unencodedConsumerSecret); + +#if NET + var hash = SHA1.HashData(Encoding.GetBytes(signatureBase)); +#else + var hasher = SHA1.Create(); + var hash = hasher.ComputeHash(Encoding.GetBytes(signatureBase)); +#endif + return Convert.ToBase64String(provider.SignHash(hash, CryptoConfig.MapNameToOID("SHA1"))); + } + } + + static string GetHmacSignature(KeyedHashAlgorithm crypto, string consumerSecret, string tokenSecret, string signatureBase) { + var key = $"{consumerSecret}&{tokenSecret}"; + crypto.Key = Encoding.GetBytes(key); + return signatureBase.HashWith(crypto); + } +} diff --git a/src/RestSharp/Authenticators/OAuth/OAuthWorkflow.cs b/src/RestSharp/Authenticators/OAuth/OAuthWorkflow.cs new file mode 100644 index 000000000..d1818ec55 --- /dev/null +++ b/src/RestSharp/Authenticators/OAuth/OAuthWorkflow.cs @@ -0,0 +1,184 @@ +// Copyright (c) .NET Foundation and Contributors +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// http://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. + +using System.Web; +using RestSharp.Authenticators.OAuth.Extensions; + +namespace RestSharp.Authenticators.OAuth; + +/// +/// A class to encapsulate OAuth authentication flow. +/// +sealed class OAuthWorkflow { + public string? Version { get; init; } + public string? ConsumerKey { get; init; } + public string? ConsumerSecret { get; init; } + public string? Token { get; init; } + public string? TokenSecret { get; init; } + public string? CallbackUrl { get; init; } + public string? Verifier { get; init; } + public string? SessionHandle { get; init; } + public OAuthSignatureMethod SignatureMethod { get; init; } + public OAuthSignatureTreatment SignatureTreatment { get; init; } + public OAuthParameterHandling ParameterHandling { get; set; } + public string? ClientUsername { get; init; } + public string? ClientPassword { get; init; } + public string? RequestUrl { get; set; } + + internal Func GetTimestamp { get; init; } = OAuthTools.GetTimestamp; + internal Func GetNonce { get; init; } = OAuthTools.GetNonce; + + /// + /// Generates an OAuth signature to pass to an + /// for the purpose of requesting an + /// unauthorized request token. + /// + /// The HTTP method for the intended request + /// Any existing, non-OAuth query parameters desired in the request + /// + public OAuthParameters BuildRequestTokenSignature(string method, WebPairCollection parameters) { + Ensure.NotEmptyString(ConsumerKey, nameof(ConsumerKey)); + + var allParameters = new WebPairCollection(); + allParameters.AddRange(parameters); + + var uri = new Uri(Ensure.NotEmptyString(RequestUrl, nameof(RequestUrl))); + var timestamp = GetTimestamp(); + var nonce = GetNonce(); + + var authParameters = GenerateAuthParameters(timestamp, nonce); + allParameters.AddRange(authParameters); + + var signatureBase = OAuthTools.ConcatenateRequestElements(method, uri.ToString(), allParameters); + + return new() { + Signature = OAuthTools.GetSignature(SignatureMethod, SignatureTreatment, signatureBase, ConsumerSecret), + Parameters = authParameters + }; + } + + /// + /// Generates an OAuth signature to pass to the + /// for the purpose of exchanging a request token + /// for an access token authorized by the user at the Service Provider site. + /// + /// The HTTP method for the intended request + /// Any existing, non-OAuth query parameters desired in the request + public OAuthParameters BuildAccessTokenSignature(string method, WebPairCollection parameters) { + Ensure.NotEmptyString(ConsumerKey, nameof(ConsumerKey)); + Ensure.NotEmptyString(Token, nameof(Token)); + + var allParameters = new WebPairCollection(); + allParameters.AddRange(parameters); + + var uri = new Uri(Ensure.NotEmptyString(RequestUrl, nameof(RequestUrl))); + var timestamp = GetTimestamp(); + var nonce = GetNonce(); + + var authParameters = GenerateAuthParameters(timestamp, nonce); + allParameters.AddRange(authParameters); + + var signatureBase = OAuthTools.ConcatenateRequestElements(method, uri.ToString(), allParameters); + + return new() { + Signature = OAuthTools.GetSignature(SignatureMethod, SignatureTreatment, signatureBase, ConsumerSecret, TokenSecret), + Parameters = authParameters + }; + } + + /// + /// Generates an OAuth signature to pass to an + /// for the purpose of exchanging user credentials + /// for an access token authorized by the user at the Service Provider site. + /// + /// The HTTP method for the intended request + /// Any existing, non-OAuth query parameters desired in the request + public OAuthParameters BuildClientAuthAccessTokenSignature(string method, WebPairCollection parameters) { + Ensure.NotEmptyString(ConsumerKey, nameof(ConsumerKey)); + Ensure.NotEmptyString(ClientUsername, nameof(ClientUsername)); + + var allParameters = new WebPairCollection(); + allParameters.AddRange(parameters); + + var uri = new Uri(Ensure.NotEmptyString(RequestUrl, nameof(RequestUrl))); + var timestamp = GetTimestamp(); + var nonce = GetNonce(); + + var authParameters = GenerateXAuthParameters(timestamp, nonce); + allParameters.AddRange(authParameters); + + var signatureBase = OAuthTools.ConcatenateRequestElements(method, uri.ToString(), allParameters); + + return new() { + Signature = OAuthTools.GetSignature(SignatureMethod, SignatureTreatment, signatureBase, ConsumerSecret), + Parameters = authParameters + }; + } + + public OAuthParameters BuildProtectedResourceSignature(string method, WebPairCollection parameters) { + Ensure.NotEmptyString(ConsumerKey, nameof(ConsumerKey)); + + var allParameters = new WebPairCollection(); + allParameters.AddRange(parameters); + + // Include url parameters in query pool + var uri = new Uri(Ensure.NotEmptyString(RequestUrl, nameof(RequestUrl))); + var urlParameters = HttpUtility.ParseQueryString(uri.Query); + + allParameters.AddRange(urlParameters.AllKeys.Select(x => new WebPair(x!, urlParameters[x]!))); + + var timestamp = GetTimestamp(); + var nonce = GetNonce(); + + var authParameters = GenerateAuthParameters(timestamp, nonce); + allParameters.AddRange(authParameters); + + var signatureBase = OAuthTools.ConcatenateRequestElements(method, uri.ToString(), allParameters); + + return new() { + Signature = OAuthTools.GetSignature(SignatureMethod, SignatureTreatment, signatureBase, ConsumerSecret, TokenSecret), + Parameters = authParameters + }; + } + + WebPairCollection GenerateAuthParameters(string timestamp, string nonce) + => new WebPairCollection { + new("oauth_consumer_key", Ensure.NotNull(ConsumerKey, nameof(ConsumerKey)), true), + new("oauth_nonce", nonce), + new("oauth_signature_method", SignatureMethod.ToRequestValue()), + new("oauth_timestamp", timestamp), + new("oauth_version", Version ?? "1.0") + } + .AddNotEmpty("oauth_token", Token, true) + .AddNotEmpty("oauth_callback", CallbackUrl, true) + .AddNotEmpty("oauth_verifier", Verifier) + .AddNotEmpty("oauth_session_handle", SessionHandle); + + WebPairCollection GenerateXAuthParameters(string timestamp, string nonce) + => [ + new("x_auth_username", Ensure.NotNull(ClientUsername, nameof(ClientUsername))), + new("x_auth_password", Ensure.NotNull(ClientPassword, nameof(ClientPassword))), + new("x_auth_mode", "client_auth"), + new("oauth_consumer_key", Ensure.NotNull(ConsumerKey, nameof(ConsumerKey)), true), + new("oauth_signature_method", SignatureMethod.ToRequestValue()), + new("oauth_timestamp", timestamp), + new("oauth_nonce", nonce), + new("oauth_version", Version ?? "1.0") + ]; + + internal class OAuthParameters { + public WebPairCollection Parameters { get; init; } = null!; + public string Signature { get; init; } = null!; + } +} \ No newline at end of file diff --git a/src/RestSharp/Authenticators/OAuth/WebPair.cs b/src/RestSharp/Authenticators/OAuth/WebPair.cs new file mode 100644 index 000000000..381fbbe24 --- /dev/null +++ b/src/RestSharp/Authenticators/OAuth/WebPair.cs @@ -0,0 +1,36 @@ +// Copyright (c) .NET Foundation and Contributors +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// http://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. + +namespace RestSharp.Authenticators.OAuth; + +class WebPair(string name, string? value, bool encode = false) { + public string Name { get; } = name; + public string? Value { get; } = value; + string? WebValue { get; } = encode ? OAuthTools.UrlEncodeRelaxed(value) : value; + + public string GetQueryParameter(bool web) { + var value = web ? $"\"{WebValue}\"" : Value; + return value == null ? Name : $"{Name}={value}"; + } + + internal static WebPairComparer Comparer { get; } = new(); + + internal class WebPairComparer : IComparer { + public int Compare(WebPair? x, WebPair? y) { + var compareName = string.CompareOrdinal(x?.Name, y?.Name); + + return compareName != 0 ? compareName : string.CompareOrdinal(x?.Value, y?.Value); + } + } +} diff --git a/src/RestSharp/Authenticators/OAuth/WebPairCollection.cs b/src/RestSharp/Authenticators/OAuth/WebPairCollection.cs new file mode 100644 index 000000000..550d0e7d6 --- /dev/null +++ b/src/RestSharp/Authenticators/OAuth/WebPairCollection.cs @@ -0,0 +1,63 @@ +// Copyright (c) .NET Foundation and Contributors +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// http://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. + +using System.Collections; + +namespace RestSharp.Authenticators.OAuth; + +class WebPairCollection : IList { + readonly List _parameters = []; + + public IEnumerator GetEnumerator() => _parameters.GetEnumerator(); + + IEnumerator IEnumerable.GetEnumerator() => GetEnumerator(); + + public void Add(WebPair parameter) => _parameters.Add(parameter); + + public void AddRange(IEnumerable collection) => AddCollection(collection); + + public void Add(string name, string value) => Add(new(name, value)); + + public WebPairCollection AddNotEmpty(string name, string? value, bool encode = false) { + if (value != null) + Add(new(name, value, encode)); + return this; + } + + public void Clear() => _parameters.Clear(); + + public bool Contains(WebPair parameter) => _parameters.Contains(parameter); + + public void CopyTo(WebPair[] parametersArray, int arrayIndex) => _parameters.CopyTo(parametersArray, arrayIndex); + + public bool Remove(WebPair parameter) => _parameters.Remove(parameter); + + public int Count => _parameters.Count; + + public bool IsReadOnly => false; + + public int IndexOf(WebPair parameter) => _parameters.IndexOf(parameter); + + public void Insert(int index, WebPair parameter) => _parameters.Insert(index, parameter); + + public void RemoveAt(int index) => _parameters.RemoveAt(index); + + public WebPair this[int index] { + get => _parameters[index]; + set => _parameters[index] = value; + } + + void AddCollection(IEnumerable collection) + => _parameters.AddRange(collection.Select(parameter => new WebPair(parameter.Name, parameter.Value))); +} \ No newline at end of file diff --git a/src/RestSharp/Authenticators/OAuth2/OAuth2AuthorizationRequestHeaderAuthenticator.cs b/src/RestSharp/Authenticators/OAuth2/OAuth2AuthorizationRequestHeaderAuthenticator.cs new file mode 100644 index 000000000..55a6bf5d5 --- /dev/null +++ b/src/RestSharp/Authenticators/OAuth2/OAuth2AuthorizationRequestHeaderAuthenticator.cs @@ -0,0 +1,36 @@ +// Copyright (c) .NET Foundation and Contributors +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// http://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. + +namespace RestSharp.Authenticators.OAuth2; + +/// +/// The OAuth 2 authenticator using the authorization request header field. +/// +/// +/// Based on http://tools.ietf.org/html/draft-ietf-oauth-v2-10#section-5.1.1 +/// +[PublicAPI] +public class OAuth2AuthorizationRequestHeaderAuthenticator : AuthenticatorBase { + readonly string _tokenType; + + /// + /// Initializes a new instance of the class. + /// + /// The access token. + /// The token type. + public OAuth2AuthorizationRequestHeaderAuthenticator(string accessToken, string tokenType = "OAuth") : base(accessToken) => _tokenType = tokenType; + + protected override ValueTask GetAuthenticationParameter(string accessToken) + => new(new HeaderParameter(KnownHeaders.Authorization, $"{_tokenType} {accessToken}")); +} \ No newline at end of file diff --git a/src/RestSharp/Authenticators/OAuth2/OAuth2UriQueryParameterAuthenticator.cs b/src/RestSharp/Authenticators/OAuth2/OAuth2UriQueryParameterAuthenticator.cs new file mode 100644 index 000000000..9ea1b593f --- /dev/null +++ b/src/RestSharp/Authenticators/OAuth2/OAuth2UriQueryParameterAuthenticator.cs @@ -0,0 +1,33 @@ +// Copyright (c) .NET Foundation and Contributors +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// http://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. + +namespace RestSharp.Authenticators.OAuth2; + +/// +/// The OAuth 2 authenticator using URI query parameter. +/// +/// +/// Based on http://tools.ietf.org/html/draft-ietf-oauth-v2-10#section-5.1.2 +/// +[PublicAPI] +public class OAuth2UriQueryParameterAuthenticator : AuthenticatorBase { + /// + /// Initializes a new instance of the class. + /// + /// The access token. + public OAuth2UriQueryParameterAuthenticator(string accessToken) : base(accessToken) { } + + protected override ValueTask GetAuthenticationParameter(string accessToken) + => new(new GetOrPostParameter("oauth_token", accessToken)); +} \ No newline at end of file diff --git a/src/RestSharp/BuildUriExtensions.cs b/src/RestSharp/BuildUriExtensions.cs new file mode 100644 index 000000000..8fb95563e --- /dev/null +++ b/src/RestSharp/BuildUriExtensions.cs @@ -0,0 +1,98 @@ +// Copyright (c) .NET Foundation and Contributors +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// http://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. +// + +namespace RestSharp; + +public static class BuildUriExtensions { + /// Client instance + extension(IRestClient client) { + /// + /// Builds the URI for the request + /// + /// Request instance + /// + public Uri BuildUri(RestRequest request) => new(client.BuildUriString(request)); + + /// + /// Builds the URI string for the request. This method returns a string instead of a Uri object + /// to preserve unencoded characters when encode=false is specified for query parameters. + /// + /// Request instance + /// + [PublicAPI] + public string BuildUriString(RestRequest request) { + var mergedUri = client.BuildUriWithoutQueryParameters(request); + var query = client.GetRequestQuery(request); + + if (query == null) return mergedUri.AbsoluteUri; + + var separator = mergedUri.AbsoluteUri.Contains('?') ? "&" : "?"; + return $"{mergedUri.AbsoluteUri}{separator}{query}"; + } + + /// + /// Builds the URI for the request without query parameters. + /// + /// Request instance + /// + public Uri BuildUriWithoutQueryParameters(RestRequest request) { + DoBuildUriValidations(client, request); + + var (uri, resource) = client.Options.BaseUrl.GetUrlSegmentParamsValues( + request.Resource, + client.Options.Encode, + request.Parameters, + client.DefaultParameters + ); + return uri.MergeBaseUrlAndResource(resource); + } + + /// + /// Gets the query string for the request. + /// + /// Request instance + /// + [PublicAPI] + public string? GetRequestQuery(RestRequest request) { + var parametersCollections = new ParametersCollection[] { request.Parameters, client.DefaultParameters }; + + var parameters = parametersCollections.SelectMany(x => x.GetQueryParameters(request.Method)).ToList(); + + return parameters.Count == 0 ? null : string.Join("&", parameters.Select(EncodeParameter).ToArray()); + + string GetString(string name, string? value, Func? encode) { + var val = encode != null && value != null ? encode(value) : value; + return val == null ? name : $"{name}={val}"; + } + + string EncodeParameter(Parameter parameter) + => !parameter.Encode + ? GetString(parameter.Name!, parameter.Value?.ToString(), null) + : GetString( + client.Options.EncodeQuery(parameter.Name!, client.Options.Encoding), + parameter.Value?.ToString(), + x => client.Options.EncodeQuery(x, client.Options.Encoding) + ); + } + } + + static void DoBuildUriValidations(IRestClient client, RestRequest request) { + if (client.Options.BaseUrl == null && !request.Resource.StartsWith("http", StringComparison.InvariantCultureIgnoreCase)) + throw new ArgumentOutOfRangeException( + nameof(request), + "Request resource doesn't contain a valid scheme for an empty base URL of the client" + ); + } +} diff --git a/src/RestSharp/ContentType.cs b/src/RestSharp/ContentType.cs new file mode 100644 index 000000000..8f8d70554 --- /dev/null +++ b/src/RestSharp/ContentType.cs @@ -0,0 +1,84 @@ +// Copyright (c) .NET Foundation and Contributors +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// http://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. + +using System.Net.Http.Headers; + +namespace RestSharp; + +public delegate bool SupportsContentType(ContentType contentType); + +public class ContentType : IEquatable { + ContentType(string contentType) { + var ct = Ensure.NotEmptyString(contentType, nameof(contentType)); + if (!ct.Contains('/')) throw new ArgumentException("Invalid content type string", nameof(contentType)); + + _value = ct; + } + + public static readonly ContentType Json = "application/json"; + public static readonly ContentType Xml = "application/xml"; + public static readonly ContentType Plain = "text/plain"; + public static readonly ContentType Csv = "text/csv"; + public static readonly ContentType Binary = "application/octet-stream"; + public static readonly ContentType GZip = "application/x-gzip"; + public static readonly ContentType FormUrlEncoded = "application/x-www-form-urlencoded"; + public static readonly ContentType Undefined = "undefined/undefined"; + + public string Value => _value == Undefined._value ? Plain._value : _value; + + public static ContentType FromDataFormat(DataFormat dataFormat) => DataFormatMap[dataFormat]; + + public override string ToString() => Value; + + public static implicit operator ContentType(string? contentType) => contentType == null ? Undefined : new(contentType); + + public static implicit operator string(ContentType contentType) => contentType.Value; + + public ContentType Or(ContentType? contentType) => Equals(Undefined) ? contentType ?? Plain : this; + + public string OrValue(string? contentType) => Equals(Undefined) ? contentType ?? Plain.Value : Value; + + public MediaTypeHeaderValue AsMediaTypeHeaderValue => MediaTypeHeaderValue.Parse(Value); + + static readonly Dictionary DataFormatMap = + new() { + { DataFormat.Xml, Xml }, + { DataFormat.Json, Json }, + { DataFormat.None, Plain }, + { DataFormat.Binary, Binary } + }; + + public static readonly string[] JsonAccept = [Json, "text/json", "text/x-json", "text/javascript"]; + + public static readonly string[] XmlAccept = [Xml, "text/xml"]; + + readonly string _value; + + public bool Equals(ContentType? other) { + if (ReferenceEquals(null, other)) return false; + if (ReferenceEquals(this, other)) return true; + + return _value == other._value; + } + + public override bool Equals(object? obj) { + if (ReferenceEquals(null, obj)) return false; + if (ReferenceEquals(this, obj)) return true; + if (obj.GetType() != GetType()) return false; + + return Equals((ContentType)obj); + } + + public override int GetHashCode() => _value.GetHashCode(); +} \ No newline at end of file diff --git a/src/RestSharp/Ensure.cs b/src/RestSharp/Ensure.cs new file mode 100644 index 000000000..dbdb56f9d --- /dev/null +++ b/src/RestSharp/Ensure.cs @@ -0,0 +1,26 @@ +// Copyright (c) .NET Foundation and Contributors +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// http://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. + +namespace RestSharp; + +static class Ensure { + public static T NotNull(T? value, [InvokerParameterName] string name) => value ?? throw new ArgumentNullException(name); + + public static string NotEmptyString(object? value, [InvokerParameterName] string name) { + var s = value as string ?? value?.ToString(); + if (s == null) throw new ArgumentNullException(name); + + return string.IsNullOrWhiteSpace(s) ? throw new ArgumentException("Parameter cannot be an empty string", name) : s; + } +} \ No newline at end of file diff --git a/src/RestSharp/Enum.cs b/src/RestSharp/Enum.cs new file mode 100644 index 000000000..c6ebf0cfb --- /dev/null +++ b/src/RestSharp/Enum.cs @@ -0,0 +1,118 @@ +// Copyright (c) .NET Foundation and Contributors +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// http://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. + +namespace RestSharp; + +/// +/// Types of parameters that can be added to requests +/// +public enum ParameterType { + /// + /// A that will added to the QueryString for GET, DELETE, OPTIONS and HEAD requests; and form for POST and PUT requests. + /// + /// + /// See . + /// + GetOrPost, + + /// + /// A that will be added to part of the url by replacing a {placeholder} within the absolute path. + /// + /// + /// See . + /// + UrlSegment, + + /// + /// A that will be added as a request header + /// + /// + /// See . + /// + HttpHeader, + + /// + /// A that will be added to the request body + /// + /// + /// See . + /// + RequestBody, + + /// + /// A that will be added to the query string + /// + /// + /// See . + /// + QueryString +} + +/// +/// Data formats +/// +public enum DataFormat { Json, Xml, Binary, None } + +/// +/// HTTP method to use when making requests +/// +public enum Method { + Get, Post, Put, Delete, Head, Options, + Patch, Merge, Copy, Search +} + +/// +/// Format strings for commonly-used date formats +/// +public struct DateFormat { + /// + /// .NET format string for ISO 8601 date format + /// + public const string ISO_8601 = "s"; + + /// + /// .NET format string for roundtrip date format + /// + public const string ROUND_TRIP = "u"; +} + +/// +/// Status for responses (surprised?) +/// +public enum ResponseStatus { + /// + /// Not Applicable, for when the Request has not yet been made + /// + None, + + /// + /// for when the request is passes as a result of being true, or when the response is + /// + Completed, + + /// + /// for when the request fails due as a result of being false except for the case when the response is + /// + Error, + + /// + /// for when the Operation is cancelled due to the request taking longer than the length of time prescribed by or due to the timing out. + /// + TimedOut, + + /// + /// for when the Operation is cancelled, due to reasons other than + /// + Aborted +} \ No newline at end of file diff --git a/RestSharp/Deserializers/IDeserializer.cs b/src/RestSharp/Extensions/CollectionExtensions.cs similarity index 64% rename from RestSharp/Deserializers/IDeserializer.cs rename to src/RestSharp/Extensions/CollectionExtensions.cs index aff48d444..7d04f99a9 100644 --- a/RestSharp/Deserializers/IDeserializer.cs +++ b/src/RestSharp/Extensions/CollectionExtensions.cs @@ -1,6 +1,4 @@ -#region License - -// Copyright 2010 John Sheehan +// Copyright (c) .NET Foundation and Contributors // // Licensed under the Apache License, Version 2.0 (the "License"); // you may not use this file except in compliance with the License. @@ -14,18 +12,10 @@ // See the License for the specific language governing permissions and // limitations under the License. -#endregion - -namespace RestSharp.Deserializers -{ - public interface IDeserializer - { - T Deserialize(IRestResponse response); - - string RootElement { get; set; } - - string Namespace { get; set; } +namespace RestSharp.Extensions; - string DateFormat { get; set; } +static class CollectionExtensions { + public static void ForEach(this IEnumerable items, Action action) { + foreach (var item in items) action(item); } -} +} \ No newline at end of file diff --git a/src/RestSharp/Extensions/CookieContainerExtensions.cs b/src/RestSharp/Extensions/CookieContainerExtensions.cs new file mode 100644 index 000000000..8df9142d7 --- /dev/null +++ b/src/RestSharp/Extensions/CookieContainerExtensions.cs @@ -0,0 +1,29 @@ +// Copyright (c) .NET Foundation and Contributors +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// http://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. +// + +namespace RestSharp.Extensions; + +static class CookieContainerExtensions { + public static void AddCookies(this CookieContainer cookieContainer, Uri uri, IEnumerable cookiesHeader) { + foreach (var header in cookiesHeader) { + try { + cookieContainer.SetCookies(uri, header); + } + catch (CookieException) { + // Do not fail request if we cannot parse a cookie + } + } + } +} diff --git a/src/RestSharp/Extensions/GenerateImmutableAttribute.cs b/src/RestSharp/Extensions/GenerateImmutableAttribute.cs new file mode 100644 index 000000000..e049e72e9 --- /dev/null +++ b/src/RestSharp/Extensions/GenerateImmutableAttribute.cs @@ -0,0 +1,29 @@ +// Copyright (c) .NET Foundation and Contributors +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// http://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. +// + +namespace RestSharp.Extensions; + +[AttributeUsage(AttributeTargets.Class)] +class GenerateImmutableAttribute : Attribute; + +[AttributeUsage(AttributeTargets.Class)] +class GenerateCloneAttribute : Attribute { + public Type? BaseType { get; set; } + public string? Name { get; set; } + public bool Mutate { get; set; } +}; + +[AttributeUsage(AttributeTargets.Property)] +class Exclude : Attribute; \ No newline at end of file diff --git a/src/RestSharp/Extensions/HttpHeadersExtensions.cs b/src/RestSharp/Extensions/HttpHeadersExtensions.cs new file mode 100644 index 000000000..9dabe4755 --- /dev/null +++ b/src/RestSharp/Extensions/HttpHeadersExtensions.cs @@ -0,0 +1,26 @@ +// Copyright (c) .NET Foundation and Contributors +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// http://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. +// + +using System.Net.Http.Headers; + +namespace RestSharp.Extensions; + +static class HttpHeadersExtensions { + public static IReadOnlyCollection GetHeaderParameters(this HttpHeaders httpHeaders) + => httpHeaders + .SelectMany(x => x.Value.Select(y => (x.Key, y))) + .Select(x => new HeaderParameter(x.Key, x.y)) + .ToList(); +} \ No newline at end of file diff --git a/src/RestSharp/Extensions/HttpResponseExtensions.cs b/src/RestSharp/Extensions/HttpResponseExtensions.cs new file mode 100644 index 000000000..8cfd52a60 --- /dev/null +++ b/src/RestSharp/Extensions/HttpResponseExtensions.cs @@ -0,0 +1,71 @@ +// Copyright (c) .NET Foundation and Contributors +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// http://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. +// + +using System.Text; + +namespace RestSharp.Extensions; + +static class HttpResponseExtensions { + public static Exception? MaybeException(this HttpResponseMessage httpResponse, bool throwOnUnsuccessfulStatusCode) + => httpResponse.IsSuccessStatusCode || !throwOnUnsuccessfulStatusCode + ? null +#if NET + : new HttpRequestException($"Request failed with status code {httpResponse.StatusCode}", null, httpResponse.StatusCode); +#else + : new HttpRequestException($"Request failed with status code {httpResponse.StatusCode}"); +#endif + + public static async Task GetResponseString(this HttpResponseMessage response, byte[] bytes, Encoding clientEncoding) { + var encodingString = response.Content.Headers.ContentType?.CharSet; + var encoding = encodingString != null ? TryGetEncoding(encodingString) : clientEncoding; + + using var reader = new StreamReader(new MemoryStream(bytes), encoding); + return await reader.ReadToEndAsync(); + Encoding TryGetEncoding(string es) { + try { + return Encoding.GetEncoding(es); + } + catch { + return Encoding.Default; + } + } + } + + public static Task ReadResponseStream( + this HttpResponseMessage httpResponse, + Func? writer, + CancellationToken cancellationToken = default + ) { + var readTask = writer == null ? ReadResponse() : ReadAndConvertResponse(writer); + return readTask; + + Task ReadResponse() { +#if NET + return httpResponse.Content.ReadAsStreamAsync(cancellationToken)!; +# else + return httpResponse.Content == null ? Task.FromResult((Stream?)null) : httpResponse.Content.ReadAsStreamAsync(); +#endif + } + + async Task ReadAndConvertResponse(Func streamWriter) { +#if NET + await using var original = await ReadResponse().ConfigureAwait(false); +#else + using var original = await ReadResponse().ConfigureAwait(false); +#endif + return original == null ? null : streamWriter(original); + } + } +} \ No newline at end of file diff --git a/src/RestSharp/Extensions/ReflectionExtensions.cs b/src/RestSharp/Extensions/ReflectionExtensions.cs new file mode 100644 index 000000000..01a7e2b96 --- /dev/null +++ b/src/RestSharp/Extensions/ReflectionExtensions.cs @@ -0,0 +1,90 @@ +// Copyright (c) .NET Foundation and Contributors +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// http://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. + +using System.Globalization; +using System.Reflection; + +namespace RestSharp.Extensions; + +/// +/// Reflection extensions +/// +public static class ReflectionExtensions { + /// + /// Retrieve an attribute from a member (property) + /// + /// Type of attribute to retrieve + /// Member to retrieve attribute from + /// + public static T? GetAttribute(this MemberInfo prop) where T : Attribute => Attribute.GetCustomAttribute(prop, typeof(T)) as T; + + /// + /// Retrieve an attribute from a type + /// + /// Type of attribute to retrieve + /// Type to retrieve attribute from + /// + public static T? GetAttribute(this Type type) where T : Attribute => Attribute.GetCustomAttribute(type, typeof(T)) as T; + + /// + /// Checks a type to see if it derives from a raw generic (e.g. List[[]]) + /// + /// + /// + /// + public static bool IsSubclassOfRawGeneric(this Type? toCheck, Type generic) { + while (toCheck != null && toCheck != typeof(object)) { + var cur = toCheck.GetTypeInfo().IsGenericType + ? toCheck.GetGenericTypeDefinition() + : toCheck; + + if (generic == cur) return true; + + toCheck = toCheck.GetTypeInfo().BaseType; + } + + return false; + } + + internal static object? ChangeType(this object? source, Type newType) => Convert.ChangeType(source, newType); + + /// + /// Find a value from a System.Enum by trying several possible variants + /// of the string value of the enum. + /// + /// Type of enum + /// Value for which to search + /// The culture used to calculate the name variants + /// + public static object? FindEnumValue(this Type type, string value, CultureInfo culture) { + var caseInsensitiveComparer = StringComparer.Create(culture, true); + + var ret = Enum.GetValues(type) + .Cast() + .FirstOrDefault( + v => v.ToString() + .GetNameVariants(culture) + .Contains(value, caseInsensitiveComparer) + ); + + if (ret != null) return ret; + + var enumValueAsUnderlyingType = Convert.ChangeType(value, Enum.GetUnderlyingType(type), culture); + + if (Enum.IsDefined(type, enumValueAsUnderlyingType)) + ret = (Enum)Enum.ToObject(type, enumValueAsUnderlyingType); + + return ret ?? Activator.CreateInstance(type); + } +} \ No newline at end of file diff --git a/src/RestSharp/Extensions/StreamExtensions.cs b/src/RestSharp/Extensions/StreamExtensions.cs new file mode 100644 index 000000000..fd5cf685b --- /dev/null +++ b/src/RestSharp/Extensions/StreamExtensions.cs @@ -0,0 +1,42 @@ +// Copyright (c) .NET Foundation and Contributors +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// http://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. + +namespace RestSharp.Extensions; + +/// +/// Extension method overload! +/// +static class StreamExtensions { + /// + /// Read a stream into a byte array + /// + /// Stream to read + /// + /// byte[] + public static async Task ReadAsBytes(this Stream input, CancellationToken cancellationToken) { + var buffer = new byte[16 * 1024]; + + using var ms = new MemoryStream(); + + int read; +#if NET + while ((read = await input.ReadAsync(buffer, cancellationToken).ConfigureAwait(false)) > 0) +#else + while ((read = await input.ReadAsync(buffer, 0, buffer.Length, cancellationToken).ConfigureAwait(false)) > 0) +#endif + ms.Write(buffer, 0, read); + + return ms.ToArray(); + } +} \ No newline at end of file diff --git a/src/RestSharp/Extensions/StringExtensions.cs b/src/RestSharp/Extensions/StringExtensions.cs new file mode 100644 index 000000000..800e331be --- /dev/null +++ b/src/RestSharp/Extensions/StringExtensions.cs @@ -0,0 +1,258 @@ +// Copyright (c) .NET Foundation and Contributors +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// http://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. + +using System.Diagnostics.CodeAnalysis; +using System.Globalization; +using System.Text; +using System.Text.RegularExpressions; +using System.Web; + +namespace RestSharp.Extensions; + +// ReSharper disable once PartialTypeWithSinglePart +static partial class StringExtensions { + static readonly Regex IsUpperCaseRegex = IsUpperCase(); + + static readonly Regex AddUnderscoresRegex1 = AddUnderscores1(); + static readonly Regex AddUnderscoresRegex2 = AddUnderscores2(); + static readonly Regex AddUnderscoresRegex3 = AddUnderscores3(); + + static readonly Regex AddDashesRegex1 = AddDashes1(); + static readonly Regex AddDashesRegex2 = AddDashes2(); + static readonly Regex AddDashesRegex3 = AddDashes3(); + + static readonly Regex AddSpacesRegex1 = AddSpaces1(); + static readonly Regex AddSpacesRegex2 = AddSpaces2(); + static readonly Regex AddSpacesRegex3 = AddSpaces3(); + + extension(string input) { + internal string UrlDecode() => HttpUtility.UrlDecode(input); + + /// + /// Uses Uri.EscapeDataString() based on recommendations on MSDN + /// http://blogs.msdn.com/b/yangxind/archive/2006/11/09/don-t-use-net-system-uri-unescapedatastring-in-url-decoding.aspx + /// + internal string UrlEncode() { + const int maxLength = 32766; + + if (input == null) throw new ArgumentNullException(nameof(input)); + + if (input.Length <= maxLength) return Uri.EscapeDataString(input); + + var sb = new StringBuilder(input.Length * 2); + var index = 0; + + while (index < input.Length) { + var length = Math.Min(input.Length - index, maxLength); + + while (CharUnicodeInfo.GetUnicodeCategory(input[index + length - 1]) == UnicodeCategory.Surrogate) { + length--; + } + + var subString = input.Substring(index, length); + + sb.Append(Uri.EscapeDataString(subString)); + index += subString.Length; + } + + return sb.ToString(); + } + + internal string? UrlEncode(Encoding encoding) { + var encoded = HttpUtility.UrlEncode(input, encoding); + return encoded?.Replace("+", "%20"); + } + } + + extension(string input) { + internal string RemoveUnderscoresAndDashes() => input.Replace("_", "").Replace("-", ""); + + internal string ToPascalCase(CultureInfo culture) => ToPascalCase(input, true, culture); + + internal string ToPascalCase(bool removeUnderscores, CultureInfo culture) { + if (string.IsNullOrEmpty(input)) return input; + + input = input.Replace('_', ' '); + + var joinString = removeUnderscores ? string.Empty : "_"; + var words = input.Split(' '); + + return words + .Where(x => x.Length > 0) + .Select(CaseWord) + .JoinToString(joinString); + + string CaseWord(string word) { + var restOfWord = word[1..]; + var firstChar = char.ToUpper(word[0], culture); + + if (restOfWord.IsUpperCase()) restOfWord = restOfWord.ToLower(culture); + + return string.Concat(firstChar, restOfWord); + } + } + + internal string ToCamelCase(CultureInfo culture) + => MakeInitialLowerCase(ToPascalCase(input, culture), culture); + + internal IEnumerable GetNameVariants(CultureInfo culture) { + if (string.IsNullOrEmpty(input)) yield break; + + yield return input; + + // try camel cased name + yield return input.ToCamelCase(culture); + + // try lower cased name + yield return input.ToLower(culture); + + // try name with underscores + yield return input.AddUnderscores(); + + // try name with underscores with lower case + yield return input.AddUnderscores().ToLower(culture); + + // try name with dashes + yield return input.AddDashes(); + + // try name with dashes with lower case + yield return input.AddDashes().ToLower(culture); + + // try name with underscore prefix + yield return input.AddUnderscorePrefix(); + + // try name with proper camel case + yield return input.AddUnderscores().ToCamelCase(culture); + + // try name with underscore prefix, using proper camel case + yield return input.ToCamelCase(culture).AddUnderscorePrefix(); + + // try name with underscore prefix, using camel case + yield return input.AddUnderscores().ToCamelCase(culture).AddUnderscorePrefix(); + + // try name with spaces + yield return input.AddSpaces(); + + // try name with spaces with lower case + yield return input.AddSpaces().ToLower(culture); + } + } + + internal static string? ToStringValue(this object? value, CultureInfo? culture = null) + => value is IFormattable f ? f.ToString(null, culture ?? CultureInfo.InvariantCulture) : value?.ToString(); + + internal static bool IsEmpty([NotNullWhen(false)] this string? value) => string.IsNullOrWhiteSpace(value); + + internal static bool IsNotEmpty([NotNullWhen(true)] this string? value) => !string.IsNullOrWhiteSpace(value); + + internal static string JoinToString(this IEnumerable strings, string separator) => string.Join(separator, strings); + + extension(string word) { + string MakeInitialLowerCase(CultureInfo culture) => string.Concat(word[..1].ToLower(culture), word[1..]); + + string AddUnderscores() + => AddUnderscoresRegex1.Replace( + AddUnderscoresRegex2.Replace( + AddUnderscoresRegex3.Replace(word, "$1_$2"), + "$1_$2" + ), + "_" + ); + + string AddDashes() + => AddDashesRegex1.Replace( + AddDashesRegex2.Replace( + AddDashesRegex3.Replace(word, "$1-$2"), + "$1-$2" + ), + "-" + ); + + bool IsUpperCase() => IsUpperCaseRegex.IsMatch(word); + + string AddUnderscorePrefix() => $"_{word}"; + + string AddSpaces() + => AddSpacesRegex1.Replace( + AddSpacesRegex2.Replace( + AddSpacesRegex3.Replace(word, "$1 $2"), + "$1 $2" + ), + " " + ); + } + + const string RIsUpperCase = "^[A-Z]+$"; + const string RAddUnderscore1 = @"[-\s]"; + const string RAddUnderscore2 = @"([a-z\d])([A-Z])"; + const string RAddUnderscore3 = "([A-Z]+)([A-Z][a-z])"; + const string RAddDashes1 = @"[\s]"; + const string RAddDashes2 = @"([a-z\d])([A-Z])"; + const string RAddDashes3 = "([A-Z]+)([A-Z][a-z])"; + const string RAddSpaces1 = @"[-\s]"; + const string RAddSpaces2 = @"([a-z\d])([A-Z])"; + const string RAddSpaces3 = "([A-Z]+)([A-Z][a-z])"; + +#if NET7_0_OR_GREATER + [GeneratedRegex(RIsUpperCase)] + private static partial Regex IsUpperCase(); + + [GeneratedRegex(RAddUnderscore1)] + private static partial Regex AddUnderscores1(); + + [GeneratedRegex(RAddUnderscore2)] + private static partial Regex AddUnderscores2(); + + [GeneratedRegex(RAddUnderscore3)] + private static partial Regex AddUnderscores3(); + + [GeneratedRegex(RAddDashes1)] + private static partial Regex AddDashes1(); + + [GeneratedRegex(RAddDashes2)] + private static partial Regex AddDashes2(); + + [GeneratedRegex(RAddDashes3)] + private static partial Regex AddDashes3(); + + [GeneratedRegex(RAddSpaces1)] + private static partial Regex AddSpaces1(); + + [GeneratedRegex(RAddSpaces2)] + private static partial Regex AddSpaces2(); + + [GeneratedRegex(RAddSpaces3)] + private static partial Regex AddSpaces3(); +#else + static Regex IsUpperCase() => new(RIsUpperCase); + + static Regex AddUnderscores1() => new(RAddUnderscore1); + + static Regex AddUnderscores2() => new(RAddUnderscore2); + + static Regex AddUnderscores3() => new(RAddUnderscore3); + + static Regex AddDashes1() => new(RAddDashes1); + + static Regex AddDashes2() => new(RAddDashes2); + + static Regex AddDashes3() => new(RAddDashes3); + + static Regex AddSpaces1() => new(RAddSpaces1); + + static Regex AddSpaces2() => new(RAddSpaces1); + + static Regex AddSpaces3() => new(RAddSpaces1); +#endif +} \ No newline at end of file diff --git a/src/RestSharp/Extensions/WithExtensions.cs b/src/RestSharp/Extensions/WithExtensions.cs new file mode 100644 index 000000000..50d15c889 --- /dev/null +++ b/src/RestSharp/Extensions/WithExtensions.cs @@ -0,0 +1,22 @@ +// Copyright (c) .NET Foundation and Contributors +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// http://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. + +namespace RestSharp.Extensions; + +static class WithExtensions { + internal static T With(this T self, Action @do) { + @do(self); + return self; + } +} \ No newline at end of file diff --git a/src/RestSharp/IRestClient.cs b/src/RestSharp/IRestClient.cs new file mode 100644 index 000000000..3f37b536d --- /dev/null +++ b/src/RestSharp/IRestClient.cs @@ -0,0 +1,50 @@ +// Copyright (c) .NET Foundation and Contributors +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// http://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. +// + +using RestSharp.Serializers; + +namespace RestSharp; + +public interface IRestClient : IDisposable { + /// + /// Client options that aren't used for configuring HttpClient + /// + ReadOnlyRestClientOptions Options { get; } + + /// + /// Client-level serializers + /// + RestSerializers Serializers { get; } + + /// + /// Default parameters to use on every request made with this client instance. + /// + DefaultParameters DefaultParameters { get; } + + /// + /// Executes the request asynchronously, authenticating if needed + /// + /// Request to be executed + /// Cancellation token + Task ExecuteAsync(RestRequest request, CancellationToken cancellationToken = default); + + /// + /// A specialized method to download files as streams. + /// + /// Pre-configured request instance. + /// + /// The downloaded stream. + Task DownloadStreamAsync(RestRequest request, CancellationToken cancellationToken = default); +} diff --git a/src/RestSharp/Interceptors/CompatibilityInterceptor.cs b/src/RestSharp/Interceptors/CompatibilityInterceptor.cs new file mode 100644 index 000000000..34ac4354c --- /dev/null +++ b/src/RestSharp/Interceptors/CompatibilityInterceptor.cs @@ -0,0 +1,43 @@ +// Copyright (c) .NET Foundation and Contributors +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// http://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. + +// ReSharper disable UnusedAutoPropertyAccessor.Global +namespace RestSharp.Interceptors; + +/// +/// This class allows easier migration of legacy request hooks to interceptors. +/// +public class CompatibilityInterceptor : Interceptor { + public Action? OnBeforeDeserialization { get; set; } + public Func? OnBeforeRequest { get; set; } + public Func? OnAfterRequest { get; set; } + + /// + public override ValueTask BeforeDeserialization(RestResponse response, CancellationToken cancellationToken) { + OnBeforeDeserialization?.Invoke(response); + return default; + } + + public override async ValueTask BeforeHttpRequest(HttpRequestMessage requestMessage, CancellationToken cancellationToken) { + if (OnBeforeRequest != null) { + await OnBeforeRequest(requestMessage); + } + } + + public override async ValueTask AfterHttpRequest(HttpResponseMessage responseMessage, CancellationToken cancellationToken) { + if (OnAfterRequest != null) { + await OnAfterRequest(responseMessage); + } + } +} \ No newline at end of file diff --git a/src/RestSharp/Interceptors/Interceptor.cs b/src/RestSharp/Interceptors/Interceptor.cs new file mode 100644 index 000000000..ddd765f52 --- /dev/null +++ b/src/RestSharp/Interceptors/Interceptor.cs @@ -0,0 +1,62 @@ +// Copyright (c) .NET Foundation and Contributors +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// http://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. +// + +namespace RestSharp.Interceptors; + +/// +/// Base Interceptor +/// +public abstract class Interceptor { + static readonly ValueTask Completed = +#if NET + ValueTask.CompletedTask; +#else + new (); +#endif + /// + /// Intercepts the request before composing the request message + /// + /// RestRequest before composing the request message + /// Cancellation token + public virtual ValueTask BeforeRequest(RestRequest request, CancellationToken cancellationToken) => Completed; + + /// + /// Intercepts the request before being sent + /// + /// HttpRequestMessage before being sent + /// Cancellation token + public virtual ValueTask BeforeHttpRequest(HttpRequestMessage requestMessage, CancellationToken cancellationToken) => Completed; + + /// + /// Intercepts the request before being sent + /// + /// HttpResponseMessage as received from the remote server + /// Cancellation token + public virtual ValueTask AfterHttpRequest(HttpResponseMessage responseMessage, CancellationToken cancellationToken) => Completed; + + /// + /// Intercepts the request after it's created from HttpResponseMessage + /// + /// HttpResponseMessage as received from the remote server + /// Cancellation token + public virtual ValueTask AfterRequest(RestResponse response, CancellationToken cancellationToken) => Completed; + + /// + /// Intercepts the request before deserialization, won't be called if using non-generic ExecuteAsync + /// + /// HttpResponseMessage as received from the remote server + /// Cancellation token + public virtual ValueTask BeforeDeserialization(RestResponse response, CancellationToken cancellationToken) => Completed; +} diff --git a/src/RestSharp/KnownHeaders.cs b/src/RestSharp/KnownHeaders.cs new file mode 100644 index 000000000..edf9d47bb --- /dev/null +++ b/src/RestSharp/KnownHeaders.cs @@ -0,0 +1,50 @@ +// Copyright (c) .NET Foundation and Contributors +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// http://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. +// + +// ReSharper disable InconsistentNaming +// ReSharper disable MemberCanBePrivate.Global + +namespace RestSharp; + +public static class KnownHeaders { + public const string Authorization = "Authorization"; + public const string Accept = "Accept"; + public const string AcceptLanguage = "Accept-Language"; + public const string Allow = "Allow"; + public const string Expires = "Expires"; + public const string ContentDisposition = "Content-Disposition"; + public const string ContentEncoding = "Content-Encoding"; + public const string ContentLanguage = "Content-Language"; + public const string ContentLength = "Content-Length"; + public const string ContentLocation = "Content-Location"; + public const string ContentRange = "Content-Range"; + public const string ContentType = "Content-Type"; + public const string KeepAlive = "Keep-Alive"; + public const string LastModified = "Last-Modified"; + public const string ContentMD5 = "Content-MD5"; + public const string Host = "Host"; + public const string Cookie = "Cookie"; + public const string SetCookie = "Set-Cookie"; + public const string UserAgent = "User-Agent"; + + internal static readonly string[] ContentHeaders = [ + Allow, Expires, ContentDisposition, ContentEncoding, ContentLanguage, ContentLength, ContentLocation, ContentRange, ContentType, ContentMD5, + LastModified + ]; + + static readonly HashSet ContentHeadersHash = new(ContentHeaders, StringComparer.InvariantCultureIgnoreCase); + + internal static bool IsContentHeader(string key) => ContentHeadersHash.Contains(key); +} \ No newline at end of file diff --git a/src/RestSharp/Options/ReadOnlyRestClientOptions.cs b/src/RestSharp/Options/ReadOnlyRestClientOptions.cs new file mode 100644 index 000000000..9ba2331d2 --- /dev/null +++ b/src/RestSharp/Options/ReadOnlyRestClientOptions.cs @@ -0,0 +1,32 @@ +// Copyright (c) .NET Foundation and Contributors +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// http://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. +// + +using System.Collections.ObjectModel; +using RestSharp.Interceptors; + +namespace RestSharp; + +public partial class ReadOnlyRestClientOptions { + public IReadOnlyCollection? Interceptors { get; private set; } + + partial void CopyAdditionalProperties(RestClientOptions inner) => Interceptors = GetInterceptors(inner); + + static ReadOnlyCollection? GetInterceptors(RestClientOptions? options) { + if (options == null || options.Interceptors.Count == 0) return null; + + var interceptors = new List(options.Interceptors); + return interceptors.AsReadOnly(); + } +} diff --git a/src/RestSharp/Options/RedirectOptions.cs b/src/RestSharp/Options/RedirectOptions.cs new file mode 100644 index 000000000..baaafdb86 --- /dev/null +++ b/src/RestSharp/Options/RedirectOptions.cs @@ -0,0 +1,83 @@ +// Copyright (c) .NET Foundation and Contributors +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// http://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. +// + +namespace RestSharp; + +/// +/// Options for controlling redirect behavior when RestSharp handles redirects. +/// +public class RedirectOptions { + /// + /// Whether to follow redirects. Default is true. + /// + public bool FollowRedirects { get; set; } = true; + + /// + /// Whether to follow redirects from HTTPS to HTTP (insecure). Default is false. + /// + public bool FollowRedirectsToInsecure { get; set; } + + /// + /// Whether to forward request headers on redirect. Default is true. + /// + public bool ForwardHeaders { get; set; } = true; + + /// + /// Whether to forward the Authorization header on same-host redirects. Default is false. + /// Even when enabled, Authorization is stripped on cross-host redirects unless + /// is also set to true. + /// + public bool ForwardAuthorization { get; set; } + + /// + /// Whether to forward the Authorization header when redirecting to a different host. Default is false. + /// Only applies when is true. Enabling this can expose credentials + /// to unintended hosts if a redirect points to a third-party server. + /// + public bool ForwardAuthorizationToExternalHost { get; set; } + + /// + /// Whether to forward cookies on redirect. Default is true. + /// Cookies from Set-Cookie headers are always stored in the CookieContainer regardless of this setting. + /// + public bool ForwardCookies { get; set; } = true; + + /// + /// Whether to forward the request body on redirect when the HTTP verb is preserved. Default is true. + /// Body is always dropped when the verb changes to GET. + /// + public bool ForwardBody { get; set; } = true; + + /// + /// Whether to forward original query string parameters on redirect. Default is true. + /// + public bool ForwardQuery { get; set; } = true; + + /// + /// Maximum number of redirects to follow. Default is 50. + /// + public int MaxRedirects { get; set; } = 50; + + /// + /// HTTP status codes that are considered redirects. + /// + public IReadOnlyList RedirectStatusCodes { get; set; } = [ + HttpStatusCode.MovedPermanently, // 301 + HttpStatusCode.Found, // 302 + HttpStatusCode.SeeOther, // 303 + HttpStatusCode.TemporaryRedirect, // 307 + (HttpStatusCode)308, // 308 Permanent Redirect + ]; +} diff --git a/src/RestSharp/Options/RestClientOptions.cs b/src/RestSharp/Options/RestClientOptions.cs new file mode 100644 index 000000000..5cd8b09a2 --- /dev/null +++ b/src/RestSharp/Options/RestClientOptions.cs @@ -0,0 +1,258 @@ +// Copyright (c) .NET Foundation and Contributors +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// http://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. +// + +using System.Net.Http.Headers; +using System.Net.Security; +using System.Reflection; +#if NET +using System.Runtime.Versioning; +#endif +using System.Security.Cryptography.X509Certificates; +using System.Text; +using RestSharp.Authenticators; +using RestSharp.Extensions; +using RestSharp.Interceptors; + +// ReSharper disable UnusedAutoPropertyAccessor.Global +// ReSharper disable PropertyCanBeMadeInitOnly.Global +// ReSharper disable AutoPropertyCanBeMadeGetOnly.Global + +namespace RestSharp; + +[GenerateImmutable] +[GenerateClone(BaseType = typeof(RestClientOptions), Name = "CopyFrom", Mutate = true)] +public partial class RestClientOptions { + static readonly Version Version = new AssemblyName(typeof(RestClientOptions).Assembly.FullName!).Version!; + + static readonly string DefaultUserAgent = $"RestSharp/{Version}"; + + public RestClientOptions() { } + + // ReSharper disable once MemberCanBePrivate.Global + public RestClientOptions(Uri baseUrl) => BaseUrl = baseUrl; + + public RestClientOptions(string baseUrl) : this(new Uri(Ensure.NotEmptyString(baseUrl, nameof(baseUrl)))) { } + + /// + /// Base URL for all requests made with this client instance + /// + public Uri? BaseUrl { get; set; } + + /// + /// Custom configuration for the underlying + /// + public Func? ConfigureMessageHandler { get; set; } + + /// + /// Function to calculate the response status. By default, the status will be Completed if it was successful, or NotFound. + /// + public CalculateResponseStatus CalculateResponseStatus { get; set; } = httpResponse + => httpResponse.IsSuccessStatusCode || httpResponse.StatusCode == HttpStatusCode.NotFound + ? ResponseStatus.Completed + : ResponseStatus.Error; + + /// + /// Authenticator that will be used to populate request with necessary authentication data + /// + public IAuthenticator? Authenticator { get; set; } + + /// + /// List of interceptors that will be executed before the request is sent + /// + [Exclude] + public List Interceptors { get; set; } = []; + + /// + /// Passed to Credentials property + /// +#if NET + [UnsupportedOSPlatform("browser")] +#endif + public ICredentials? Credentials { get; set; } + + /// + /// Determine whether the "default credentials" (e.g. the user account under which the current process is + /// running) will be sent along to the server. The default is false. + /// Passed to UseDefaultCredentials property + /// +#if NET + [UnsupportedOSPlatform("browser")] +#endif + public bool UseDefaultCredentials { get; set; } + + /// + /// Set to true if you need the Content-Type not to have the charset + /// + public bool DisableCharset { get; set; } + + /// + /// Set the decompression method to use when making requests + /// +#if NET + [UnsupportedOSPlatform("browser")] + public DecompressionMethods AutomaticDecompression { get; set; } = DecompressionMethods.All; +#else + public DecompressionMethods AutomaticDecompression { get; set; } = DecompressionMethods.GZip; +#endif + + /// + /// Set the maximum number of redirects to follow. + /// This is a convenience property that delegates to .MaxRedirects. + /// +#if NET + [UnsupportedOSPlatform("browser")] +#endif + [Exclude] + public int? MaxRedirects { + get => RedirectOptions.MaxRedirects; + set { + if (value.HasValue) RedirectOptions.MaxRedirects = value.Value; + } + } + + /// + /// X509CertificateCollection to be sent with request + /// +#if NET + [UnsupportedOSPlatform("browser")] +#endif + [Exclude] + public X509CertificateCollection? ClientCertificates { get; set; } + + /// + /// Set the proxy to use when making requests. Default is null, which will use the default system proxy if one is set. + /// +#if NET + [UnsupportedOSPlatform("browser")] + [UnsupportedOSPlatform("ios")] + [UnsupportedOSPlatform("tvos")] +#endif + public IWebProxy? Proxy { get; set; } + + /// + /// Cache policy to be used for requests using + /// + public CacheControlHeaderValue? CachePolicy { get; set; } + + /// + /// Instruct the client to follow redirects. Default is true. + /// This is a convenience property that delegates to .FollowRedirects. + /// + [Exclude] + public bool FollowRedirects { + get => RedirectOptions.FollowRedirects; + set => RedirectOptions.FollowRedirects = value; + } + + /// + /// Options for controlling redirect behavior. + /// + public RedirectOptions RedirectOptions { get; set; } = new(); + + /// + /// Gets or sets a value that indicates if the header for an HTTP request contains Continue. + /// + public bool? Expect100Continue { get; set; } = null; + + /// + /// Value of the User-Agent header to be sent with requests. Default is "RestSharp/{version}" + /// + public string? UserAgent { get; set; } = DefaultUserAgent; + + /// + /// Passed to property + /// +#if NET + [UnsupportedOSPlatform("browser")] +#endif + public bool PreAuthenticate { get; set; } + + /// + /// Callback function for handling the validation of remote certificates. Useful for certificate pinning and + /// overriding certificate errors in the scope of a request. + /// +#if NET + [UnsupportedOSPlatform("browser")] +#endif + public RemoteCertificateValidationCallback? RemoteCertificateValidationCallback { get; set; } + + /// + /// Sets the value of the Host header to be sent with requests. + /// + public string? BaseHost { get; set; } + + /// + /// Custom cookie container to be used for requests. RestSharp will not assign the container to the message handler, + /// but will fetch cookies from it and set them on the request. + /// + public CookieContainer? CookieContainer { get; set; } + + /// + /// Request timeout duration. Used when the request timeout is not specified using . + /// If not set, the default timeout is 100 seconds. + /// + /// + /// + /// Set to (or TimeSpan.FromMilliseconds(-1)) for no timeout + /// Set to to cancel the request immediately + /// Negative values (other than -1 millisecond) will throw + /// + /// + public TimeSpan? Timeout { get; set; } + + /// + /// Default encoding to use when no encoding is specified in the content type header. + /// + public Encoding Encoding { get; set; } = Encoding.UTF8; + + /// + /// Set to true to throw an exception when a deserialization error occurs. Default is false. + /// + public bool ThrowOnDeserializationError { get; set; } + + /// + /// When set to true, the response status will be set to + /// when a deserialization error occurs. Default is true. + /// + public bool FailOnDeserializationError { get; set; } = true; + + /// + /// Set to true to throw an exception when throws an exception when making a request. + /// Default is false. + /// + public bool ThrowOnAnyError { get; set; } + + /// + /// When set to false, the client doesn't set the `ErrorException` property for responses with unsuccessful status codes. + /// Default is true. + /// + public bool SetErrorExceptionOnUnsuccessfulStatusCode { get; set; } = true; + + /// + /// Set to true to allow multiple default parameters with the same name. Default is false. + /// This setting doesn't apply to headers as multiple header values for the same key is allowed. + /// + public bool AllowMultipleDefaultParametersWithSameName { get; set; } + + /// + /// Custom function to encode a string for use in a URL. + /// + public Func Encode { get; set; } = s => s.UrlEncode(); + + /// + /// Custom function to encode a string for use in a URL query. + /// + public Func EncodeQuery { get; set; } = (s, encoding) => s.UrlEncode(encoding)!; +} diff --git a/src/RestSharp/Parameters/BodyParameter.cs b/src/RestSharp/Parameters/BodyParameter.cs new file mode 100644 index 000000000..09948880d --- /dev/null +++ b/src/RestSharp/Parameters/BodyParameter.cs @@ -0,0 +1,62 @@ +// Copyright (c) .NET Foundation and Contributors +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// http://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. +// + +namespace RestSharp; + +public record BodyParameter : Parameter { + public BodyParameter(string? name, object value, ContentType contentType, DataFormat dataFormat = DataFormat.None) + : base(name, Ensure.NotNull(value, nameof(value)), ParameterType.RequestBody, false) { + if (dataFormat == DataFormat.Binary && value is not byte[]) { + throw new ArgumentException("Binary data format needs a byte array as value"); + } + + ContentType = contentType; + DataFormat = dataFormat; + } + + public BodyParameter(object value, ContentType contentType, DataFormat dataFormat = DataFormat.None) + : this("", value, contentType, dataFormat) { } + + /// + /// Body parameter data type + /// + public DataFormat DataFormat { get; init; } = DataFormat.None; + + /// + /// Custom content encoding + /// + public string? ContentEncoding { get; init; } +} + +public record XmlParameter : BodyParameter { + [PublicAPI] + public XmlParameter(string name, object value, string? xmlNamespace = null, ContentType? contentType = null) + : base(name, value, contentType ?? ContentType.Xml, DataFormat.Xml) + => XmlNamespace = xmlNamespace; + + public XmlParameter(object value, string? xmlNamespace = null, ContentType? contentType = null) + : this("", value, xmlNamespace, contentType) { } + + public string? XmlNamespace { get; } +} + +public record JsonParameter : BodyParameter { + [PublicAPI] + public JsonParameter(string name, object value, ContentType? contentType = null) + : base(name, value, contentType ?? ContentType.Json, DataFormat.Json) { } + + public JsonParameter(object value, ContentType? contentType = null) + : this("", value, contentType) { } +} diff --git a/src/RestSharp/Parameters/DefaultParameters.cs b/src/RestSharp/Parameters/DefaultParameters.cs new file mode 100644 index 000000000..a65b41846 --- /dev/null +++ b/src/RestSharp/Parameters/DefaultParameters.cs @@ -0,0 +1,72 @@ +// Copyright (c) .NET Foundation and Contributors +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// http://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. +// + +using System.Runtime.CompilerServices; + +namespace RestSharp; + +public sealed class DefaultParameters(ReadOnlyRestClientOptions options) : ParametersCollection { + /// + /// Safely add a default parameter to the collection. + /// + /// Parameter to add + /// + /// + /// + [MethodImpl(MethodImplOptions.Synchronized)] + public DefaultParameters AddParameter(Parameter parameter) { + if (parameter.Type == ParameterType.RequestBody) + throw new NotSupportedException("Cannot set request body using default parameters. Use Request.AddBody() instead."); + + if (!options.AllowMultipleDefaultParametersWithSameName && + parameter.Type != ParameterType.HttpHeader && + !MultiParameterTypes.Contains(parameter.Type) && + this.Any(x => x.Name == parameter.Name)) { + throw new ArgumentException("A default parameters with the same name has already been added", nameof(parameter)); + } + + Parameters.Add(parameter); + + return this; + } + + /// + /// Safely removes all the default parameters with the given name and type. + /// + /// Parameter name + /// Parameter type + /// + [PublicAPI] + [MethodImpl(MethodImplOptions.Synchronized)] + public DefaultParameters RemoveParameter(string name, ParameterType type) { + Parameters.RemoveAll(x => x.Name == name && x.Type == type); + + return this; + } + + /// + /// Replace a default parameter with the same name and type. + /// + /// Parameter instance + /// + [PublicAPI] + public DefaultParameters ReplaceParameter(Parameter parameter) + => + // ReSharper disable once NotResolvedInText + RemoveParameter(Ensure.NotEmptyString(parameter.Name, "Parameter name"), parameter.Type) + .AddParameter(parameter); + + static readonly ParameterType[] MultiParameterTypes = [ParameterType.QueryString, ParameterType.GetOrPost]; +} \ No newline at end of file diff --git a/src/RestSharp/Parameters/FileParameter.cs b/src/RestSharp/Parameters/FileParameter.cs new file mode 100644 index 000000000..d490d9fd3 --- /dev/null +++ b/src/RestSharp/Parameters/FileParameter.cs @@ -0,0 +1,118 @@ +// Copyright (c) .NET Foundation and Contributors +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// http://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. + +namespace RestSharp; + +/// +/// Container for files to be uploaded with requests +/// +[PublicAPI] +public record FileParameter { + /// + /// Name of the parameter + /// + public string Name { get; } + + /// + /// Name of the file to use when uploading + /// + public string FileName { get; } + + /// + /// MIME content type of file + /// + public ContentType ContentType { get; } + + /// + /// Provides raw data for file + /// + public Func GetFile { get; } + + public FileParameterOptions Options { get; } + + FileParameter(string name, string fileName, Func getFile, ContentType? contentType, FileParameterOptions options) { + Name = name; + FileName = fileName; + GetFile = getFile; + Options = options; + ContentType = contentType ?? ContentType.Binary; + } + + /// + /// Creates a file parameter from an array of bytes. + /// + /// The parameter name to use in the request. + /// The data to use as the file's contents. + /// The filename to use in the request. + /// The content type to use in the request. + /// File parameter options + /// The + public static FileParameter Create( + string name, + byte[] data, + string filename, + ContentType? contentType = null, + FileParameterOptions? options = null + ) { + return new(name, filename, GetFile, contentType, options ?? new FileParameterOptions()); + + Stream GetFile() { + var stream = new MemoryStream(); + stream.Write(data, 0, data.Length); + stream.Flush(); + stream.Seek(0, SeekOrigin.Begin); + return stream; + } + } + + /// + /// Creates a file parameter from an array of bytes. + /// + /// The parameter name to use in the request. + /// Delegate that will be called with the request stream so you can write to it.. + /// The filename to use in the request. + /// Optional: parameter content type, default is "application/g-zip" + /// File parameter options + /// The using the default content type. + public static FileParameter Create( + string name, + Func getFile, + string fileName, + ContentType? contentType = null, + FileParameterOptions? options = null + ) + => new(name, fileName, getFile, contentType, options ?? new FileParameterOptions()); + + public static FileParameter FromFile( + string fullPath, + string? name = null, + ContentType? contentType = null, + FileParameterOptions? options = null + ) { + if (!File.Exists(Ensure.NotEmptyString(fullPath, nameof(fullPath)))) throw new FileNotFoundException("File not found", fullPath); + + var fileName = Path.GetFileName(fullPath); + var parameterName = name ?? fileName; + + return new(parameterName, fileName, GetFile, contentType, options ?? new FileParameterOptions()); + + Stream GetFile() => File.OpenRead(fullPath); + } +} + +[PublicAPI] +public class FileParameterOptions { + public bool DisableFilenameStar { get; set; } = true; + public bool DisableFilenameEncoding { get; set; } +} diff --git a/src/RestSharp/Parameters/GetOrPostParameter.cs b/src/RestSharp/Parameters/GetOrPostParameter.cs new file mode 100644 index 000000000..b9309475e --- /dev/null +++ b/src/RestSharp/Parameters/GetOrPostParameter.cs @@ -0,0 +1,25 @@ +// Copyright (c) .NET Foundation and Contributors +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// http://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. + +namespace RestSharp; + +public record GetOrPostParameter : NamedParameter { + /// + /// Instantiates an HTTP parameter instance (QueryString for GET, DELETE, OPTIONS and HEAD; Encoded form for POST and PUT) + /// + /// Name of the parameter + /// Value of the parameter + /// Encode the value or not, default true + public GetOrPostParameter(string name, string? value, bool encode = true) : base(name, value, ParameterType.GetOrPost, encode) { } +} \ No newline at end of file diff --git a/src/RestSharp/Parameters/HeaderParameter.cs b/src/RestSharp/Parameters/HeaderParameter.cs new file mode 100644 index 000000000..76fc0b75a --- /dev/null +++ b/src/RestSharp/Parameters/HeaderParameter.cs @@ -0,0 +1,82 @@ +// Copyright (c) .NET Foundation and Contributors +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// http://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. +// + +using System.Text; +using System.Text.RegularExpressions; + +namespace RestSharp; + +public partial record HeaderParameter : Parameter { + /// + /// Instantiates a header parameter + /// + /// Header name + /// Header value + /// Set to true to encode header value according to RFC 2047. Default is false. + public HeaderParameter(string name, string value, bool encode = false) + : base( + EnsureValidHeaderString(Ensure.NotEmptyString(name, nameof(name)), "name"), + EnsureValidHeaderValue(name, value, encode), + ParameterType.HttpHeader, + false + ) { } + + public new string Name => base.Name!; + public new string Value => (string)base.Value!; + + static string EnsureValidHeaderValue(string name, string value, bool encode) { + CheckAndThrowsForInvalidHost(name, value); + + return EnsureValidHeaderString(GetValue(Ensure.NotNull(value, nameof(value)), encode), "value"); + } + + static string EnsureValidHeaderString(string value, string type) + => !IsInvalidHeaderString(value) ? value : throw new ArgumentException($"Invalid character found in header {type}: {value}"); + + static string GetValue(string value, bool encode) => encode ? GetBase64EncodedHeaderValue(value) : value; + + static string GetBase64EncodedHeaderValue(string value) => $"=?UTF-8?B?{Convert.ToBase64String(Encoding.UTF8.GetBytes(value))}?="; + + static bool IsInvalidHeaderString(string stringValue) { + // ReSharper disable once ForCanBeConvertedToForeach + for (var i = 0; i < stringValue.Length; i++) { + switch (stringValue[i]) { + case '\r': + case '\n': + return true; + } + } + + return false; + } + + static readonly Regex PortSplitRegex = PartSplit(); + + static void CheckAndThrowsForInvalidHost(string name, string value) { + if (name == KnownHeaders.Host && InvalidHost(value)) + throw new ArgumentException("The specified value is not a valid Host header string.", nameof(value)); + + return; + + static bool InvalidHost(string host) => Uri.CheckHostName(PortSplitRegex.Split(host)[0]) == UriHostNameType.Unknown; + } + +#if NET7_0_OR_GREATER + [GeneratedRegex(@":\d+")] + private static partial Regex PartSplit(); +#else + static Regex PartSplit() => new(@":\d+"); +#endif +} \ No newline at end of file diff --git a/src/RestSharp/Parameters/ObjectParser.cs b/src/RestSharp/Parameters/ObjectParser.cs new file mode 100644 index 000000000..c9cebcc02 --- /dev/null +++ b/src/RestSharp/Parameters/ObjectParser.cs @@ -0,0 +1,92 @@ +// Copyright (c) .NET Foundation and Contributors +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// http://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. +// + +using System.Reflection; + +using System.Globalization; +using RestSharp.Extensions; + +namespace RestSharp; + +static class ObjectParser { + public static IEnumerable GetProperties(this object obj, params string[] includedProperties) { + // automatically create parameters from object props + var type = obj.GetType(); + var props = type.GetProperties(); + + var properties = new List(); + + foreach (var prop in props.Where(x => IsAllowedProperty(x.Name))) { + var val = prop.GetValue(obj, null); + + if (val == null) continue; + + if (prop.PropertyType.IsArray) + properties.AddRange(GetArray(prop, val)); + else + properties.Add(GetValue(prop, val)); + } + + return properties; + + ParsedParameter GetValue(PropertyInfo propertyInfo, object? value) { + var attribute = propertyInfo.GetCustomAttribute(); + var name = attribute?.Name ?? propertyInfo.Name; + var val = ParseValue(attribute?.Format, value); + return new(name, val, attribute?.Encode ?? true); + } + + IEnumerable GetArray(PropertyInfo propertyInfo, object? value) { + var elementType = propertyInfo.PropertyType.GetElementType(); + var array = (Array)value!; + + var attribute = propertyInfo.GetCustomAttribute(); + var name = attribute?.Name ?? propertyInfo.Name; + var queryType = attribute?.ArrayQueryType ?? RequestArrayQueryType.CommaSeparated; + var encode = attribute?.Encode ?? true; + + if (array.Length <= 0 || elementType == null) return [new(name, null, encode)]; + + // convert the array to an array of strings + var values = array + .Cast() + .Select(item => ParseValue(attribute?.Format, item)); + + return queryType switch { + RequestArrayQueryType.CommaSeparated => [new(name, string.Join(",", values), encode)], + RequestArrayQueryType.ArrayParameters => values.Select(x => new ParsedParameter($"{name}[]", x, encode)), + _ => throw new ArgumentOutOfRangeException() + }; + + } + + bool IsAllowedProperty(string propertyName) + => includedProperties.Length == 0 || includedProperties.Length > 0 && includedProperties.Contains(propertyName); + + string? ParseValue(string? format, object? value) => format == null ? value.ToStringValue() : string.Format(CultureInfo.InvariantCulture, $"{{0:{format}}}", value); + } +} + +record ParsedParameter(string Name, string? Value, bool Encode); + +[AttributeUsage(AttributeTargets.Property)] +public class RequestPropertyAttribute : Attribute { + public string? Name { get; set; } + public string? Format { get; set; } + public RequestArrayQueryType ArrayQueryType { get; set; } = RequestArrayQueryType.CommaSeparated; + public bool Encode { get; set; } = true; +} + +public enum RequestArrayQueryType { CommaSeparated, ArrayParameters } diff --git a/src/RestSharp/Parameters/Parameter.cs b/src/RestSharp/Parameters/Parameter.cs new file mode 100644 index 000000000..ebe4cf590 --- /dev/null +++ b/src/RestSharp/Parameters/Parameter.cs @@ -0,0 +1,106 @@ +// Copyright (c) .NET Foundation and Contributors +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// http://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. + +using System.Diagnostics; +using RestSharp.Extensions; + +namespace RestSharp; + +/// +/// Parameter container for REST requests +/// +[DebuggerDisplay($"{{{nameof(DebuggerDisplay)}()}}")] +public abstract record Parameter { + /// + /// Parameter container for REST requests + /// + protected Parameter(string? name, object? value, ParameterType type, bool encode) { + Name = name; + Value = value; + Type = type; + Encode = encode; + } + + /// + /// Content type of the parameter. Normally applies to the body parameter, or POST parameter in multipart requests. + /// + public ContentType ContentType { get; set; } = ContentType.Undefined; + + /// + /// Parameter name + /// + public string? Name { get; } + + /// + /// Parameter value + /// + public object? Value { get; } + + /// + /// Parameter type + /// + public ParameterType Type { get; } + + /// + /// Indicates if the parameter value should be encoded or not. + /// + public bool Encode { get; } + + /// + /// Return a human-readable representation of this parameter + /// + /// String + public sealed override string ToString() => Value == null ? $"{Name}" : $"{Name}={ValueString}"; + + protected virtual string ValueString => Value?.ToString() ?? "null"; + + /// + /// Creates a parameter object of based on the type + /// + /// Parameter name + /// Parameter value + /// Parameter type + /// Indicates if the parameter value should be encoded + /// + /// + public static Parameter CreateParameter(string? name, object? value, ParameterType type, bool encode = true) + // ReSharper disable once SwitchExpressionHandlesSomeKnownEnumValuesWithExceptionInDefault + => type switch { + ParameterType.GetOrPost => new GetOrPostParameter(Ensure.NotEmptyString(name, nameof(name)), value.ToStringValue(), encode), + ParameterType.UrlSegment => new UrlSegmentParameter(Ensure.NotEmptyString(name, nameof(name)), value.ToStringValue()!, encode), + ParameterType.HttpHeader => new HeaderParameter(name!, value.ToStringValue()!), + ParameterType.QueryString => new QueryParameter(Ensure.NotEmptyString(name, nameof(name)), value.ToStringValue(), encode), + _ => throw new ArgumentOutOfRangeException(nameof(type), type, null) + }; + + [PublicAPI] + public void Deconstruct(out string? name, out object? value, out ParameterType type, out bool encode) { + name = Name; + value = Value; + type = Type; + encode = Encode; + } + + /// + /// Assists with debugging by displaying in the debugger output + /// + /// + [UsedImplicitly] + protected string DebuggerDisplay() => $"{GetType().Name.Replace("Parameter", "")} {ToString()}"; +} + +public record NamedParameter : Parameter { + protected NamedParameter(string name, object? value, ParameterType type, bool encode = true) + : base(Ensure.NotEmptyString(name, nameof(name)), value, type, encode) { } +} \ No newline at end of file diff --git a/src/RestSharp/Parameters/ParametersCollection.cs b/src/RestSharp/Parameters/ParametersCollection.cs new file mode 100644 index 000000000..299f2d498 --- /dev/null +++ b/src/RestSharp/Parameters/ParametersCollection.cs @@ -0,0 +1,43 @@ +// Copyright (c) .NET Foundation and Contributors +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// http://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. +// + +using System.Collections; + +namespace RestSharp; + +public abstract class ParametersCollection : IReadOnlyCollection where T : Parameter { + protected readonly List Parameters = []; + + // public ParametersCollection(IEnumerable parameters) => _parameters.AddRange(parameters); + + static readonly Func SearchPredicate = (p, name) + => p.Name != null && p.Name.Equals(name, StringComparison.InvariantCultureIgnoreCase); + + public bool Exists(T parameter) => Parameters.Any(p => SearchPredicate(p, parameter.Name) && p.Type == parameter.Type); + + public T? TryFind(string parameterName) => Parameters.FirstOrDefault(x => SearchPredicate(x, parameterName)); + + public IEnumerable GetParameters() where TParameter : class, T => Parameters.OfType(); + + public IEnumerator GetEnumerator() => Parameters.GetEnumerator(); + + IEnumerator IEnumerable.GetEnumerator() => GetEnumerator(); + + public int Count => Parameters.Count; +} + +public abstract class ParametersCollection : ParametersCollection { + public IEnumerable GetParameters(ParameterType parameterType) => Parameters.Where(x => x.Type == parameterType); +} \ No newline at end of file diff --git a/src/RestSharp/Parameters/ParametersCollectionExtensions.cs b/src/RestSharp/Parameters/ParametersCollectionExtensions.cs new file mode 100644 index 000000000..7be33e8b9 --- /dev/null +++ b/src/RestSharp/Parameters/ParametersCollectionExtensions.cs @@ -0,0 +1,34 @@ +// Copyright (c) .NET Foundation and Contributors +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// http://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. +// + +namespace RestSharp; + +static class ParametersCollectionExtensions { + extension(ParametersCollection parameters) { + internal IEnumerable GetQueryParameters(Method method) { + Func condition = + !IsPost(method) + ? p => p.Type is ParameterType.GetOrPost or ParameterType.QueryString + : p => p.Type is ParameterType.QueryString; + + return parameters.Where(p => condition(p)); + } + + internal IEnumerable GetContentParameters(Method method) + => IsPost(method) ? parameters.GetParameters() : []; + } + + static bool IsPost(Method method) => method is Method.Post or Method.Put or Method.Patch; +} diff --git a/src/RestSharp/Parameters/QueryParameter.cs b/src/RestSharp/Parameters/QueryParameter.cs new file mode 100644 index 000000000..57623d76c --- /dev/null +++ b/src/RestSharp/Parameters/QueryParameter.cs @@ -0,0 +1,26 @@ +// Copyright (c) .NET Foundation and Contributors +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// http://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. +// + +namespace RestSharp; + +public record QueryParameter : NamedParameter { + /// + /// Instantiates a new query parameter instance that will be added to the request URL as {name}={value} part of the query string. + /// + /// Parameter name + /// Parameter value + /// Optional: encode the value, default is true + public QueryParameter(string name, string? value, bool encode = true) : base(name, value, ParameterType.QueryString, encode) { } +} \ No newline at end of file diff --git a/src/RestSharp/Parameters/RequestParameters.cs b/src/RestSharp/Parameters/RequestParameters.cs new file mode 100644 index 000000000..2d673f9bd --- /dev/null +++ b/src/RestSharp/Parameters/RequestParameters.cs @@ -0,0 +1,73 @@ +// Copyright (c) .NET Foundation and Contributors +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// http://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. +// + +namespace RestSharp; + +/// +/// Collection of request parameters +/// +public sealed class RequestParameters : ParametersCollection { + /// + /// Create an empty parameters collection + /// + public RequestParameters() { } + + /// + /// Creates a parameters collection from a collection of parameter objects + /// + /// Collection of existing parameters + public RequestParameters(IEnumerable parameters) => Parameters.AddRange(parameters); + + /// + /// Adds multiple parameters to the collection + /// + /// Parameters to add + /// + // ReSharper disable once UnusedMethodReturnValue.Global + public ParametersCollection AddParameters(IEnumerable parameters) { + Parameters.AddRange(parameters); + return this; + } + + /// + /// Add parameters from another parameter collection + /// + /// + /// + // ReSharper disable once UnusedMember.Global + public ParametersCollection AddParameters(ParametersCollection parameters) { + Parameters.AddRange(parameters); + return this; + } + + /// + /// Adds a single parameter to the collection + /// + /// Parameter to add + public void AddParameter(Parameter parameter) => Parameters.Add(parameter); + + /// + /// Remove one or more parameters from the collection by name + /// + /// Name of the parameter to remove + // ReSharper disable once UnusedMember.Global + public void RemoveParameter(string name) => Parameters.RemoveAll(x => x.Name == name); + + /// + /// Remove parameter from the collection by reference + /// + /// Parameter to remove + public void RemoveParameter(Parameter parameter) => Parameters.Remove(parameter); +} diff --git a/src/RestSharp/Parameters/UrlSegmentParameter.cs b/src/RestSharp/Parameters/UrlSegmentParameter.cs new file mode 100644 index 000000000..66a5f25b0 --- /dev/null +++ b/src/RestSharp/Parameters/UrlSegmentParameter.cs @@ -0,0 +1,45 @@ +// Copyright (c) .NET Foundation and Contributors +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// http://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. + +using System.Text.RegularExpressions; +using RestSharp.Extensions; + +namespace RestSharp; + +public partial record UrlSegmentParameter : NamedParameter { + static readonly Regex RegexPattern = Pattern(); + + /// + /// Instantiates a new query parameter instance that will be added to the request URL by replacing part of the absolute path. + /// The request resource should have a placeholder {name} that will be replaced with the parameter value when the request is made. + /// + /// Parameter name + /// Parameter value + /// Optional: encode the value, default is true + /// Optional: whether to replace all %2f and %2F in the parameter value with '/', default is true + public UrlSegmentParameter(string name, string? value, bool encode = true, bool replaceEncodedSlash = true) + : base( + name, + value.IsEmpty() ? string.Empty : replaceEncodedSlash ? RegexPattern.Replace(value, "/") : value, + ParameterType.UrlSegment, + encode + ) { } + +#if NET7_0_OR_GREATER + [GeneratedRegex("%2f", RegexOptions.IgnoreCase | RegexOptions.Compiled, "en-NO")] + private static partial Regex Pattern(); +#else + static Regex Pattern() => new("%2f", RegexOptions.IgnoreCase | RegexOptions.Compiled); +#endif +} \ No newline at end of file diff --git a/src/RestSharp/Polyfills/Index.cs b/src/RestSharp/Polyfills/Index.cs new file mode 100644 index 000000000..972b842e6 --- /dev/null +++ b/src/RestSharp/Polyfills/Index.cs @@ -0,0 +1,117 @@ +// Licensed to the .NET Foundation under one or more agreements. +// The .NET Foundation licenses this file to you under the MIT license. +// See the LICENSE file in the project root for more information. + +#if !NET +using System.Runtime.CompilerServices; + +// ReSharper disable once CheckNamespace +namespace System; + +/// Represent a type can be used to index a collection either from the start or the end. +/// +/// Index is used by the C# compiler to support the new index syntax +/// +/// int[] someArray = new int[5] { 1, 2, 3, 4, 5 } ; +/// int lastElement = someArray[^1]; // lastElement = 5 +/// +/// +readonly struct Index : IEquatable { + readonly int _value; + + /// Construct an Index using a value and indicating if the index is from the start or from the end. + /// The index value. it has to be zero or positive number. + /// Indicating if the index is from the start or from the end. + /// + /// If the Index constructed from the end, index value 1 means pointing at the last element and index value 0 means pointing at beyond last element. + /// + [MethodImpl(MethodImplOptions.AggressiveInlining)] + public Index(int value, bool fromEnd = false) { + if (value < 0) { + throw new ArgumentOutOfRangeException(nameof(value), "value must be non-negative"); + } + + if (fromEnd) + _value = ~value; + else + _value = value; + } + + // The following private constructors mainly created for perf reason to avoid the checks + Index(int value) => _value = value; + + /// Create an Index pointing at first element. + public static Index Start => new(0); + + /// Create an Index pointing at beyond last element. + public static Index End => new(~0); + + /// Create an Index from the start at the position indicated by the value. + /// The index value from the start. + [MethodImpl(MethodImplOptions.AggressiveInlining)] + public static Index FromStart(int value) => value < 0 ? throw new ArgumentOutOfRangeException(nameof(value), "value must be non-negative") : new Index(value); + + /// Create an Index from the end at the position indicated by the value. + /// The index value from the end. + [MethodImpl(MethodImplOptions.AggressiveInlining)] + public static Index FromEnd(int value) => value < 0 ? throw new ArgumentOutOfRangeException(nameof(value), "value must be non-negative") : new Index(~value); + + /// Returns the index value. + public int Value { + get { + if (_value < 0) + return ~_value; + else + return _value; + } + } + + /// Indicates whether the index is from the start or the end. + public bool IsFromEnd => _value < 0; + + /// Calculate the offset from the start using the giving collection length. + /// The length of the collection that the Index will be used with. length has to be a positive value + /// + /// For performance reason, we don't validate the input length parameter and the returned offset value against negative values. + /// we don't validate either the returned offset is greater than the input length. + /// It is expected Index will be used with collections which always have non negative length/count. If the returned offset is negative and + /// then used to index a collection will get out of range exception which will be same affect as the validation. + /// + [MethodImpl(MethodImplOptions.AggressiveInlining)] + public int GetOffset(int length) { + var offset = _value; + + if (IsFromEnd) { + // offset = length - (~value) + // offset = length + (~(~value) + 1) + // offset = length + value + 1 + + offset += length + 1; + } + + return offset; + } + + /// Indicates whether the current Index object is equal to another object of the same type. + /// An object to compare with this object + public override bool Equals(object? value) => value is Index && _value == ((Index)value)._value; + + /// Indicates whether the current Index object is equal to another Index object. + /// An object to compare with this object + public bool Equals(Index other) => _value == other._value; + + /// Returns the hash code for this instance. + public override int GetHashCode() => _value; + + /// Converts integer number to an Index. + public static implicit operator Index(int value) => FromStart(value); + + /// Converts the value of the current Index object to its equivalent string representation. + public override string ToString() { + if (IsFromEnd) + return "^" + ((uint)Value).ToString(); + + return ((uint)Value).ToString(); + } +} +#endif \ No newline at end of file diff --git a/src/RestSharp/Polyfills/Range.cs b/src/RestSharp/Polyfills/Range.cs new file mode 100644 index 000000000..49634660e --- /dev/null +++ b/src/RestSharp/Polyfills/Range.cs @@ -0,0 +1,81 @@ +// Licensed to the .NET Foundation under one or more agreements. +// The .NET Foundation licenses this file to you under the MIT license. +// See the LICENSE file in the project root for more information. + +#if !NET +using System.Runtime.CompilerServices; +#pragma warning disable CS3019 +// ReSharper disable once CheckNamespace +namespace System; + +/// Represent a range has start and end indexes. +/// +/// Range is used by the C# compiler to support the range syntax. +/// +/// int[] someArray = new int[5] { 1, 2, 3, 4, 5 }; +/// int[] subArray1 = someArray[0..2]; // { 1, 2 } +/// int[] subArray2 = someArray[1..^0]; // { 2, 3, 4, 5 } +/// +/// +readonly struct Range : IEquatable { + /// Represent the inclusive start index of the Range. + public Index Start { get; } + + /// Represent the exclusive end index of the Range. + public Index End { get; } + + /// Construct a Range object using the start and end indexes. + /// Represent the inclusive start index of the range. + /// Represent the exclusive end index of the range. + public Range(Index start, Index end) { + Start = start; + End = end; + } + + /// Indicates whether the current Range object is equal to another object of the same type. + /// An object to compare with this object + public override bool Equals(object? value) + => value is Range r && + r.Start.Equals(Start) && + r.End.Equals(End); + + /// Indicates whether the current Range object is equal to another Range object. + /// An object to compare with this object + public bool Equals(Range other) => other.Start.Equals(Start) && other.End.Equals(End); + + /// Returns the hash code for this instance. + public override int GetHashCode() => Start.GetHashCode() * 31 + End.GetHashCode(); + + /// Converts the value of the current Range object to its equivalent string representation. + public override string ToString() => $"{Start}..{End}"; + + /// Create a Range object starting from start index to the end of the collection. + public static Range StartAt(Index start) => new(start, Index.End); + + /// Create a Range object starting from first element in the collection to the end Index. + public static Range EndAt(Index end) => new(Index.Start, end); + + /// Create a Range object starting from first element to the end. + public static Range All => new(Index.Start, Index.End); + + /// Calculate the start offset and length of range object using a collection length. + /// The length of the collection that the range will be used with. length has to be a positive value. + /// + /// For performance reason, we don't validate the input length parameter against negative values. + /// It is expected Range will be used with collections which always have non negative length/count. + /// We validate the range is inside the length scope though. + /// + [MethodImpl(MethodImplOptions.AggressiveInlining)] + [CLSCompliant(false)] + public (int Offset, int Length) GetOffsetAndLength(int length) { + var start = Start.GetOffset(length); + var end = End.GetOffset(length); + + if ((uint)end > (uint)length || (uint)start > (uint)end) { + throw new ArgumentOutOfRangeException(nameof(length)); + } + + return (start, end - start); + } +} +#endif \ No newline at end of file diff --git a/src/RestSharp/Polyfills/Strings.cs b/src/RestSharp/Polyfills/Strings.cs new file mode 100644 index 000000000..d26fa2076 --- /dev/null +++ b/src/RestSharp/Polyfills/Strings.cs @@ -0,0 +1,22 @@ +// Copyright (c) .NET Foundation and Contributors +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// http://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. + +#if !NET +// ReSharper disable once CheckNamespace +namespace System; + +static class Strings { + public static string[] Split(this string str, char separator, StringSplitOptions options) => str.Split([separator], options); +} +#endif \ No newline at end of file diff --git a/src/RestSharp/Properties/AssemblyInfo.cs b/src/RestSharp/Properties/AssemblyInfo.cs new file mode 100644 index 000000000..27ad83bc7 --- /dev/null +++ b/src/RestSharp/Properties/AssemblyInfo.cs @@ -0,0 +1,22 @@ +using System.Runtime.CompilerServices; + +[assembly: + InternalsVisibleTo( + "RestSharp.Extensions.DependencyInjection, PublicKey=0024000004800000940000000602000000240000525341310004000001000100fda57af14a288d46e3efea89617037585c4de57159cd536ca6dff792ea1d6addc665f2fccb4285413d9d44db5a1be87cb82686db200d16325ed9c42c89cd4824d8cc447f7cee2ac000924c3bceeb1b7fcb5cc1a3901785964d48ce14172001084134f4dcd9973c3776713b595443b1064bb53e2eeb924969244d354e46495e9d" + ), + InternalsVisibleTo( + "RestSharp.InteractiveTests, PublicKey=0024000004800000940000000602000000240000525341310004000001000100fda57af14a288d46e3efea89617037585c4de57159cd536ca6dff792ea1d6addc665f2fccb4285413d9d44db5a1be87cb82686db200d16325ed9c42c89cd4824d8cc447f7cee2ac000924c3bceeb1b7fcb5cc1a3901785964d48ce14172001084134f4dcd9973c3776713b595443b1064bb53e2eeb924969244d354e46495e9d" + ), + InternalsVisibleTo( + "RestSharp.Tests.Integrated, PublicKey=0024000004800000940000000602000000240000525341310004000001000100fda57af14a288d46e3efea89617037585c4de57159cd536ca6dff792ea1d6addc665f2fccb4285413d9d44db5a1be87cb82686db200d16325ed9c42c89cd4824d8cc447f7cee2ac000924c3bceeb1b7fcb5cc1a3901785964d48ce14172001084134f4dcd9973c3776713b595443b1064bb53e2eeb924969244d354e46495e9d" + ), + InternalsVisibleTo( + "RestSharp.Tests, PublicKey=0024000004800000940000000602000000240000525341310004000001000100fda57af14a288d46e3efea89617037585c4de57159cd536ca6dff792ea1d6addc665f2fccb4285413d9d44db5a1be87cb82686db200d16325ed9c42c89cd4824d8cc447f7cee2ac000924c3bceeb1b7fcb5cc1a3901785964d48ce14172001084134f4dcd9973c3776713b595443b1064bb53e2eeb924969244d354e46495e9d" + ), + InternalsVisibleTo( + "RestSharp.Tests.Shared, PublicKey=0024000004800000940000000602000000240000525341310004000001000100fda57af14a288d46e3efea89617037585c4de57159cd536ca6dff792ea1d6addc665f2fccb4285413d9d44db5a1be87cb82686db200d16325ed9c42c89cd4824d8cc447f7cee2ac000924c3bceeb1b7fcb5cc1a3901785964d48ce14172001084134f4dcd9973c3776713b595443b1064bb53e2eeb924969244d354e46495e9d" + ), + InternalsVisibleTo( + "RestSharp.Serializers.Xml, PublicKey=0024000004800000940000000602000000240000525341310004000001000100fda57af14a288d46e3efea89617037585c4de57159cd536ca6dff792ea1d6addc665f2fccb4285413d9d44db5a1be87cb82686db200d16325ed9c42c89cd4824d8cc447f7cee2ac000924c3bceeb1b7fcb5cc1a3901785964d48ce14172001084134f4dcd9973c3776713b595443b1064bb53e2eeb924969244d354e46495e9d" + )] +[assembly: CLSCompliant(true)] diff --git a/src/RestSharp/Properties/IsExternalInit.cs b/src/RestSharp/Properties/IsExternalInit.cs new file mode 100644 index 000000000..a77ccc3c3 --- /dev/null +++ b/src/RestSharp/Properties/IsExternalInit.cs @@ -0,0 +1,9 @@ +#if !NET +using System.ComponentModel; + +// ReSharper disable once CheckNamespace +namespace System.Runtime.CompilerServices; + +[EditorBrowsable(EditorBrowsableState.Never)] +internal class IsExternalInit{} +#endif diff --git a/src/RestSharp/Request/BodyExtensions.cs b/src/RestSharp/Request/BodyExtensions.cs new file mode 100644 index 000000000..958f97289 --- /dev/null +++ b/src/RestSharp/Request/BodyExtensions.cs @@ -0,0 +1,29 @@ +// Copyright (c) .NET Foundation and Contributors +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// http://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. +// + +namespace RestSharp; + +using System.Diagnostics.CodeAnalysis; + +static class BodyExtensions { + extension(RestRequest request) { + public bool TryGetBodyParameter([NotNullWhen(true)] out BodyParameter? bodyParameter) { + bodyParameter = request.Parameters.FirstOrDefault(p => p.Type == ParameterType.RequestBody) as BodyParameter; + return bodyParameter != null; + } + + public bool HasFiles() => request.Files.Count > 0; + } +} diff --git a/src/RestSharp/Request/HttpRequestMessageExtensions.cs b/src/RestSharp/Request/HttpRequestMessageExtensions.cs new file mode 100644 index 000000000..923f9364f --- /dev/null +++ b/src/RestSharp/Request/HttpRequestMessageExtensions.cs @@ -0,0 +1,35 @@ +// Copyright (c) .NET Foundation and Contributors +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// http://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. +// + +using System.Net.Http.Headers; +using RestSharp.Extensions; + +namespace RestSharp; + +static class HttpRequestMessageExtensions { + public static void AddHeaders(this HttpRequestMessage message, RequestHeaders headers) { + var headerParameters = headers.Where(x => !KnownHeaders.IsContentHeader(x.Name)); + + headerParameters.GroupBy(x => x.Name).ForEach(x => AddHeader(x, message.Headers)); + return; + + void AddHeader(IGrouping group, HttpHeaders httpHeaders) { + var parameterStringValues = group.Select(x => x.Value); + + httpHeaders.Remove(group.Key); + httpHeaders.TryAddWithoutValidation(group.Key, parameterStringValues); + } + } +} \ No newline at end of file diff --git a/src/RestSharp/Request/PropertyCache.Populator.RequestProperty.cs b/src/RestSharp/Request/PropertyCache.Populator.RequestProperty.cs new file mode 100644 index 000000000..0c6f59814 --- /dev/null +++ b/src/RestSharp/Request/PropertyCache.Populator.RequestProperty.cs @@ -0,0 +1,70 @@ +// Copyright (c) .NET Foundation and Contributors +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// http://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. + +using System.Reflection; + +namespace RestSharp; + +static partial class PropertyCache where T : class { + sealed partial class Populator { + sealed record RequestProperty { + /// + /// Gets or sets the associated + /// with the property this object represents + /// + internal string Name { get; init; } + /// + /// Gets the associated with + /// the property this object represents + /// + internal string? Format { get; } + /// + /// Gets the associated + /// with the property this object represents + /// + internal RequestArrayQueryType ArrayQueryType { get; } + /// + /// Gets the return type of the property this object represents + /// + internal Type Type { get; } + + RequestProperty(string name, string? format, RequestArrayQueryType arrayQueryType, Type type) { + Name = name; + Format = format; + ArrayQueryType = arrayQueryType; + Type = type; + } + + /// + /// Creates a new request property representation of the provided property + /// + /// The property to turn into a request property + /// + internal static RequestProperty From(PropertyInfo property) { + var requestPropertyAttribute = + property.GetCustomAttribute() ?? + new RequestPropertyAttribute(); + + var propertyName = requestPropertyAttribute.Name ?? property.Name; + + return new( + propertyName, + requestPropertyAttribute.Format, + requestPropertyAttribute.ArrayQueryType, + property.PropertyType + ); + } + } + } +} diff --git a/src/RestSharp/Request/PropertyCache.Populator.cs b/src/RestSharp/Request/PropertyCache.Populator.cs new file mode 100644 index 000000000..4057ac999 --- /dev/null +++ b/src/RestSharp/Request/PropertyCache.Populator.cs @@ -0,0 +1,414 @@ +// Copyright (c) .NET Foundation and Contributors +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// http://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. + +using System.Collections; +using System.ComponentModel; +using System.Linq.Expressions; +using System.Reflection; +using System.Runtime.CompilerServices; + +// ReSharper disable InconsistentNaming + +namespace RestSharp; + +static partial class PropertyCache where T : class { + sealed partial class Populator { + /// + /// Gets the name of the property this populator represents. + /// + /// + /// This corresponds to the actual property name and not the name + /// determined by + /// + internal string PropertyName { get; } + readonly Action> _populate; + + Populator(string propertyName, Action> populate) { + PropertyName = propertyName; + _populate = populate; + } + + /// + /// Populates the provided parameters collection + /// + /// The object to get parameters from + /// The parameters collection to populate + internal void Populate(T entity, ICollection parameters) => _populate(entity, parameters); + + /// + /// Creates a new populator instance from the provided property + /// + /// A public instance property from the type + /// + internal static Populator From(PropertyInfo property) { + var entity = Expression.Parameter(typeof(T)); + var callGetter = Expression.Call(entity, property.GetGetMethod()!); + + Expression convertGetterReturnToObject = + property.PropertyType.IsValueType + ? + // Values types are not automatically boxed in LINQ expressions. + // This would throw an exception. + Expression.Convert(callGetter, typeof(object)) + : + // Avoid unnecessary cast to object if property is already a reference type. + callGetter; + + // This compiles roughly to: `(T entity) => (object)entity.get_Property()`, + // where `.GetProperty()` is the getter. The reason we use LINQ expressions + // instead of direct calls to the MethodInfo instance is for an increase in + // performance. We can then leverage our knowledge of the type parameter provided. + + var getObject = Expression.Lambda>(convertGetterReturnToObject, entity).Compile(); + + var populate = GetPopulate(getObject, property); + + return new(property.Name, populate); + } + + static Action> GetPopulate(Func getFormattable, RequestProperty requestProperty) + => (model, parameters) => Populate(getFormattable(model), requestProperty, parameters); + + static Action> GetPopulate(Func getConvertible, RequestProperty requestProperty) + => (model, parameters) => Populate(getConvertible(model), requestProperty, parameters); + + static Action> GetPopulate(Func> getFormattables, RequestProperty requestProperty) + => requestProperty.ArrayQueryType switch { + RequestArrayQueryType.CommaSeparated => (model, parameters) => PopulateCsv(getFormattables(model), requestProperty, parameters), + RequestArrayQueryType.ArrayParameters => GetPopulateArray(getFormattables, requestProperty), + _ => (_, _) => { } + }; // Here we avoid the cost of checking if the format is CSV or Array every time by caching the result of this evaluation. + + static Action> GetPopulate(Func> getConvertibles, RequestProperty requestProperty) + => requestProperty.ArrayQueryType switch { + RequestArrayQueryType.CommaSeparated => (entity, parameters) => PopulateCsv(getConvertibles(entity), requestProperty, parameters), + RequestArrayQueryType.ArrayParameters => GetPopulateArray(getConvertibles, requestProperty), + _ => (_, _) => { } + }; // Here we avoid the cost of checking if the format is CSV or Array every time by caching the result of this evaluation. + + static Action> GetPopulate(Func getEnumerable, RequestProperty requestProperty) + => requestProperty.ArrayQueryType switch { + RequestArrayQueryType.CommaSeparated => (entity, parameters) => PopulateCsv(getEnumerable(entity), requestProperty, parameters), + RequestArrayQueryType.ArrayParameters => GetPopulateArray(getEnumerable, requestProperty), + _ => (_, _) => { } + }; // Here we avoid the cost of checking if the format is CSV or Array every time by caching the result of this evaluation. + + static Action> GetPopulate(Func getObject, RequestProperty requestProperty) + => requestProperty.ArrayQueryType switch { + RequestArrayQueryType.CommaSeparated => (entity, parameters) => PopulateCsv(getObject(entity), requestProperty, parameters), + RequestArrayQueryType.ArrayParameters => (entity, parameters) => PopulateArray(getObject(entity), requestProperty, parameters), + _ => (_, _) => { } + }; // Here we avoid the cost of checking if the format is CSV or Array every time by caching the result of this evaluation. + + static Action> GetPopulate(Func getObject, PropertyInfo property) { + var requestProperty = RequestProperty.From(property); + + // We need to use different conversion mechanisms for each return type. Simply calling `.ToString()` + // on every returned object would not take into account special cases like custom formatting, enumeration etc. + // Unchecked casts here are safe because we know the return type of `getObject` is boxed if needed. + return property.PropertyType switch { + var formattableType when typeof(IFormattable).IsAssignableFrom(formattableType) => GetPopulate( + entity => Unsafe.As(getObject(entity)), + requestProperty + ), + var convertibleType when typeof(IConvertible).IsAssignableFrom(convertibleType) => GetPopulate( + entity => Unsafe.As(getObject(entity)), + requestProperty + ), + var enumerableType when typeof(IEnumerable).IsAssignableFrom(enumerableType) => GetPopulateUnknown( + entity => Unsafe.As(getObject(entity)), + requestProperty + ), + // At this point we're not necessarily sure we can just treat this as a bare object + // and use its type converter. Even though the property itself returns an object, + // the object returned itself may need to be treated in a special way, so we check + // it as we go. + _ => GetPopulate(getObject, requestProperty) + }; + } + + static Action> GetPopulateUnknown(Func getEnumerable, RequestProperty requestProperty) { + if (GetSingleEnumeratedTypeOrNull(requestProperty.Type) is not { } enumeratedType) { + // Means we're dealing with a legacy, untyped enumerable instance. + // We can just convert it into an enumerable of objects and delegate + // conversion to string to the type converter of each enumerated item. + return GetPopulateKnown(getEnumerable, requestProperty); + } + + return enumeratedType switch { + _ when typeof(IFormattable).IsAssignableFrom(enumeratedType) => GetPopulate( + GetEnumerableOf(getEnumerable, enumeratedType), + requestProperty + ), + _ when typeof(IConvertible).IsAssignableFrom(enumeratedType) => GetPopulate( + GetEnumerableOf(getEnumerable, enumeratedType), + requestProperty + ), + // At this point we're not necessarily sure we can just treat this as an enumerable of objects. + // Since we know the actual enumerable may be a typed `IEnumerable<>` enumerating a type we're + // interested in, we do further checks to ensure the correct conversion to string is applied. + _ => GetPopulate(getEnumerable, requestProperty) + }; + } + + static Action> GetPopulateKnown(Func getEnumerable, RequestProperty requestProperty) + => requestProperty.ArrayQueryType switch { + RequestArrayQueryType.CommaSeparated => (entity, parameters) => PopulateCsvUnknown( + getEnumerable(entity), + requestProperty, + parameters + ), + RequestArrayQueryType.ArrayParameters => GetPopulateArray(getEnumerable, requestProperty), + _ => (_, _) => { } + }; // Here we avoid the cost of checking if the format is CSV or Array every time by caching the result of this evaluation. + + static Action> GetPopulateArray(Func> getFormattables, RequestProperty requestProperty) + => GetPopulateArray(getFormattables, formattable => GetStringValue(formattable, requestProperty), requestProperty); + + static Action> GetPopulateArray(Func> getConvertibles, RequestProperty requestProperty) + => GetPopulateArray(getConvertibles, GetStringValue, requestProperty); + + static Action> GetPopulateArray( + Func> getEnumerable, + Func toString, + RequestProperty requestProperty + ) where V : class { + // We do this to avoid recreating request property on each iteration. + var newRequestProperty = requestProperty with { Name = $"{requestProperty.Name}[]" }; + return (entity, parameters) => PopulateArray(getEnumerable(entity), toString, newRequestProperty, parameters); + } + + static Action> GetPopulateArray(Func getEnumerable, RequestProperty requestProperty) { + // We do this to avoid recreating request property on each iteration. + var newRequestProperty = requestProperty with { Name = $"{requestProperty.Name}[]" }; + return (entity, parameters) => PopulateArray(getEnumerable(entity), newRequestProperty, parameters); + } + + static void Populate(IFormattable formattable, RequestProperty requestProperty, ICollection parameters) + => Populate(GetStringValue(formattable, requestProperty), requestProperty, parameters); + + static void Populate(IConvertible convertible, RequestProperty requestProperty, ICollection parameters) + => Populate(GetStringValue(convertible), requestProperty, parameters); + + static void Populate(object @object, RequestProperty requestProperty, ICollection parameters) + => Populate(GetStringValueKnown(@object), requestProperty, parameters); + + static void Populate(string? stringValue, RequestProperty requestProperty, ICollection parameters) { + var parameter = new GetOrPostParameter(requestProperty.Name, stringValue); + parameters.Add(parameter); + } + + static void PopulateCsv(IEnumerable formattables, RequestProperty requestProperty, ICollection parameters) + => PopulateCsv(formattables, formattable => GetStringValue(formattable, requestProperty), requestProperty, parameters); + + static void PopulateCsv(IEnumerable convertibles, RequestProperty requestProperty, ICollection parameters) + => PopulateCsv(convertibles, GetStringValue, requestProperty, parameters); + + static void PopulateCsv(IEnumerable objects, RequestProperty requestProperty, ICollection parameters) + => PopulateCsv(objects, @object => GetStringValueUnknown(@object, requestProperty), requestProperty, parameters); + + static void PopulateCsv(IEnumerable enumerable, RequestProperty requestProperty, ICollection parameters) { + switch (enumerable) { + case IEnumerable formattables: + PopulateCsv(formattables, requestProperty, parameters); + break; + case IEnumerable convertibles: + PopulateCsv(convertibles, requestProperty, parameters); + break; + case IEnumerable objects: + PopulateCsv(objects, requestProperty, parameters); + break; + default: + PopulateCsvUnknown(enumerable, requestProperty, parameters); + break; + } + } + + static void PopulateCsv( + IEnumerable enumerable, + Func toString, + RequestProperty requestProperty, + ICollection parameters + ) where V : class { +#if NETCOREAPP2_0_OR_GREATER + const char csvSeparator = ','; +#else + const string csvSeparator = ","; +#endif + var formattedStrings = enumerable.Select(toString); + var csv = string.Join(csvSeparator, formattedStrings); + Populate(csv, requestProperty, parameters); + } + + static void PopulateCsv(object @object, RequestProperty requestProperty, ICollection parameters) { + switch (@object) { + case IFormattable formattable: + Populate(formattable, requestProperty, parameters); + break; + case IConvertible convertible: + Populate(convertible, requestProperty, parameters); + break; + case IEnumerable enumerable: + PopulateCsv(enumerable, requestProperty, parameters); + break; + default: + // At this point it's safe to assume we can delegate + // to the type converter. + Populate(@object, requestProperty, parameters); + break; + } + } + + static void PopulateCsvUnknown(IEnumerable enumerable, RequestProperty requestProperty, ICollection parameters) { + if (GetSingleEnumeratedTypeOrNull(enumerable.GetType()) is not { } enumeratedType) { + // Means we're dealing with a legacy, untyped enumerable instance. + // We can just convert it into an enumerable of objects and delegate + // conversion to string to the type converter of each enumerated item. + PopulateCsvKnown(enumerable, requestProperty, parameters); + return; + } + + switch (enumeratedType) { + case var _ when typeof(IFormattable).IsAssignableFrom(enumeratedType): + PopulateCsv(enumerable.Cast(), requestProperty, parameters); + break; + case var _ when typeof(IConvertible).IsAssignableFrom(enumeratedType): + PopulateCsv(enumerable.Cast(), requestProperty, parameters); + break; + default: + PopulateCsvKnown(enumerable, requestProperty, parameters); + break; + } + } + + static void PopulateCsvKnown(IEnumerable enumerable, RequestProperty requestProperty, ICollection parameters) + => PopulateCsv(enumerable.Cast(), requestProperty, parameters); + + static void PopulateArray(IEnumerable formattables, RequestProperty requestProperty, ICollection parameters) + => PopulateArray(formattables, formattable => GetStringValue(formattable, requestProperty), requestProperty, parameters); + + static void PopulateArray(IEnumerable convertibles, RequestProperty requestProperty, ICollection parameters) + => PopulateArray(convertibles, GetStringValue, requestProperty, parameters); + + static void PopulateArray(IEnumerable objects, RequestProperty requestProperty, ICollection parameters) + => PopulateArray(objects, @object => GetStringValueUnknown(@object, requestProperty), requestProperty, parameters); + + static void PopulateArray(IEnumerable enumerable, RequestProperty requestProperty, ICollection parameters) { + switch (enumerable) { + case IEnumerable formattables: + PopulateArray(formattables, requestProperty, parameters); + break; + case IEnumerable convertibles: + PopulateArray(convertibles, requestProperty, parameters); + break; + case IEnumerable objects: + PopulateArray(objects, requestProperty, parameters); + break; + default: + PopulateArrayUnknown(enumerable, requestProperty, parameters); + break; + } + } + + static void PopulateArray( + IEnumerable enumerable, + Func toString, + RequestProperty requestProperty, + ICollection parameters + ) where V : class { + var values = enumerable.Select(toString); + + foreach (var value in values) { + Populate(value, requestProperty, parameters); + } + } + + static void PopulateArray(object @object, RequestProperty requestProperty, ICollection parameters) { + switch (@object) { + case IFormattable formattable: + Populate(formattable, requestProperty, parameters); + break; + case IConvertible convertible: + Populate(convertible, requestProperty, parameters); + break; + case IEnumerable enumerable: + // We do this to avoid recreating request property on each iteration. + requestProperty = requestProperty with { Name = $"{requestProperty.Name}[]" }; + PopulateArray(enumerable, requestProperty, parameters); + break; + default: + // At this point it's safe to assume we can delegate + // to the type converter. + Populate(@object, requestProperty, parameters); + break; + } + } + + static void PopulateArrayUnknown(IEnumerable enumerable, RequestProperty requestProperty, ICollection parameters) { + if (GetSingleEnumeratedTypeOrNull(enumerable.GetType()) is not { } enumeratedType) { + // Means we're dealing with a legacy, untyped enumerable instance. + // We can just convert it into an enumerable of objects and delegate + // conversion to string to the type converter of each enumerated item. + PopulateArrayKnown(enumerable, requestProperty, parameters); + return; + } + + switch (enumeratedType) { + case var _ when typeof(IFormattable).IsAssignableFrom(enumeratedType): + PopulateArray(enumerable.Cast(), requestProperty, parameters); + break; + case var _ when typeof(IConvertible).IsAssignableFrom(enumeratedType): + PopulateArray(enumerable.Cast(), requestProperty, parameters); + break; + default: + PopulateArrayKnown(enumerable, requestProperty, parameters); + break; + } + } + + static void PopulateArrayKnown(IEnumerable enumerable, RequestProperty requestProperty, ICollection parameters) + => PopulateArray(enumerable.Cast(), requestProperty, parameters); + + static string GetStringValue(IFormattable formattable, RequestProperty requestProperty) => formattable.ToString(requestProperty.Format, null); + + static string GetStringValue(IConvertible convertible) => convertible.ToString(null); + + static string? GetStringValueKnown(object @object) => TypeDescriptor.GetConverter(@object).ConvertToString(@object); + + static string? GetStringValueUnknown(object @object, RequestProperty requestProperty) + => @object switch { + IFormattable formattable => GetStringValue(formattable, requestProperty), + IConvertible convertible => GetStringValue(convertible), + _ => GetStringValueKnown(@object) + }; + + static Func> GetEnumerableOf(Func getEnumerable, Type enumeratedType) where V : class + => enumeratedType.IsValueType ? entity => getEnumerable(entity).Cast() : entity => Unsafe.As>(getEnumerable(entity)); + + static Type? GetSingleEnumeratedTypeOrNull(Type enumerableType) { + // Get all IEnumerable<> interfaces this type implements. + var enumerableInterfaces = + enumerableType + .GetInterfaces() + .Where(@interface => @interface.IsGenericType) + .Where(@interface => @interface.GetGenericTypeDefinition() == typeof(IEnumerable<>)) + .ToArray(); + + // If this type implements `IEnumerable<>` multiple times with different type parameters + // we cannot pick which implementation to "believe", so we treat the whole thing as a bare, + // untyped `IEnumerable`. + return enumerableInterfaces.Length == 1 ? enumerableInterfaces[0].GetGenericArguments()[0] : null; + } + } +} \ No newline at end of file diff --git a/src/RestSharp/Request/PropertyCache.cs b/src/RestSharp/Request/PropertyCache.cs new file mode 100644 index 000000000..1b15e7faf --- /dev/null +++ b/src/RestSharp/Request/PropertyCache.cs @@ -0,0 +1,75 @@ +// Copyright (c) .NET Foundation and Contributors +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// http://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. + +using System.Reflection; + +namespace RestSharp; + +static partial class PropertyCache where T : class { + static readonly IReadOnlyCollection Populators = + typeof(T) + .GetProperties(BindingFlags.Public | BindingFlags.Instance) + // We need to ensure the property does not return a ref struct + // since reflection and LINQ expressions do not play well with + // them. All bets are off, so let's just ignore them. +#if NET + .Where(property => !property.PropertyType.IsByRefLike) +#else + // Since `IsByRefLikeAttribute` is generated at compile time, each assembly + // may have its own definition of the attribute, so we must compare by full name + // instead of type. + .Where(property => property.PropertyType.GetCustomAttributes().Select(attribute => attribute.GetType().FullName).All(attributeName => attributeName != "System.Runtime.CompilerServices.IsByRefLikeAttribute")) +#endif + .Select(Populator.From) + .ToArray(); + + /// + /// Gets parameters from the provided object + /// + /// The object from which to get the parameters + /// Properties to include, or nothing to include everything. The array will be sorted. + /// + internal static IEnumerable GetParameters(T entity, params string[] includedProperties) { + if (includedProperties.Length == 0) { + return GetParameters(entity); + } + + Array.Sort(includedProperties); // Otherwise binary search is unsafe. + + // Get only populators found in `includedProperties`. + + var populators = Populators.Where(populator => Array.BinarySearch(includedProperties, populator.PropertyName) >= 0); + return GetParameters(entity, populators); + } + + /// + /// Gets parameters from the provided object + /// + /// The object from which to get the parameters + /// + internal static IEnumerable GetParameters(T entity) => GetParameters(entity, Populators); + + static List GetParameters(T entity, IEnumerable populators) { + var parameters = new List(capacity: Populators.Count); + + foreach (var populator in populators) { + // Each populator may return one or more parameters, + // so they take temporary ownership of the list in order + // to populate it with its own set of parameters. + populator.Populate(entity, parameters); + } + + return parameters; + } +} diff --git a/src/RestSharp/Request/RequestContent.cs b/src/RestSharp/Request/RequestContent.cs new file mode 100644 index 000000000..affc60618 --- /dev/null +++ b/src/RestSharp/Request/RequestContent.cs @@ -0,0 +1,233 @@ +// Copyright (c) .NET Foundation and Contributors +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// http://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. + +using System.Net.Http.Headers; +using System.Runtime.Serialization; +using RestSharp.Extensions; +using static RestSharp.KnownHeaders; + +// ReSharper disable InvertIf +// ReSharper disable SuggestBaseTypeForParameter + +namespace RestSharp; + +class RequestContent(IRestClient client, RestRequest request) : IDisposable { + readonly List _streams = []; + readonly ParametersCollection _parameters = new RequestParameters(request.Parameters.Union(client.DefaultParameters)); + + HttpContent? Content { get; set; } + + public HttpContent BuildContent() { + var postParameters = _parameters.GetContentParameters(request.Method).ToArray(); + var postParametersExists = postParameters.Length > 0; + var bodyParametersExists = request.TryGetBodyParameter(out var bodyParameter); + var filesExists = request.Files.Count != 0; + + if (request.HasFiles() || + BodyShouldBeMultipartForm(bodyParameter) || + filesExists || + request.AlwaysMultipartFormData) { + Content = CreateMultipartFormDataContent(); + } + + if (filesExists) AddFiles(); + + if (bodyParametersExists) AddBody(postParametersExists, bodyParameter!); + + if (postParametersExists) AddPostParameters(postParameters); + + AddHeaders(); + + return Content!; + } + + void AddFiles() { + // File uploading without multipart/form-data + if (request is { AlwaysSingleFileAsContent: true, Files.Count: 1 }) { + var fileParameter = request.Files.First(); + Content?.Dispose(); + Content = ToStreamContent(fileParameter); + return; + } + + var mpContent = Content as MultipartFormDataContent; + foreach (var fileParameter in request.Files) mpContent!.Add(ToStreamContent(fileParameter)); + } + + StreamContent ToStreamContent(FileParameter fileParameter) { + var stream = fileParameter.GetFile(); + _streams.Add(stream); + var streamContent = new StreamContent(stream); + + streamContent.Headers.ContentType = fileParameter.ContentType.AsMediaTypeHeaderValue; + + var dispositionHeader = fileParameter.Options.DisableFilenameEncoding + ? ContentDispositionHeaderValue.Parse($"form-data; name=\"{fileParameter.Name}\"; filename=\"{fileParameter.FileName}\"") + : new("form-data") { Name = $"\"{fileParameter.Name}\"", FileName = $"\"{fileParameter.FileName}\"" }; + if (!fileParameter.Options.DisableFilenameStar) dispositionHeader.FileNameStar = fileParameter.FileName; + streamContent.Headers.ContentDisposition = dispositionHeader; + + return streamContent; + } + + HttpContent Serialize(BodyParameter body) { + return body.DataFormat switch { + DataFormat.None => new StringContent(body.Value!.ToString()!, client.Options.Encoding, body.ContentType.Value), + DataFormat.Binary => GetBinary(), + _ => GetSerialized() + }; + + HttpContent GetBinary() { + var byteContent = new ByteArrayContent((body.Value as byte[])!); + byteContent.Headers.ContentType = body.ContentType.AsMediaTypeHeaderValue; + + if (body.ContentEncoding != null) { + byteContent.Headers.ContentEncoding.Clear(); + byteContent.Headers.ContentEncoding.Add(body.ContentEncoding); + } + + return byteContent; + } + + HttpContent GetSerialized() { + var serializer = client.Serializers.GetSerializer(body.DataFormat); + var content = serializer.Serialize(body); + + if (content == null) throw new SerializationException("Request body serialized to null"); + + var contentType = body.ContentType.Or(serializer.Serializer.ContentType); + + return new StringContent(content, client.Options.Encoding, contentType.Value); + } + } + + static bool BodyShouldBeMultipartForm(BodyParameter? bodyParameter) { + if (bodyParameter == null) return false; + + var bodyContentType = bodyParameter.ContentType.OrValue(bodyParameter.Name); + return bodyParameter.Name.IsNotEmpty() && bodyParameter.Name != bodyContentType; + } + + string GetOrSetFormBoundary() => request.FormBoundary ?? (request.FormBoundary = Guid.NewGuid().ToString()); + + MultipartFormDataContent CreateMultipartFormDataContent() { + var boundary = GetOrSetFormBoundary(); + var mpContent = new MultipartFormDataContent(boundary); + var contentType = new MediaTypeHeaderValue("multipart/form-data"); + contentType.Parameters.Add(new(nameof(boundary), GetBoundary(boundary, request.MultipartFormQuoteBoundary))); + mpContent.Headers.ContentType = contentType; + return mpContent; + } + + void AddBody(bool hasPostParameters, BodyParameter bodyParameter) { + var bodyContent = Serialize(bodyParameter); + + // we need to send the body + if (hasPostParameters || request.HasFiles() || BodyShouldBeMultipartForm(bodyParameter) || request.AlwaysMultipartFormData) { + // here we must use multipart form data + var mpContent = Content as MultipartFormDataContent ?? CreateMultipartFormDataContent(); + var ct = bodyContent.Headers.ContentType?.MediaType; + var name = bodyParameter.Name.IsEmpty() ? ct : bodyParameter.Name; + + if (name.IsEmpty()) + mpContent.Add(bodyContent); + else + mpContent.Add(bodyContent, request.MultipartFormQuoteParameters ? $"\"{name}\"" : name); + Content = mpContent; + } + else { + // we don't have parameters, only the body + Content = bodyContent; + } + + if (client.Options.DisableCharset) { + Content.Headers.ContentType!.CharSet = ""; + } + } + + void AddPostParameters(GetOrPostParameter[] postParameters) { + if (postParameters.Length == 0) return; + + if (Content is MultipartFormDataContent mpContent) { + // we got the multipart form already instantiated, just add parameters to it + foreach (var postParameter in postParameters) { + var parameterName = postParameter.Name!; + + mpContent.Add( + new StringContent(postParameter.Value?.ToString() ?? string.Empty, client.Options.Encoding, postParameter.ContentType.Value), + request.MultipartFormQuoteParameters ? $"\"{parameterName}\"" : parameterName + ); + } + } + else { + var encodedItems = postParameters.Select(x => $"{x.Name!.UrlEncode()}={x.Value?.ToString()?.UrlEncode() ?? string.Empty}"); + var encodedContent = new StringContent(encodedItems.JoinToString("&"), client.Options.Encoding, ContentType.FormUrlEncoded.Value); + + if (client.Options.DisableCharset) { + encodedContent.Headers.ContentType!.CharSet = ""; + } + + Content = encodedContent; + } + } + + static string GetBoundary(string boundary, bool quote) => quote ? $"\"{boundary}\"" : boundary; + + void AddHeaders() { + var contentHeaders = _parameters + .GetParameters() + .Where(x => IsContentHeader(x.Name!)) + .ToArray(); + + if (contentHeaders.Length > 0 && Content == null) { + // We need some content to add content headers to it, so if necessary, we'll add empty content + Content = new StringContent(""); + } + + contentHeaders.ForEach(AddHeader); + return; + + void AddHeader(HeaderParameter parameter) { + var parameterStringValue = parameter.Value!.ToString(); + + var value = parameter.Name switch { + KnownHeaders.ContentType => GetContentTypeHeader(Ensure.NotNull(parameterStringValue, nameof(parameter))), + _ => parameterStringValue + }; + var pName = Ensure.NotNull(parameter.Name, nameof(parameter.Name)); + ReplaceHeader(pName, value); + } + + string GetContentTypeHeader(string contentType) + => Content is MultipartFormDataContent + ? $"{contentType}; boundary={GetBoundary(GetOrSetFormBoundary(), request.MultipartFormQuoteBoundary)}" + : contentType; + } + + void ReplaceHeader(string name, string? value) { + Content!.Headers.Remove(name); + Content!.Headers.TryAddWithoutValidation(name, value); + } + + public void Dispose() { + _streams.ForEach(x => x.Dispose()); + + try { + Content?.Dispose(); + } + catch (Exception e) when (e is ObjectDisposedException or NullReferenceException) { + // Already disposed + } + } +} \ No newline at end of file diff --git a/src/RestSharp/Request/RequestHeaders.cs b/src/RestSharp/Request/RequestHeaders.cs new file mode 100644 index 000000000..86d4be6fd --- /dev/null +++ b/src/RestSharp/Request/RequestHeaders.cs @@ -0,0 +1,65 @@ +// Copyright (c) .NET Foundation and Contributors +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// http://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. +// + +// ReSharper disable InvertIf + +using RestSharp.Extensions; + +namespace RestSharp; + +class RequestHeaders : ParametersCollection { + public RequestHeaders AddHeaders(ParametersCollection parameters) { + Parameters.AddRange(parameters.GetParameters()); + return this; + } + + // Add Accept header based on registered deserializers if the caller has set none. + public RequestHeaders AddAcceptHeader(string[] acceptedContentTypes) { + if (TryFind(KnownHeaders.Accept) == null) { + var accepts = acceptedContentTypes.JoinToString(", "); + Parameters.Add(new(KnownHeaders.Accept, accepts)); + } + + return this; + } + + public RequestHeaders RemoveHeader(string name) { + Parameters.RemoveAll(p => string.Equals(p.Name, name, StringComparison.InvariantCultureIgnoreCase)); + return this; + } + + // Add Cookie header from the cookie container + public RequestHeaders AddCookieHeaders(Uri uri, CookieContainer? cookieContainer) { + if (cookieContainer == null) return this; + + var cookies = cookieContainer.GetCookieHeader(uri); + + if (string.IsNullOrWhiteSpace(cookies)) return this; + + var newCookies = SplitHeader(cookies); + var existing = GetParameters().FirstOrDefault(x => x.Name == KnownHeaders.Cookie); + + if (existing?.Value != null) { + newCookies = newCookies.Union(SplitHeader(existing.Value!)); + Parameters.Remove(existing); + } + + Parameters.Add(new(KnownHeaders.Cookie, string.Join("; ", newCookies))); + + return this; + + IEnumerable SplitHeader(string header) => header.Split(';').Select(x => x.Trim()); + } +} diff --git a/src/RestSharp/Request/RestRequest.cs b/src/RestSharp/Request/RestRequest.cs new file mode 100644 index 000000000..b2f86f6ef --- /dev/null +++ b/src/RestSharp/Request/RestRequest.cs @@ -0,0 +1,278 @@ +// Copyright (c) .NET Foundation and Contributors +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// http://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. + +using System.Net.Http.Headers; +using RestSharp.Authenticators; +using RestSharp.Extensions; +using RestSharp.Interceptors; + +// ReSharper disable AutoPropertyCanBeMadeGetOnly.Global +// ReSharper disable UnusedAutoPropertyAccessor.Global + +namespace RestSharp; + +/// +/// Container for data used to make requests +/// +public class RestRequest { + /// + /// Default constructor + /// + public RestRequest() => Method = Method.Get; + + /// + /// Constructor for a rest request to a relative resource URL and optional method + /// + /// Resource to use + /// Method to use (defaults to Method.Get> + public RestRequest(string? resource, Method method = Method.Get) : this() { + Resource = resource ?? ""; + Method = method; + + if (string.IsNullOrWhiteSpace(resource)) return; + + var queryStringStart = Resource.IndexOf('?'); + + if (queryStringStart < 0 || Resource.IndexOf('=') <= queryStringStart) return; + + var queryParams = ParseQuery(Resource[(queryStringStart + 1)..]); + Resource = Resource[..queryStringStart]; + + foreach (var param in queryParams) this.AddQueryParameter(param.Key, param.Value, false); + + return; + + static IEnumerable> ParseQuery(string query) + => query.Split('&', StringSplitOptions.RemoveEmptyEntries) + .Select( + x => { + var position = x.IndexOf('='); + + return position > 0 ? new KeyValuePair(x[..position], x[(position + 1)..]) : new(x, null); + } + ); + } + + /// + /// Constructor for a rest request to a specific resource Uri and optional method + /// + /// Resource Uri to use + /// Method to use (defaults to Method.Get> + public RestRequest(Uri resource, Method method = Method.Get) + : this(resource.IsAbsoluteUri ? resource.AbsoluteUri : resource.OriginalString, method) { } + + readonly List _files = []; + readonly List _cookies = []; + + /// + /// Always send a multipart/form-data request - even when no Files are present. + /// + public bool AlwaysMultipartFormData { get; set; } + + /// + /// Always send a file as request content without multipart/form-data request - even when the request contains only one file parameter + /// + public bool AlwaysSingleFileAsContent { get; set; } + + /// + /// When set to true, parameter values in a multipart form data requests will be enclosed in + /// quotation marks. Default is true, as per RFC 7578. + /// + public bool MultipartFormQuoteParameters { get; set; } = true; + + /// + /// When set to true, the form boundary part of the content type will be enclosed in + /// quotation marks. Default is true. + /// + [PublicAPI] + public bool MultipartFormQuoteBoundary { get; set; } = true; + + /// + /// Overrides the default (random) form boundary + /// + public string? FormBoundary { get; set; } + + /// + /// Container of all HTTP parameters to be passed with the request. + /// See AddParameter() for explanation of the types of parameters that can be passed + /// + public RequestParameters Parameters { get; } = new(); + + /// + /// Optional cookie container to use for the request. If not set, cookies are not passed. + /// + public CookieContainer? CookieContainer { get; set; } + + /// + /// Request-level authenticator. It will be used if set, otherwise RestClient.Authenticator will be used. + /// + public IAuthenticator? Authenticator { get; set; } + + /// + /// Container of all the files to be uploaded with the request. + /// + public IReadOnlyCollection Files => _files.AsReadOnly(); + + /// + /// Determines what HTTP method to use for this request. Supported methods: GET, POST, PUT, DELETE, HEAD, OPTIONS + /// Default is GET + /// + public Method Method { get; set; } + + /// + /// Custom request timeout. Overrides if set. + /// If not set, uses the client-level timeout or the default of 100 seconds. + /// + /// + /// + /// Set to (or TimeSpan.FromMilliseconds(-1)) for no timeout + /// Set to to cancel the request immediately + /// Negative values (other than -1 millisecond) will throw + /// + /// + public TimeSpan? Timeout { get; set; } + + /// + /// The Resource URL to make the request against. + /// Tokens are substituted with UrlSegment parameters and match by name. + /// Should not include the scheme or domain. Do not include leading slash. + /// Combined with RestClient.BaseUrl to assemble final URL: + /// {BaseUrl}/{Resource} (BaseUrl is scheme + domain, e.g. http://example.com) + /// + /// + /// // example for url token replacement + /// request.Resource = "Products/{ProductId}"; + /// request.AddParameter("ProductId", 123, ParameterType.UrlSegment); + /// + [PublicAPI] + public string Resource { get; set; } = ""; + + /// + /// Serializer to use when writing request bodies. + /// + public DataFormat RequestFormat { get; set; } + + /// + /// Used by the default deserializers to determine where to start deserializing from. + /// Can be used to skip container or root elements that do not have corresponding deserialization targets. + /// + public string? RootElement { get; set; } + + /// + /// HTTP version for the request. Default is Version11. + /// + public Version Version { get; set; } = HttpVersion.Version11; + + /// + /// When supplied, the function will be called before calling the deserializer + /// + [Obsolete("Use Interceptors instead")] + public Action? OnBeforeDeserialization { get; set; } + + /// + /// When supplied, the function will be called before making a request + /// + [Obsolete("Use Interceptors instead")] + public Func? OnBeforeRequest { get; set; } + + /// + /// When supplied, the function will be called after the request is complete + /// + [Obsolete("Use Interceptors instead")] + public Func? OnAfterRequest { get; set; } + + internal void IncreaseNumberOfAttempts() => Attempts++; + + /// + /// The number of attempts that were made to send this request + /// + /// + /// This number is incremented each time the RestClient sends the request. + /// + [PublicAPI] + public int Attempts { get; private set; } + + /// + /// Completion option for + /// + public HttpCompletionOption CompletionOption { get; set; } = HttpCompletionOption.ResponseContentRead; + + /// + /// Cache policy to be used for requests using + /// + public CacheControlHeaderValue? CachePolicy { get; set; } + + /// + /// Set this to write response to Stream rather than reading into memory. + /// + public Func? ResponseWriter { + get; + set { + if (AdvancedResponseWriter != null) { + throw new ArgumentException("AdvancedResponseWriter is not null. Only one response writer can be used."); + } + + field = value; + } + } + + /// + /// Set this to handle the response stream yourself, based on the response details + /// + public Func? AdvancedResponseWriter { + get; + set { + if (ResponseWriter != null) { + throw new ArgumentException("ResponseWriter is not null. Only one response writer can be used."); + } + + field = value; + } + } + + /// + /// Request-level interceptors. Will be combined with client-level interceptors if set. + /// + public List? Interceptors { get; set; } + + /// + /// Adds a parameter object to the request parameters + /// + /// Parameter to add + /// + public RestRequest AddParameter(Parameter parameter) => this.With(x => x.Parameters.AddParameter(parameter)); + + /// + /// Removes a parameter object from the request parameters + /// + /// Parameter to remove + public RestRequest RemoveParameter(Parameter parameter) { + Parameters.RemoveParameter(parameter); + return this; + } + + internal RestRequest AddFile(FileParameter file) => this.With(x => x._files.Add(file)); + + internal RestRequest AddCookie(Cookie cookie) => this.With(x => x._cookies.Add(cookie)); + + /// + /// Cookies added via the 2-param AddCookie(name, value) overload that have not yet been + /// resolved into . Domain is inferred from the request URL at + /// execution time. Interceptors can inspect this list in BeforeRequest to see cookies + /// that will be sent. + /// + public IReadOnlyList PendingCookies => _cookies; + + internal void ClearPendingCookies() => _cookies.Clear(); +} \ No newline at end of file diff --git a/src/RestSharp/Request/RestRequestExtensions.Body.cs b/src/RestSharp/Request/RestRequestExtensions.Body.cs new file mode 100644 index 000000000..39e0a1cde --- /dev/null +++ b/src/RestSharp/Request/RestRequestExtensions.Body.cs @@ -0,0 +1,118 @@ +// Copyright (c) .NET Foundation and Contributors +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// http://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. + +namespace RestSharp; + +public static partial class RestRequestExtensions { + /// Request instance + extension(RestRequest request) { + /// + /// Adds a body parameter to the request + /// + /// Object to be used as the request body, or string for plain content + /// Optional: content type + /// + /// Thrown if request body type cannot be resolved + /// This method will try to figure out the right content type based on the request data format and the provided content type + public RestRequest AddBody(object obj, ContentType? contentType = null) { + if (contentType == null) { + return request.RequestFormat switch { + DataFormat.Json => request.AddJsonBody(obj, contentType), + DataFormat.Xml => request.AddXmlBody(obj, contentType), + DataFormat.Binary => request.AddParameter(new BodyParameter("", obj, ContentType.Binary)), + _ => request.AddParameter(new BodyParameter("", obj.ToString()!, ContentType.Plain)) + }; + } + + return + obj is string str ? request.AddStringBody(str, contentType) : + obj is byte[] bytes ? request.AddParameter(new BodyParameter("", bytes, contentType, DataFormat.Binary)) : + contentType.Value.Contains("xml") ? request.AddXmlBody(obj, contentType) : + contentType.Value.Contains("json") ? request.AddJsonBody(obj, contentType) : + throw new ArgumentException("Non-string body found with unsupported content type", nameof(obj)); + } + + /// + /// Adds a string body and figures out the content type from the data format specified. You can, for example, add a JSON string + /// using this method as request body, using DataFormat.Json/> + /// + /// String body + /// for the content + /// + public RestRequest AddStringBody(string body, DataFormat dataFormat) { + var contentType = ContentType.FromDataFormat(dataFormat); + request.RequestFormat = dataFormat; + return request.AddParameter(new BodyParameter("", body, contentType)); + } + + /// + /// Adds a string body to the request using the specified content type. + /// + /// String body + /// Content type of the body + /// + public RestRequest AddStringBody(string body, ContentType contentType) + => request.AddParameter(new BodyParameter(body, Ensure.NotNull(contentType, nameof(contentType)))); + + /// + /// Adds a JSON body parameter to the request from a string + /// + /// Force serialize the top-level string + /// Optional: content type. Default is ContentType.Json + /// JSON string to be used as a body + /// + public RestRequest AddJsonBody(string jsonString, bool forceSerialize, ContentType? contentType = null) { + request.RequestFormat = DataFormat.Json; + + return !forceSerialize + ? request.AddStringBody(jsonString, DataFormat.Json) + : request.AddParameter(new JsonParameter(jsonString, contentType)); + } + + /// + /// Adds a JSON body parameter to the request + /// + /// Object that will be serialized to JSON + /// Optional: content type. Default is ContentType.Json + /// + public RestRequest AddJsonBody(T obj, ContentType? contentType = null) where T : class { + request.RequestFormat = DataFormat.Json; + + return obj is string str + ? request.AddStringBody(str, DataFormat.Json) + : request.AddParameter(new JsonParameter(obj, contentType)); + } + + /// + /// Adds an XML body parameter to the request + /// + /// Object that will be serialized to XML + /// Optional: content type. Default is ContentType.Xml + /// Optional: XML namespace + /// + public RestRequest AddXmlBody(T obj, ContentType? contentType = null, string xmlNamespace = "") + where T : class { + request.RequestFormat = DataFormat.Xml; + + return obj is string str + ? request.AddStringBody(str, DataFormat.Xml) + : request.AddParameter(new XmlParameter(obj, xmlNamespace, contentType)); + } + + RestRequest AddBodyParameter(string? name, object value) + => name != null && name.Contains('/') + ? request.AddBody(value, name) + : request.AddParameter(new BodyParameter(name, value, ContentType.Plain)); + } +} \ No newline at end of file diff --git a/src/RestSharp/Request/RestRequestExtensions.File.cs b/src/RestSharp/Request/RestRequestExtensions.File.cs new file mode 100644 index 000000000..4674338ac --- /dev/null +++ b/src/RestSharp/Request/RestRequestExtensions.File.cs @@ -0,0 +1,88 @@ +// Copyright (c) .NET Foundation and Contributors +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// http://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. + +namespace RestSharp; + +public static partial class RestRequestExtensions { + /// Request instance + extension(RestRequest request) { + /// + /// Adds a file parameter to the request body. The file will be read from disk as a stream. + /// + /// Parameter name + /// Full path to the file + /// Optional: content type + /// File parameter header options + /// + public RestRequest AddFile( + string name, + string path, + ContentType? contentType = null, + FileParameterOptions? options = null + ) + => request.AddFile(FileParameter.FromFile(path, name, contentType, options)); + + /// + /// Adds bytes to the request as file attachment + /// + /// Parameter name + /// File content as bytes + /// File name + /// Optional: content type. Default is "application/octet-stream" + /// File parameter header options + /// + public RestRequest AddFile( + string name, + byte[] bytes, + string fileName, + ContentType? contentType = null, + FileParameterOptions? options = null + ) + => request.AddFile(FileParameter.Create(name, bytes, fileName, contentType, options)); + + /// + /// Adds a file attachment to the request, where the file content will be retrieved from a given stream + /// + /// Parameter name + /// Function that returns a stream with the file content + /// File name + /// Optional: content type. Default is "application/octet-stream" + /// File parameter header options + /// + public RestRequest AddFile( + string name, + Func getFile, + string fileName, + ContentType? contentType = null, + FileParameterOptions? options = null + ) + => request.AddFile(FileParameter.Create(name, getFile, fileName, contentType, options)); + + internal void ValidateParameters() { + if (!request.AlwaysSingleFileAsContent) return; + + var postParametersExists = request.Parameters.GetContentParameters(request.Method).Any(); + var bodyParametersExists = request.Parameters.Any(p => p.Type == ParameterType.RequestBody); + + if (request.AlwaysMultipartFormData) + throw new ArgumentException("Failed to put file as content because flag AlwaysMultipartFormData is enabled"); + + if (postParametersExists) + throw new ArgumentException("Failed to put file as content because POST parameters were added"); + + if (bodyParametersExists) + throw new ArgumentException("Failed to put file as content because body parameters were added"); + } + } +} \ No newline at end of file diff --git a/src/RestSharp/Request/RestRequestExtensions.Headers.cs b/src/RestSharp/Request/RestRequestExtensions.Headers.cs new file mode 100644 index 000000000..f026948a1 --- /dev/null +++ b/src/RestSharp/Request/RestRequestExtensions.Headers.cs @@ -0,0 +1,121 @@ +// Copyright (c) .NET Foundation and Contributors +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// http://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. + +using System.Globalization; +using RestSharp.Extensions; + +namespace RestSharp; + +public static partial class RestRequestExtensions { + /// Request instance + extension(RestRequest request) { + /// + /// Adds a header to the request. RestSharp will try to separate request and content headers when calling the resource. + /// + /// Header name + /// Header values + /// + public RestRequest AddHeader(string name, string[] values) { + foreach (var value in values) { + AddHeader(request, name, value); + } + + return request; + } + + /// + /// Adds a header to the request. RestSharp will try to separate request and content headers when calling the resource. + /// + /// Header name + /// Header value + /// + public RestRequest AddHeader(string name, string value) + => request.AddParameter(new HeaderParameter(name, value)); + + /// + /// Adds a header to the request. RestSharp will try to separate request and content headers when calling the resource. + /// The value will be converted to string using the specified culture, or by default. + /// + /// Header name + /// Header value + /// Culture to use for formatting the value, defaults to + /// + public RestRequest AddHeader(string name, T value, CultureInfo? culture = null) where T : struct + => request.AddHeader(name, Ensure.NotNull(value.ToStringValue(culture), nameof(value))); + + /// + /// Adds or updates the request header. RestSharp will try to separate request and content headers when calling the resource. + /// The existing header with the same name will be replaced. + /// + /// Header name + /// Header value + /// + public RestRequest AddOrUpdateHeader(string name, string value) + => request.AddOrUpdateParameter(new HeaderParameter(name, value)); + + /// + /// Adds or updates the request header. RestSharp will try to separate request and content headers when calling the resource. + /// The existing header with the same name will be replaced. + /// The value will be converted to string using the specified culture, or by default. + /// + /// Header name + /// Header value + /// Culture to use for formatting the value, defaults to + /// + public RestRequest AddOrUpdateHeader(string name, T value, CultureInfo? culture = null) where T : struct + => request.AddOrUpdateHeader(name, Ensure.NotNull(value.ToStringValue(culture), nameof(value))); + + /// + /// Adds multiple headers to the request, using the key-value pairs provided. + /// + /// Collection of key-value pairs, where key will be used as header name, and value as header value + /// + public RestRequest AddHeaders(ICollection> headers) { + CheckAndThrowsDuplicateKeys(headers); + + foreach (var header in headers) { + request.AddHeader(header.Key, header.Value); + } + + return request; + } + + /// + /// Adds or updates multiple headers to the request, using the key-value pairs provided. Existing headers with the same name will be replaced. + /// + /// Collection of key-value pairs, where key will be used as header name, and value as header value + /// + public RestRequest AddOrUpdateHeaders(ICollection> headers) { + CheckAndThrowsDuplicateKeys(headers); + + foreach (var pair in headers) { + request.AddOrUpdateHeader(pair.Key, pair.Value); + } + + return request; + } + } + + static void CheckAndThrowsDuplicateKeys(ICollection> headers) { + var duplicateKeys = headers + .GroupBy(pair => pair.Key.ToUpperInvariant()) + .Where(group => group.Count() > 1) + .Select(group => group.Key) + .ToList(); + + if (duplicateKeys.Count > 0) { + throw new ArgumentException($"Duplicate header names exist: {string.Join(", ", duplicateKeys)}"); + } + } +} \ No newline at end of file diff --git a/src/RestSharp/Request/RestRequestExtensions.Object.cs b/src/RestSharp/Request/RestRequestExtensions.Object.cs new file mode 100644 index 000000000..fbfd2715f --- /dev/null +++ b/src/RestSharp/Request/RestRequestExtensions.Object.cs @@ -0,0 +1,65 @@ +// Copyright (c) .NET Foundation and Contributors +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// http://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. + +namespace RestSharp; + +public static partial class RestRequestExtensions { + /// Request instance + extension(RestRequest request) { + /// + /// Gets object properties and adds each property as a form data parameter + /// + /// Object to add as form data + /// Properties to include, or nothing to include everything. The array will be sorted. + /// + public RestRequest AddObject(T obj, params string[] includedProperties) where T : class { + var props = obj.GetProperties(includedProperties); + + foreach (var prop in props) { + request.AddParameter(prop.Name, prop.Value, prop.Encode); + } + + return request; + } + + /// + /// Gets object properties and adds each property as a form data parameter + /// + /// + /// This method gets public instance properties from the provided type + /// rather than from itself, which allows for caching of properties and + /// other optimizations. If you don't know the type at runtime, or wish to use properties not + /// available from the provided type parameter, consider using + /// + /// Object to add as form data + /// Properties to include, or nothing to include everything. The array will be sorted. + /// + public RestRequest AddObjectStatic(T obj, params string[] includedProperties) where T : class + => request.AddParameters(PropertyCache.GetParameters(obj, includedProperties)); + + /// + /// Gets object properties and adds each property as a form data parameter + /// + /// + /// This method gets public instance properties from the provided type + /// rather than from itself, which allows for caching of properties and + /// other optimizations. If you don't know the type at runtime, or wish to use properties not + /// available from the provided type parameter, consider using + /// + /// Object to add as form data + /// + public RestRequest AddObjectStatic(T obj) where T : class + => request.AddParameters(PropertyCache.GetParameters(obj)); + } +} \ No newline at end of file diff --git a/src/RestSharp/Request/RestRequestExtensions.Query.cs b/src/RestSharp/Request/RestRequestExtensions.Query.cs new file mode 100644 index 000000000..14d69e309 --- /dev/null +++ b/src/RestSharp/Request/RestRequestExtensions.Query.cs @@ -0,0 +1,47 @@ +// Copyright (c) .NET Foundation and Contributors +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// http://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. + +using System.Globalization; +using RestSharp.Extensions; + +namespace RestSharp; + +public static partial class RestRequestExtensions { + /// Request instance + extension(RestRequest request) { + /// + /// Adds a query string parameter to the request. The request resource should not contain any placeholders for this parameter. + /// The parameter will be added to the request URL as a query string using name=value format. + /// + /// Parameter name + /// Parameter value + /// Encode the value or not, default true + /// + public RestRequest AddQueryParameter(string name, string? value, bool encode = true) + => request.AddParameter(new QueryParameter(name, value, encode)); + + /// + /// Adds a query string parameter to the request. The request resource should not contain any placeholders for this parameter. + /// The parameter will be added to the request URL as a query string using name=value format. + /// The value will be converted to string using the specified culture, or by default. + /// + /// Parameter name + /// Parameter value + /// Encode the value or not, default true + /// Culture to use for formatting the value, defaults to + /// + public RestRequest AddQueryParameter(string name, T value, bool encode = true, CultureInfo? culture = null) where T : struct + => request.AddQueryParameter(name, value.ToStringValue(culture), encode); + } +} \ No newline at end of file diff --git a/src/RestSharp/Request/RestRequestExtensions.Url.cs b/src/RestSharp/Request/RestRequestExtensions.Url.cs new file mode 100644 index 000000000..66dbfe5ad --- /dev/null +++ b/src/RestSharp/Request/RestRequestExtensions.Url.cs @@ -0,0 +1,47 @@ +// Copyright (c) .NET Foundation and Contributors +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// http://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. + +using System.Globalization; +using RestSharp.Extensions; + +namespace RestSharp; + +public static partial class RestRequestExtensions { + /// Request instance + extension(RestRequest request) { + /// + /// Adds a URL segment parameter to the request. The resource URL must have a placeholder for the parameter for it to work. + /// For example, if you add a URL segment parameter with the name "id", the resource URL should contain {id} in its path. + /// + /// Name of the parameter; must be matching a placeholder in the resource URL as {name} + /// Value of the parameter + /// Encode the value or not, default true + /// + public RestRequest AddUrlSegment(string name, string? value, bool encode = true) + => request.AddOrUpdateParameter(new UrlSegmentParameter(name, value, encode)); + + /// + /// Adds a URL segment parameter to the request. The resource URL must have a placeholder for the parameter for it to work. + /// For example, if you add a URL segment parameter with the name "id", the resource URL should contain {id} in its path. + /// The value will be converted to string using the specified culture, or by default. + /// + /// Name of the parameter; must be matching a placeholder in the resource URL as {name} + /// Value of the parameter + /// Encode the value or not, default true + /// Culture to use for formatting the value, defaults to + /// + public RestRequest AddUrlSegment(string name, T value, bool encode = true, CultureInfo? culture = null) where T : struct + => request.AddUrlSegment(name, value.ToStringValue(culture), encode); + } +} \ No newline at end of file diff --git a/src/RestSharp/Request/RestRequestExtensions.cs b/src/RestSharp/Request/RestRequestExtensions.cs new file mode 100644 index 000000000..55bdd550f --- /dev/null +++ b/src/RestSharp/Request/RestRequestExtensions.cs @@ -0,0 +1,156 @@ +// Copyright (c) .NET Foundation and Contributors +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// http://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. + +using System.Globalization; +using RestSharp.Extensions; + +namespace RestSharp; + +[PublicAPI] +public static partial class RestRequestExtensions { + /// + extension(RestRequest request) { + /// + /// Adds a HTTP parameter to the request (QueryString for GET, DELETE, OPTIONS and HEAD; Encoded form for POST and PUT) + /// + /// Name of the parameter + /// Value of the parameter + /// Encode the value or not, default true + /// This request + public RestRequest AddParameter(string name, string? value, bool encode = true) + => request.AddParameter(new GetOrPostParameter(name, value, encode)); + + /// + /// Adds a parameter of a given type to the request. It will create a typed parameter instance based on the type argument. + /// It is not recommended to use this overload unless you must, as it doesn't provide any restrictions, and if the name-value-type + /// combination doesn't match, it will throw. + /// + /// Name of the parameter, must be matching a placeholder in the resource URL as {name} + /// Value of the parameter + /// Enum value specifying what kind of parameter is being added + /// Encode the value or not, default true + /// + public RestRequest AddParameter(string? name, object value, ParameterType type, bool encode = true) + => type == ParameterType.RequestBody + ? request.AddBodyParameter(name, value) + : request.AddParameter(Parameter.CreateParameter(name, value, type, encode)); + + /// + /// Adds a HTTP parameter to the request (QueryString for GET, DELETE, OPTIONS and HEAD; Encoded form for POST and PUT). + /// The value will be converted to string using the specified culture, or by default. + /// + /// Name of the parameter + /// Value of the parameter + /// Encode the value or not, default true + /// Culture to use for formatting the value, defaults to + /// This request + public RestRequest AddParameter(string name, T value, bool encode = true, CultureInfo? culture = null) where T : struct + => request.AddParameter(name, value.ToStringValue(culture), encode); + + /// + /// Adds or updates a HTTP parameter to the request (QueryString for GET, DELETE, OPTIONS and HEAD; Encoded form for POST and PUT) + /// + /// Name of the parameter + /// Value of the parameter + /// Encode the value or not, default true + /// This request + public RestRequest AddOrUpdateParameter(string name, string? value, bool encode = true) + => request.AddOrUpdateParameter(new GetOrPostParameter(name, value, encode)); + + /// + /// Adds or updates a HTTP parameter to the request (QueryString for GET, DELETE, OPTIONS and HEAD; Encoded form for POST and PUT). + /// The value will be converted to string using the specified culture, or by default. + /// + /// Name of the parameter + /// Value of the parameter + /// Encode the value or not, default true + /// Culture to use for formatting the value, defaults to + /// This request + public RestRequest AddOrUpdateParameter(string name, T value, bool encode = true, CultureInfo? culture = null) where T : struct + => request.AddOrUpdateParameter(name, value.ToStringValue(culture), encode); + + RestRequest AddParameters(IEnumerable parameters) { + request.Parameters.AddParameters(parameters); + return request; + } + + /// + /// Adds or updates request parameter of a given type. It will create a typed parameter instance based on the type argument. + /// Parameter will be added or updated based on its name. If the request has a parameter with the same name, it will be updated. + /// It is not recommended to use this overload unless you must, as it doesn't provide any restrictions, and if the name-value-type + /// combination doesn't match, it will throw. + /// + /// Name of the parameter, must be matching a placeholder in the resource URL as {name} + /// Value of the parameter + /// Enum value specifying what kind of parameter is being added + /// Encode the value or not, default true + /// + public RestRequest AddOrUpdateParameter(string name, object value, ParameterType type, bool encode = true) { + request.RemoveParameter(name, type); + + return type == ParameterType.RequestBody + ? request.AddBodyParameter(name, value) + : request.AddOrUpdateParameter(Parameter.CreateParameter(name, value, type, encode)); + } + + /// + /// Adds or updates request parameter, given the parameter instance, for example or . + /// It will replace an existing parameter with the same name. + /// + /// Parameter instance + /// + public RestRequest AddOrUpdateParameter(Parameter parameter) + => request.RemoveParameter(parameter.Name, parameter.Type).AddParameter(parameter); + + /// + /// Adds or updates multiple request parameters, given the parameter instance, for example + /// or . Parameters with the same name will be replaced. + /// + /// Collection of parameter instances + /// + public RestRequest AddOrUpdateParameters(IEnumerable parameters) { + foreach (var parameter in parameters) request.AddOrUpdateParameter(parameter); + + return request; + } + + RestRequest RemoveParameter(string? name, ParameterType type) { + var p = request.Parameters.FirstOrDefault(x => x.Name == name && x.Type == type); + return p != null ? request.RemoveParameter(p) : request; + } + + /// + /// Adds a cookie to the request. The cookie domain will be inferred from the request URL at execution time. + /// + /// Cookie name + /// Cookie value + /// + public RestRequest AddCookie(string name, string value) + => request.AddCookie(new Cookie(name, value)); + + /// + /// Adds cookie to the cookie container. + /// + /// Cookie name + /// Cookie value + /// Cookie path + /// Cookie domain, must not be an empty string + /// + public RestRequest AddCookie(string name, string value, string path, string domain) { + request.CookieContainer ??= new(); + request.CookieContainer.Add(new Cookie(name, value, path, domain)); + return request; + } + } +} \ No newline at end of file diff --git a/src/RestSharp/Request/RestXmlRequest.cs b/src/RestSharp/Request/RestXmlRequest.cs new file mode 100644 index 000000000..ada2eded2 --- /dev/null +++ b/src/RestSharp/Request/RestXmlRequest.cs @@ -0,0 +1,29 @@ +// Copyright (c) .NET Foundation and Contributors +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// http://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. +// + +namespace RestSharp; + +public class RestXmlRequest : RestRequest { + /// + /// Used by the default deserializers to explicitly set which date format string to use when parsing dates. + /// + public string? DateFormat { get; set; } + + /// + /// Used by XmlDeserializer. If not specified, XmlDeserializer will flatten response by removing namespaces from + /// element names. + /// + public string? XmlNamespace { get; set; } +} \ No newline at end of file diff --git a/src/RestSharp/Request/UriExtensions.cs b/src/RestSharp/Request/UriExtensions.cs new file mode 100644 index 000000000..bc217dff6 --- /dev/null +++ b/src/RestSharp/Request/UriExtensions.cs @@ -0,0 +1,83 @@ +// Copyright (c) .NET Foundation and Contributors +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// http://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. +// + +using RestSharp.Extensions; + +namespace RestSharp; + +static class UriExtensions { + public static Uri MergeBaseUrlAndResource(this Uri? baseUrl, string? resource) { + var assembled = resource; + + if (assembled.IsNotEmpty() && assembled[0] == '/') assembled = assembled[1..]; + + if (baseUrl == null || baseUrl.AbsoluteUri.IsEmpty()) { + return assembled.IsNotEmpty() + ? new Uri(assembled) + : throw new ArgumentException("Both BaseUrl and Resource are empty", nameof(resource)); + } + + var usingBaseUri = baseUrl.AbsoluteUri[^1] == '/' || assembled.IsEmpty() ? baseUrl : new(baseUrl.AbsoluteUri + "/"); + +#if NETSTANDARD2_0 + return !string.IsNullOrWhiteSpace(assembled) ? new(usingBaseUri, assembled, true) : baseUrl; +#else + return !string.IsNullOrWhiteSpace(assembled) ? new(usingBaseUri, assembled) : baseUrl; +#endif + } + + public static Uri AddQueryString(this Uri uri, string? query) { + if (query == null) return uri; + + var builder = new UriBuilder(uri); + builder.Query = builder.Query.Length > 1 ? $"{builder.Query[1..]}&{query}" : query; + + return builder.Uri; + } + + public static UrlSegmentParamsValues GetUrlSegmentParamsValues( + this Uri? baseUri, + string resource, + Func encode, + params ParametersCollection[] parametersCollections + ) { + var assembled = baseUri == null ? "" : resource; +#if NETSTANDARD2_0 + var baseUrl = baseUri ?? new Uri(resource, true); +#else + var baseUrl = baseUri ?? new Uri(resource); +#endif + + var hasResource = !assembled.IsEmpty(); + + var parameters = parametersCollections.SelectMany(x => x.GetParameters()); + + var builder = new UriBuilder(baseUrl); + + foreach (var parameter in parameters) { + var paramPlaceHolder = $"{{{parameter.Name}}}"; + var value = Ensure.NotNull(parameter.Value!.ToString(), $"URL segment parameter {parameter.Name} value"); + var paramValue = parameter.Encode ? encode(value) : value; + + if (hasResource) assembled = assembled.Replace(paramPlaceHolder, paramValue); + + builder.Path = builder.Path.UrlDecode().Replace(paramPlaceHolder, paramValue); + } + + return new(builder.Uri, assembled); + } +} + +record UrlSegmentParamsValues(Uri Uri, string Resource); \ No newline at end of file diff --git a/src/RestSharp/Response/ResponseThrowExtension.cs b/src/RestSharp/Response/ResponseThrowExtension.cs new file mode 100644 index 000000000..01d5167af --- /dev/null +++ b/src/RestSharp/Response/ResponseThrowExtension.cs @@ -0,0 +1,32 @@ +// Copyright (c) .NET Foundation and Contributors +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// http://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. +// + +namespace RestSharp; + +public static class ResponseThrowExtension { + extension(RestResponse response) { + public RestResponse ThrowIfError() { + var exception = response.GetException(); + return exception != null ? throw exception : response; + } + } + + extension(RestResponse response) { + public RestResponse ThrowIfError() { + var exception = response.GetException(); + return exception != null ? throw exception : response; + } + } +} diff --git a/src/RestSharp/Response/RestResponse.cs b/src/RestSharp/Response/RestResponse.cs new file mode 100644 index 000000000..92c3f0e3b --- /dev/null +++ b/src/RestSharp/Response/RestResponse.cs @@ -0,0 +1,97 @@ +// Copyright (c) .NET Foundation and Contributors +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// http://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. + +using System.Diagnostics; +using RestSharp.Extensions; + +// ReSharper disable SuggestBaseTypeForParameter + +namespace RestSharp; + +/// +/// Container for data sent back from API including deserialized data +/// +/// Type of data to deserialize to +[GenerateClone(BaseType = typeof(RestResponse), Name = "FromResponse")] +[DebuggerDisplay($"{{{nameof(DebuggerDisplay)}()}}")] +public partial class RestResponse(RestRequest request) : RestResponse(request) { + /// + /// Deserialized entity data + /// + public T? Data { get; set; } +} + +/// +/// Container for data sent back from API +/// +[DebuggerDisplay($"{{{nameof(DebuggerDisplay)}()}}")] +public class RestResponse(RestRequest request) : RestResponseBase(request) { + internal static async Task FromHttpResponse( + HttpResponseMessage httpResponse, + RestRequest request, + ReadOnlyRestClientOptions options, + CookieCollection? cookieCollection, + CancellationToken cancellationToken + ) { + return request.AdvancedResponseWriter?.Invoke(httpResponse, request) ?? await GetDefaultResponse().ConfigureAwait(false); + + async Task GetDefaultResponse() { +#if NET + await using var stream = await httpResponse.ReadResponseStream(request.ResponseWriter, cancellationToken).ConfigureAwait(false); +#else + using var stream = await httpResponse.ReadResponseStream(request.ResponseWriter, cancellationToken).ConfigureAwait(false); +#endif + + var bytes = stream == null ? null : await stream.ReadAsBytes(cancellationToken).ConfigureAwait(false); + var content = bytes == null ? null : await httpResponse.GetResponseString(bytes, options.Encoding); + + return new(request) { + Content = content, + ContentEncoding = httpResponse.Content?.Headers.ContentEncoding ?? Array.Empty(), + ContentHeaders = httpResponse.Content?.Headers.GetHeaderParameters(), + ContentLength = httpResponse.Content?.Headers.ContentLength, + ContentType = httpResponse.Content?.Headers.ContentType?.MediaType, + Cookies = cookieCollection, + ErrorException = httpResponse.MaybeException(options.SetErrorExceptionOnUnsuccessfulStatusCode), + Headers = httpResponse.Headers.GetHeaderParameters(), + IsSuccessStatusCode = httpResponse.IsSuccessStatusCode, + RawBytes = bytes, + ResponseStatus = options.CalculateResponseStatus(httpResponse), + ResponseUri = GetResponseUri(httpResponse), + RootElement = request.RootElement, + Server = httpResponse.Headers.Server.ToString(), + StatusCode = httpResponse.StatusCode, + StatusDescription = httpResponse.ReasonPhrase, + Version = httpResponse.RequestMessage?.Version + }; + } + } + + public RestResponse() : this(new()) { } + + static Uri? GetResponseUri(HttpResponseMessage httpResponse) { + var requestUri = httpResponse.RequestMessage?.RequestUri; + + if ((int)httpResponse.StatusCode is >= 300 and < 400 + && httpResponse.Headers.Location is { } location) { + return location.IsAbsoluteUri || requestUri == null + ? location + : new Uri(requestUri, location); + } + + return requestUri; + } +} + +public delegate ResponseStatus CalculateResponseStatus(HttpResponseMessage httpResponse); \ No newline at end of file diff --git a/src/RestSharp/Response/RestResponseBase.cs b/src/RestSharp/Response/RestResponseBase.cs new file mode 100644 index 000000000..57b1f5c4a --- /dev/null +++ b/src/RestSharp/Response/RestResponseBase.cs @@ -0,0 +1,166 @@ +// Copyright (c) .NET Foundation and Contributors +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// http://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. + +using System.Diagnostics; +// ReSharper disable PropertyCanBeMadeInitOnly.Global +// ReSharper disable AutoPropertyCanBeMadeGetOnly.Global + +namespace RestSharp; + +/// +/// Base class for common properties shared by RestResponse and RestResponse[[T]] +/// +[DebuggerDisplay($"{{{nameof(DebuggerDisplay)}()}}")] +public abstract class RestResponseBase { + /// + /// Default constructor + /// + protected RestResponseBase(RestRequest request) { + ResponseStatus = ResponseStatus.None; + Request = request; + Request.IncreaseNumberOfAttempts(); + } + + /// + /// The RestRequest that was made to get this RestResponse + /// + /// + /// Mainly for debugging if ResponseStatus is not OK + /// + public RestRequest Request { get; set; } + + /// + /// MIME content type of response + /// + public string? ContentType { get; set; } + + /// + /// Length in bytes of the response content + /// + public long? ContentLength { get; set; } + + /// + /// Encoding of the response content + /// + public ICollection ContentEncoding { get; set; } = Array.Empty(); + + /// + /// String representation of response content + /// + public string? Content { get; set; } + + /// + /// HTTP response status code + /// + public HttpStatusCode StatusCode { get; set; } + + /// + /// Whether the HTTP response status code indicates success + /// + public bool IsSuccessStatusCode { get; set; } + + /// + /// Whether the HTTP response status code indicates success and no other error occurred + /// (deserialization, timeout, ...) + /// + public bool IsSuccessful => IsSuccessStatusCode && ResponseStatus == ResponseStatus.Completed; + + /// + /// Description of HTTP status returned + /// + public string? StatusDescription { get; set; } + + /// + /// Response content + /// + public byte[]? RawBytes { get; set; } + + /// + /// The URL that actually responded to the content (different from request if redirected) + /// + public Uri? ResponseUri { get; set; } + + /// + /// Server header value + /// + public string? Server { get; set; } + + /// + /// Cookies returned by server with the response + /// + public CookieCollection? Cookies { get; set; } + + /// + /// Response headers returned by server with the response + /// + public IReadOnlyCollection? Headers { get; set; } + + /// + /// Content headers returned by server with the response + /// + public IReadOnlyCollection? ContentHeaders { get; set; } + + /// + /// Status of the request. Will return Error for transport errors. + /// HTTP errors will still return ResponseStatus.Completed, check StatusCode instead + /// + public ResponseStatus ResponseStatus { get; set; } + + /// + /// Transport or another non-HTTP error generated while attempting request + /// + public string? ErrorMessage { get; set; } + + /// + /// The exception thrown during the request, if any + /// + public Exception? ErrorException { get; set; } + + /// + /// HTTP protocol version of the request + /// + public Version? Version { get; set; } + + /// + /// Combined view of request parameters and client default parameters as they were at execution time. + /// Use this to inspect the full set of parameters that were applied to the request. + /// + public ParametersCollection MergedParameters { get; internal set; } = new RequestParameters(); + + /// + /// Root element of the serialized response content, only works if deserializer supports it + /// + public string? RootElement { get; set; } + + /// + /// Assists with debugging responses by displaying in the debugger output + /// + /// + protected string DebuggerDisplay() => $"StatusCode: {StatusCode}, Content-Type: {ContentType}, Content-Length: {ContentLength})"; + + internal Exception? GetException() + => ResponseStatus switch { + ResponseStatus.Aborted => new HttpRequestException("Request aborted", ErrorException), + ResponseStatus.Error => ErrorException, + ResponseStatus.TimedOut => new TimeoutException("Request timed out", ErrorException), + ResponseStatus.None => null, + ResponseStatus.Completed => null, + _ => throw ErrorException ?? new ArgumentOutOfRangeException(nameof(ResponseStatus)) + }; + + internal void AddException(Exception exception) { + ErrorException = exception; + ErrorMessage = exception.GetBaseException().Message; + } +} diff --git a/src/RestSharp/Response/RestResponseExtensions.cs b/src/RestSharp/Response/RestResponseExtensions.cs new file mode 100644 index 000000000..ed9b32721 --- /dev/null +++ b/src/RestSharp/Response/RestResponseExtensions.cs @@ -0,0 +1,63 @@ +// Copyright (c) .NET Foundation and Contributors +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// http://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. + +namespace RestSharp; + +public static class RestResponseExtensions { + /// Response object + extension(RestResponse response) { + /// + /// Gets the value of the header with the specified name. + /// + /// Name of the header + /// Header value or null if the header is not found in the response + public string? GetHeaderValue(string headerName) + => response.Headers?.FirstOrDefault(x => NameIs(x.Name, headerName))?.Value.ToString(); + + /// + /// Gets all the values of the header with the specified name. + /// + /// Name of the header + /// Array of header values or empty array if the header is not found in the response + public string[] GetHeaderValues(string headerName) + => response.Headers + ?.Where(x => NameIs(x.Name, headerName)) + .Select(x => x.Value.ToString() ?? "") + .ToArray() ?? + []; + + /// + /// Gets the value of the content header with the specified name. + /// + /// Name of the header + /// Header value or null if the content header is not found in the response + public string? GetContentHeaderValue(string headerName) + => response.ContentHeaders?.FirstOrDefault(x => NameIs(x.Name, headerName))?.Value.ToString(); + + /// + /// Gets all the values of the content header with the specified name. + /// + /// Name of the header + /// Array of header values or empty array if the content header is not found in the response + public string[] GetContentHeaderValues(string headerName) + => response.ContentHeaders + ?.Where(x => NameIs(x.Name, headerName)) + .Select(x => x.Value.ToString() ?? "") + .ToArray() ?? + []; + } + + static bool NameIs(string? name, string headerName) + => name != null && name.Equals(headerName, StringComparison.InvariantCultureIgnoreCase); +} \ No newline at end of file diff --git a/src/RestSharp/RestClient.Async.cs b/src/RestSharp/RestClient.Async.cs new file mode 100644 index 000000000..73ed0410b --- /dev/null +++ b/src/RestSharp/RestClient.Async.cs @@ -0,0 +1,417 @@ +// Copyright (c) .NET Foundation and Contributors +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// http://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. + +using RestSharp.Extensions; + +// ReSharper disable PossiblyMistakenUseOfCancellationToken + +namespace RestSharp; + +public partial class RestClient { + // Default HttpClient timeout + readonly TimeSpan _defaultTimeout = TimeSpan.FromSeconds(100); + + /// + public async Task ExecuteAsync(RestRequest request, CancellationToken cancellationToken = default) { + using var internalResponse = await ExecuteRequestAsync(request, cancellationToken).ConfigureAwait(false); + + var response = internalResponse.Exception == null + ? await RestResponse.FromHttpResponse( + internalResponse.ResponseMessage!, + request, + Options, + internalResponse.CookieContainer?.GetCookies(internalResponse.Url), + cancellationToken + ) + .ConfigureAwait(false) + : GetErrorResponse(request, internalResponse.Exception, internalResponse.TimeoutToken); + response.MergedParameters = new RequestParameters(request.Parameters.Union(DefaultParameters)); + await OnAfterRequest(response, cancellationToken).ConfigureAwait(false); + + return Options.ThrowOnAnyError ? response.ThrowIfError() : response; + } + + /// + [PublicAPI] + public async Task DownloadStreamAsync(RestRequest request, CancellationToken cancellationToken = default) { + // Make sure we only read the headers, so we can stream the content body efficiently + request.CompletionOption = HttpCompletionOption.ResponseHeadersRead; + var response = await ExecuteRequestAsync(request, cancellationToken).ConfigureAwait(false); + + var exception = response.Exception ?? response.ResponseMessage?.MaybeException(Options.SetErrorExceptionOnUnsuccessfulStatusCode); + + if (exception != null) { + return Options.ThrowOnAnyError ? throw exception : null; + } + + if (response.ResponseMessage == null) return null; + + return await response.ResponseMessage.ReadResponseStream(request.ResponseWriter, cancellationToken).ConfigureAwait(false); + } + + static RestResponse GetErrorResponse(RestRequest request, Exception exception, CancellationToken timeoutToken) { + var timedOut = exception is OperationCanceledException && TimedOut(); + + var response = new RestResponse(request) { + ResponseStatus = exception is OperationCanceledException + ? timedOut ? ResponseStatus.TimedOut : ResponseStatus.Aborted + : ResponseStatus.Error, + ErrorMessage = timedOut ? "The request timed out." : exception.GetBaseException().Message, + ErrorException = exception + }; + + return response; + + bool TimedOut() => timeoutToken.IsCancellationRequested || exception.Message.Contains("HttpClient.Timeout"); + } + + void CombineInterceptors(RestRequest request) { + if (request.Interceptors == null) { + if (Options.Interceptors == null) { + return; + } + + request.Interceptors = Options.Interceptors.ToList(); + return; + } + + if (Options.Interceptors != null) { + request.Interceptors.AddRange(Options.Interceptors); + } + } + + async Task ExecuteRequestAsync(RestRequest request, CancellationToken cancellationToken) { + Ensure.NotNull(request, nameof(request)); + + // Make sure we are not disposed of when someone tries to call us! +#if NET + ObjectDisposedException.ThrowIf(_disposed, this); +#else + if (_disposed) { + throw new ObjectDisposedException(nameof(RestClient)); + } +#endif + CombineInterceptors(request); + await OnBeforeRequest(request, cancellationToken).ConfigureAwait(false); + request.ValidateParameters(); + var authenticator = request.Authenticator ?? Options.Authenticator; + + if (authenticator != null) { + await authenticator.Authenticate(this, request).ConfigureAwait(false); + } + + var contentToDispose = new List(); + var initialContent = new RequestContent(this, request); + contentToDispose.Add(initialContent); + + var httpMethod = AsHttpMethod(request.Method); + var url = new Uri(this.BuildUriString(request)); + + using var timeoutCts = new CancellationTokenSource(request.Timeout ?? Options.Timeout ?? _defaultTimeout); + using var cts = CancellationTokenSource.CreateLinkedTokenSource(timeoutCts.Token, cancellationToken); + + var ct = cts.Token; + + // Make sure we have a cookie container if not provided in the request + var cookieContainer = request.CookieContainer ??= new(); + AddPendingCookies(cookieContainer, url, request); + + var headers = new RequestHeaders() + .AddHeaders(request.Parameters) + .AddHeaders(DefaultParameters) + .AddAcceptHeader(AcceptedContentTypes) + .AddCookieHeaders(url, cookieContainer) + .AddCookieHeaders(url, Options.CookieContainer); + + var message = new HttpRequestMessage(httpMethod, url); + message.Content = initialContent.BuildContent(); + message.Headers.Host = Options.BaseHost; + message.Headers.CacheControl = request.CachePolicy ?? Options.CachePolicy; + message.Version = request.Version; + message.AddHeaders(headers); + +#pragma warning disable CS0618 // Type or member is obsolete + if (request.OnBeforeRequest != null) await request.OnBeforeRequest(message).ConfigureAwait(false); +#pragma warning restore CS0618 // Type or member is obsolete + await OnBeforeHttpRequest(request, message, cancellationToken).ConfigureAwait(false); + + var (responseMessage, finalUrl, error) = await SendWithRedirectsAsync( + message, url, httpMethod, request, cookieContainer, contentToDispose, ct + ).ConfigureAwait(false); + + DisposeContent(contentToDispose); + + if (error != null) { + return new(null, finalUrl, null, error, timeoutCts.Token); + } + +#pragma warning disable CS0618 // Type or member is obsolete + if (request.OnAfterRequest != null) await request.OnAfterRequest(responseMessage!).ConfigureAwait(false); +#pragma warning restore CS0618 // Type or member is obsolete + await OnAfterHttpRequest(request, responseMessage!, cancellationToken).ConfigureAwait(false); + return new(responseMessage, finalUrl, cookieContainer, null, timeoutCts.Token); + } + + async Task<(HttpResponseMessage? Response, Uri FinalUrl, Exception? Error)> SendWithRedirectsAsync( + HttpRequestMessage message, + Uri url, + HttpMethod httpMethod, + RestRequest request, + CookieContainer cookieContainer, + List contentToDispose, + CancellationToken ct + ) { + var redirectOptions = Options.RedirectOptions; + var redirectCount = 0; + var originalUrl = url; + + try { + while (true) { + var responseMessage = await HttpClient.SendAsync(message, request.CompletionOption, ct).ConfigureAwait(false); + + ParseResponseCookies(responseMessage, url, cookieContainer); + + if (!ShouldFollowRedirect(redirectOptions, responseMessage, redirectCount)) { + return (responseMessage, url, null); + } + + var redirectUrl = ResolveRedirectUrl(url, responseMessage, redirectOptions); + + if (redirectUrl == null) { + return (responseMessage, url, null); + } + + var newMethod = GetRedirectMethod(httpMethod, responseMessage.StatusCode); + var verbChangedToGet = newMethod == HttpMethod.Get && httpMethod != HttpMethod.Get; + + responseMessage.Dispose(); + + var previousMessage = message; + url = redirectUrl; + httpMethod = newMethod; + redirectCount++; + + message = CreateRedirectMessage( + httpMethod, url, originalUrl, request, redirectOptions, cookieContainer, contentToDispose, verbChangedToGet + ); + previousMessage.Dispose(); + } + } + catch (Exception ex) { + return (null, url, ex); + } + finally { + message.Dispose(); + } + } + + static void AddPendingCookies(CookieContainer cookieContainer, Uri url, RestRequest request) { + foreach (var cookie in request.PendingCookies) { + try { + cookieContainer.Add(url, cookie); + } + catch (CookieException) { + // Do not fail request if we cannot parse a cookie + } + } + + request.ClearPendingCookies(); + } + + void ParseResponseCookies(HttpResponseMessage responseMessage, Uri url, CookieContainer cookieContainer) { + if (!responseMessage.Headers.TryGetValues(KnownHeaders.SetCookie, out var cookiesHeader)) return; + + // ReSharper disable once PossibleMultipleEnumeration + cookieContainer.AddCookies(url, cookiesHeader); + // ReSharper disable once PossibleMultipleEnumeration + Options.CookieContainer?.AddCookies(url, cookiesHeader); + } + + static bool ShouldFollowRedirect(RedirectOptions options, HttpResponseMessage response, int redirectCount) + => options.FollowRedirects + && options.RedirectStatusCodes.Contains(response.StatusCode) + && response.Headers.Location != null + && redirectCount < options.MaxRedirects; + + static Uri? ResolveRedirectUrl(Uri currentUrl, HttpResponseMessage response, RedirectOptions options) { + var location = response.Headers.Location!; + var redirectUrl = location.IsAbsoluteUri ? location : new Uri(currentUrl, location); + + if (options.ForwardQuery && string.IsNullOrEmpty(redirectUrl.Query) && !string.IsNullOrEmpty(currentUrl.Query)) { + var builder = new UriBuilder(redirectUrl) { Query = currentUrl.Query.TrimStart('?') }; + redirectUrl = builder.Uri; + } + + // Block HTTPS -> HTTP unless explicitly allowed + if (currentUrl.Scheme == "https" && redirectUrl.Scheme == "http" && !options.FollowRedirectsToInsecure) { + return null; + } + + return redirectUrl; + } + + HttpRequestMessage CreateRedirectMessage( + HttpMethod httpMethod, + Uri url, + Uri originalUrl, + RestRequest request, + RedirectOptions redirectOptions, + CookieContainer cookieContainer, + List contentToDispose, + bool verbChangedToGet + ) { + var redirectMessage = new HttpRequestMessage(httpMethod, url); + redirectMessage.Version = request.Version; + redirectMessage.Headers.Host = Options.BaseHost; + redirectMessage.Headers.CacheControl = request.CachePolicy ?? Options.CachePolicy; + + if (!verbChangedToGet && redirectOptions.ForwardBody) { + var redirectContent = new RequestContent(this, request); + contentToDispose.Add(redirectContent); + redirectMessage.Content = redirectContent.BuildContent(); + } + + var redirectHeaders = BuildRedirectHeaders(url, originalUrl, redirectOptions, request, cookieContainer); + redirectMessage.AddHeaders(redirectHeaders); + + return redirectMessage; + } + + RequestHeaders BuildRedirectHeaders( + Uri url, Uri originalUrl, RedirectOptions redirectOptions, RestRequest request, CookieContainer cookieContainer + ) { + var redirectHeaders = new RequestHeaders(); + + if (redirectOptions.ForwardHeaders) { + redirectHeaders + .AddHeaders(request.Parameters) + .AddHeaders(DefaultParameters) + .AddAcceptHeader(AcceptedContentTypes); + + if (!ShouldForwardAuthorization(url, originalUrl, redirectOptions)) { + redirectHeaders.RemoveHeader(KnownHeaders.Authorization); + } + } + else { + redirectHeaders.AddAcceptHeader(AcceptedContentTypes); + } + + // Always remove existing Cookie headers before adding fresh ones from the container + redirectHeaders.RemoveHeader(KnownHeaders.Cookie); + + if (redirectOptions.ForwardCookies) { + redirectHeaders + .AddCookieHeaders(url, cookieContainer) + .AddCookieHeaders(url, Options.CookieContainer); + } + + return redirectHeaders; + } + + static bool ShouldForwardAuthorization(Uri redirectUrl, Uri originalUrl, RedirectOptions options) { + if (!options.ForwardAuthorization) return false; + + // Never forward credentials from HTTPS to HTTP (they would be sent in plaintext) + if (originalUrl.Scheme == "https" && redirectUrl.Scheme == "http") return false; + + // Compare full authority (host + port) to match browser same-origin policy + var isSameOrigin = string.Equals(redirectUrl.Authority, originalUrl.Authority, StringComparison.OrdinalIgnoreCase); + + return isSameOrigin || options.ForwardAuthorizationToExternalHost; + } + + static HttpMethod GetRedirectMethod(HttpMethod originalMethod, HttpStatusCode statusCode) { + // 307 and 308: always preserve the original method + if (statusCode is HttpStatusCode.TemporaryRedirect or (HttpStatusCode)308) { + return originalMethod; + } + + // 303: all methods except GET and HEAD become GET + if (statusCode == HttpStatusCode.SeeOther) { + return originalMethod == HttpMethod.Get || originalMethod == HttpMethod.Head + ? originalMethod + : HttpMethod.Get; + } + + // 301 and 302: POST becomes GET (matches browser/HttpClient behavior), others preserved + return originalMethod == HttpMethod.Post ? HttpMethod.Get : originalMethod; + } + + static void DisposeContent(List contentList) { + foreach (var content in contentList) { + content.Dispose(); + } + } + + static async ValueTask OnBeforeRequest(RestRequest request, CancellationToken cancellationToken) { + if (request.Interceptors == null) return; + + foreach (var interceptor in request.Interceptors) { + await interceptor.BeforeRequest(request, cancellationToken).ConfigureAwait(false); + } + } + + static async ValueTask OnBeforeHttpRequest(RestRequest request, HttpRequestMessage requestMessage, CancellationToken cancellationToken) { + if (request.Interceptors == null) return; + + foreach (var interceptor in request.Interceptors) { + await interceptor.BeforeHttpRequest(requestMessage, cancellationToken).ConfigureAwait(false); + } + } + + static async ValueTask OnAfterHttpRequest(RestRequest request, HttpResponseMessage responseMessage, CancellationToken cancellationToken) { + if (request.Interceptors == null) return; + + foreach (var interceptor in request.Interceptors) { + await interceptor.AfterHttpRequest(responseMessage, cancellationToken).ConfigureAwait(false); + } + } + + static async ValueTask OnAfterRequest(RestResponse response, CancellationToken cancellationToken) { + if (response.Request.Interceptors == null) return; + + foreach (var interceptor in response.Request.Interceptors) { + await interceptor.AfterRequest(response, cancellationToken).ConfigureAwait(false); + } + } + + record HttpResponse( + HttpResponseMessage? ResponseMessage, + Uri Url, + CookieContainer? CookieContainer, + Exception? Exception, + CancellationToken TimeoutToken + ) : IDisposable { + public void Dispose() => ResponseMessage?.Dispose(); + } + + internal static HttpMethod AsHttpMethod(Method method) + => method switch { + Method.Get => HttpMethod.Get, + Method.Post => HttpMethod.Post, + Method.Put => HttpMethod.Put, + Method.Delete => HttpMethod.Delete, + Method.Head => HttpMethod.Head, + Method.Options => HttpMethod.Options, +#if NET + Method.Patch => HttpMethod.Patch, +#else + Method.Patch => new("PATCH"), +#endif + Method.Merge => new("MERGE"), + Method.Copy => new("COPY"), + Method.Search => new("SEARCH"), + _ => throw new ArgumentOutOfRangeException(nameof(method)) + }; +} diff --git a/src/RestSharp/RestClient.Extensions.Delete.cs b/src/RestSharp/RestClient.Extensions.Delete.cs new file mode 100644 index 000000000..c92636545 --- /dev/null +++ b/src/RestSharp/RestClient.Extensions.Delete.cs @@ -0,0 +1,179 @@ +// Copyright (c) .NET Foundation and Contributors +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// http://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. +// + +namespace RestSharp; + +public static partial class RestClientExtensions { + /// + extension(IRestClient client) { + /// + /// Executes a DELETE-style request asynchronously, authenticating if needed + /// + /// Request to be executed + /// Cancellation token + public Task ExecuteDeleteAsync(RestRequest request, CancellationToken cancellationToken = default) + => client.ExecuteAsync(request, Method.Delete, cancellationToken); + + /// + /// Executes a DELETE-style request asynchronously, authenticating if needed + /// + /// Request resource + /// Cancellation token + public Task ExecuteDeleteAsync(string resource, CancellationToken cancellationToken = default) + => client.ExecuteAsync(new(resource), Method.Delete, cancellationToken); + + /// + /// Executes a DELETE-style synchronously, authenticating if needed + /// + /// Request resource + public RestResponse ExecuteDelete(string resource) + => AsyncHelpers.RunSync(() => client.ExecuteDeleteAsync(resource)); + + /// + /// Executes a DELETE-style synchronously, authenticating if needed + /// + /// Request to be executed + public RestResponse ExecuteDelete(RestRequest request) + => AsyncHelpers.RunSync(() => client.ExecuteAsync(request, Method.Delete)); + + /// + /// Executes a DELETE-style request asynchronously, authenticating if needed. + /// The response content then gets deserialized to T. + /// + /// Target deserialization type + /// Request to be executed + /// The cancellation token + /// Deserialized response content + public Task> ExecuteDeleteAsync( + RestRequest request, + CancellationToken cancellationToken = default + ) + => client.ExecuteAsync(request, Method.Delete, cancellationToken); + + /// + /// Executes a DELETE-style request asynchronously, authenticating if needed. + /// The response content then gets deserialized to T. + /// + /// Target deserialization type + /// Request resource + /// The cancellation token + /// Deserialized response content + public Task> ExecuteDeleteAsync( + string resource, + CancellationToken cancellationToken = default + ) + => client.ExecuteAsync(new(resource), Method.Delete, cancellationToken); + + /// + /// Executes a DELETE-style request synchronously, authenticating if needed. + /// The response content then gets deserialized to T. + /// + /// Target deserialization type + /// Request to be executed + /// Deserialized response content + public RestResponse ExecuteDelete(RestRequest request) + => AsyncHelpers.RunSync(() => client.ExecuteAsync(request, Method.Delete)); + + /// + /// Executes a DELETE-style request synchronously, authenticating if needed. + /// The response content then gets deserialized to T. + /// + /// Target deserialization type + /// Request resource + /// Deserialized response content + public RestResponse ExecuteDelete(string resource) + => AsyncHelpers.RunSync(() => client.ExecuteDeleteAsync(resource)); + + /// + /// Execute the request using DELETE HTTP method. Exception will be thrown if the request does not succeed. + /// The response data is deserialized to the Data property of the returned response object. + /// + /// The request + /// Cancellation token + /// Expected result type + /// + public async Task DeleteAsync(RestRequest request, CancellationToken cancellationToken = default) { + var response = await client.ExecuteAsync(request, Method.Delete, cancellationToken).ConfigureAwait(false); + return response.ThrowIfError().Data; + } + + /// + /// Execute the request using DELETE HTTP method. Exception will be thrown if the request does not succeed. + /// The response data is deserialized to the Data property of the returned response object. + /// + /// Request resource + /// Cancellation token + /// Expected result type + /// + public async Task DeleteAsync(string resource, CancellationToken cancellationToken = default) { + var response = await client.ExecuteAsync(new(resource), Method.Delete, cancellationToken).ConfigureAwait(false); + return response.ThrowIfError().Data; + } + + /// + /// Execute the request using DELETE HTTP method. Exception will be thrown if the request does not succeed. + /// The response data is deserialized to the Data property of the returned response object. + /// + /// The request + /// Expected result type + /// + public T? Delete(RestRequest request) => AsyncHelpers.RunSync(() => client.DeleteAsync(request)); + + /// + /// Execute the request using DELETE HTTP method. Exception will be thrown if the request does not succeed. + /// The response data is deserialized to the Data property of the returned response object. + /// + /// Request resource + /// Expected result type + /// + public T? Delete(string resource) => AsyncHelpers.RunSync(() => client.DeleteAsync(resource)); + + /// + /// Execute the request using DELETE HTTP method. Exception will be thrown if the request does not succeed. + /// + /// Request resource + /// Cancellation token + /// + public async Task DeleteAsync(string resource, CancellationToken cancellationToken = default) { + var response = await client.ExecuteAsync(new(resource), Method.Delete, cancellationToken).ConfigureAwait(false); + return response.ThrowIfError(); + } + + /// + /// Execute the request using DELETE HTTP method. Exception will be thrown if the request does not succeed. + /// + /// Request resource + /// + public RestResponse Delete(string resource) => AsyncHelpers.RunSync(() => client.DeleteAsync(resource)); + + /// + /// Execute the request using DELETE HTTP method. Exception will be thrown if the request does not succeed. + /// + /// The request + /// Cancellation token + /// + public async Task DeleteAsync(RestRequest request, CancellationToken cancellationToken = default) { + var response = await client.ExecuteAsync(request, Method.Delete, cancellationToken).ConfigureAwait(false); + return response.ThrowIfError(); + } + + /// + /// Execute the request using DELETE HTTP method. Exception will be thrown if the request does not succeed. + /// + /// The request + /// + public RestResponse Delete(RestRequest request) => AsyncHelpers.RunSync(() => client.DeleteAsync(request)); + } +} \ No newline at end of file diff --git a/src/RestSharp/RestClient.Extensions.Get.cs b/src/RestSharp/RestClient.Extensions.Get.cs new file mode 100644 index 000000000..1dae80183 --- /dev/null +++ b/src/RestSharp/RestClient.Extensions.Get.cs @@ -0,0 +1,210 @@ +// Copyright (c) .NET Foundation and Contributors +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// http://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. +// + +namespace RestSharp; + +public static partial class RestClientExtensions { + /// + extension(IRestClient client) { + /// + /// Executes a GET-style asynchronously, authenticating if needed. + /// + /// Request to be executed + /// Cancellation token + public Task ExecuteGetAsync(RestRequest request, CancellationToken cancellationToken = default) + => client.ExecuteAsync(request, Method.Get, cancellationToken); + + /// + /// Executes a GET-style asynchronously, authenticating if needed. + /// + /// Request resource + /// Cancellation token + public Task ExecuteGetAsync(string resource, CancellationToken cancellationToken = default) + => client.ExecuteAsync(new(resource), Method.Get, cancellationToken); + + /// + /// Executes a GET-style synchronously, authenticating if needed + /// + /// Request to be executed + public RestResponse ExecuteGet(RestRequest request) + => AsyncHelpers.RunSync(() => client.ExecuteAsync(request, Method.Get)); + + /// + /// Executes a GET-style request asynchronously, authenticating if needed. + /// The response content then gets deserialized to T. + /// + /// Target deserialization type + /// Request to be executed + /// Cancellation token + /// Deserialized response content + public Task> ExecuteGetAsync( + RestRequest request, + CancellationToken cancellationToken = default + ) + => client.ExecuteAsync(request, Method.Get, cancellationToken); + + /// + /// Executes a GET-style request to the specified resource URL asynchronously, authenticating if needed. + /// The response content then gets deserialized to T. + /// + /// Target deserialization type + /// Request resource + /// Cancellation token + /// Deserialized response content + public Task> ExecuteGetAsync( + string resource, + CancellationToken cancellationToken = default + ) + => client.ExecuteAsync(new(resource), Method.Get, cancellationToken); + + /// + /// Executes a GET-style request synchronously, authenticating if needed. + /// The response content then gets deserialized to T. + /// + /// Target deserialization type + /// Request to be executed + /// Deserialized response content + public RestResponse ExecuteGet(RestRequest request) + => AsyncHelpers.RunSync(() => client.ExecuteAsync(request, Method.Get)); + + /// + /// Executes a GET-style request synchronously, authenticating if needed. + /// The response content then gets deserialized to T. + /// + /// Target deserialization type + /// Request resource + /// Deserialized response content + public RestResponse ExecuteGet(string resource) + => AsyncHelpers.RunSync(() => client.ExecuteGetAsync(resource)); + + /// + /// Execute the request using GET HTTP method. Exception will be thrown if the request does not succeed. + /// + /// The request + /// Cancellation token + /// + public async Task GetAsync(RestRequest request, CancellationToken cancellationToken = default) { + var response = await client.ExecuteGetAsync(request, cancellationToken).ConfigureAwait(false); + return response.ThrowIfError(); + } + + /// + /// Execute the request using GET HTTP method. Exception will be thrown if the request does not succeed. + /// + /// The request + /// + public RestResponse Get(RestRequest request) => AsyncHelpers.RunSync(() => client.GetAsync(request)); + + /// + /// Execute the request using GET HTTP method. Exception will be thrown if the request does not succeed. + /// The response data is deserialized to the Data property of the returned response object. + /// + /// The request + /// Cancellation token + /// Expected result type + /// + public async Task GetAsync(RestRequest request, CancellationToken cancellationToken = default) { + var response = await client.ExecuteGetAsync(request, cancellationToken).ConfigureAwait(false); + return response.ThrowIfError().Data; + } + + /// + /// Execute the request using GET HTTP method. Exception will be thrown if the request does not succeed. + /// The response data is deserialized to the Data property of the returned response object. + /// + /// The request + /// Expected result type + /// + public T? Get(RestRequest request) => AsyncHelpers.RunSync(() => client.GetAsync(request)); + + /// + /// Calls the URL specified in the resource parameter, expecting a JSON response back. Deserializes and returns the response. + /// + /// Resource URL + /// Cancellation token + /// Response object type + /// + public Task GetAsync(string resource, CancellationToken cancellationToken = default) + => client.GetAsync(new RestRequest(resource), cancellationToken); + + [Obsolete("Use GetAsync instead")] + public Task GetJsonAsync( + string resource, + CancellationToken cancellationToken = default + ) + => client.GetAsync(resource, cancellationToken); + + [Obsolete("Use Get instead")] + public TResponse? GetJson(string resource) + => AsyncHelpers.RunSync(() => client.GetAsync(resource)); + + /// + /// Calls the URL specified in the resource parameter, expecting a JSON response back. Deserializes and returns the response. + /// + /// Resource URL + /// Response object type + /// Deserialized response object + public TResponse? Get(string resource) + => AsyncHelpers.RunSync(() => client.GetAsync(resource)); + + /// + /// Calls the URL specified in the resource parameter, expecting a JSON response back. Deserializes and returns the response. + /// + /// Resource URL + /// Parameters to pass to the request + /// Cancellation token + /// Response object type + /// Deserialized response object + public Task GetAsync( + string resource, + object parameters, + CancellationToken cancellationToken = default + ) { + var props = parameters.GetProperties(); + var request = new RestRequest(resource); + + foreach (var prop in props) { + Parameter parameter = resource.Contains($"{prop.Name}") + ? new UrlSegmentParameter(prop.Name, prop.Value!, prop.Encode) + : new QueryParameter(prop.Name, prop.Value, prop.Encode); + request.AddParameter(parameter); + } + + return client.GetAsync(request, cancellationToken); + } + + [Obsolete("Use GetAsync instead")] + public Task GetJsonAsync( + string resource, + object parameters, + CancellationToken cancellationToken = default + ) + => client.GetAsync(resource, parameters, cancellationToken); + + /// + /// Calls the URL specified in the resource parameter, expecting a JSON response back. Deserializes and returns the response. + /// + /// Resource URL + /// Parameters to pass to the request + /// Response object type + /// Deserialized response object + public TResponse? Get(string resource, object parameters) + => AsyncHelpers.RunSync(() => client.GetAsync(resource, parameters)); + + [Obsolete("Use Get instead")] + public TResponse? GetJson(string resource, object parameters) + => client.Get(resource, parameters); + } +} \ No newline at end of file diff --git a/src/RestSharp/RestClient.Extensions.Head.cs b/src/RestSharp/RestClient.Extensions.Head.cs new file mode 100644 index 000000000..ee4a9421a --- /dev/null +++ b/src/RestSharp/RestClient.Extensions.Head.cs @@ -0,0 +1,100 @@ +// Copyright (c) .NET Foundation and Contributors +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// http://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. +// + +namespace RestSharp; + +public static partial class RestClientExtensions { + /// + extension(IRestClient client) { + /// + /// Executes a HEAD-style request asynchronously, authenticating if needed + /// + /// Request to be executed + /// Cancellation token + public Task ExecuteHeadAsync(RestRequest request, CancellationToken cancellationToken = default) + => client.ExecuteAsync(request, Method.Head, cancellationToken); + + /// + /// Executes a HEAD-style synchronously, authenticating if needed + /// + /// Request to be executed + public RestResponse ExecuteHead(RestRequest request) + => AsyncHelpers.RunSync(() => client.ExecuteAsync(request, Method.Head)); + + /// + /// Executes a HEAD-style request asynchronously, authenticating if needed. + /// The response content then gets deserialized to T. + /// + /// Target deserialization type + /// Request to be executed + /// The cancellation token + /// Deserialized response content + public Task> ExecuteHeadAsync( + RestRequest request, + CancellationToken cancellationToken = default + ) + => client.ExecuteAsync(request, Method.Head, cancellationToken); + + /// + /// Executes a HEAD-style request synchronously, authenticating if needed. + /// The response content then gets deserialized to T. + /// + /// Target deserialization type + /// Request to be executed + /// Deserialized response content + public RestResponse ExecuteHead(RestRequest request) + => AsyncHelpers.RunSync(() => client.ExecuteAsync(request, Method.Head)); + + /// + /// Execute the request using HEAD HTTP method. Exception will be thrown if the request does not succeed. + /// The response data is deserialized to the Data property of the returned response object. + /// + /// The request + /// Cancellation token + /// Expected result type + /// + public async Task HeadAsync(RestRequest request, CancellationToken cancellationToken = default) { + var response = await client.ExecuteAsync(request, Method.Head, cancellationToken).ConfigureAwait(false); + return response.ThrowIfError().Data; + } + + /// + /// Execute the request using HEAD HTTP method. Exception will be thrown if the request does not succeed. + /// The response data is deserialized to the Data property of the returned response object. + /// + /// The request + /// Expected result type + /// + public T? Head(RestRequest request) => AsyncHelpers.RunSync(() => client.HeadAsync(request)); + + /// + /// Execute the request using HEAD HTTP method. Exception will be thrown if the request does not succeed. + /// + /// The request + /// Cancellation token + /// + public async Task HeadAsync(RestRequest request, CancellationToken cancellationToken = default) { + var response = await client.ExecuteAsync(request, Method.Head, cancellationToken).ConfigureAwait(false); + return response.ThrowIfError(); + } + + /// + /// Execute the request using HEAD HTTP method. Exception will be thrown if the request does not succeed. + /// + /// The request + /// + public RestResponse Head(RestRequest request) => AsyncHelpers.RunSync(() => client.HeadAsync(request)); + } +} diff --git a/src/RestSharp/RestClient.Extensions.Options.cs b/src/RestSharp/RestClient.Extensions.Options.cs new file mode 100644 index 000000000..82882394a --- /dev/null +++ b/src/RestSharp/RestClient.Extensions.Options.cs @@ -0,0 +1,100 @@ +// Copyright (c) .NET Foundation and Contributors +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// http://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. +// + +namespace RestSharp; + +public static partial class RestClientExtensions { + /// + extension(IRestClient client) { + /// + /// Executes an OPTIONS-style request asynchronously, authenticating if needed + /// + /// Request to be executed + /// Cancellation token + public Task ExecuteOptionsAsync(RestRequest request, CancellationToken cancellationToken = default) + => client.ExecuteAsync(request, Method.Options, cancellationToken); + + /// + /// Executes a OPTIONS-style synchronously, authenticating if needed + /// + /// Request to be executed + public RestResponse ExecuteOptions(RestRequest request) + => AsyncHelpers.RunSync(() => client.ExecuteAsync(request, Method.Options)); + + /// + /// Executes a OPTIONS-style request asynchronously, authenticating if needed. + /// The response content then gets deserialized to T. + /// + /// Target deserialization type + /// Request to be executed + /// The cancellation token + /// Deserialized response content + public Task> ExecuteOptionsAsync( + RestRequest request, + CancellationToken cancellationToken = default + ) + => client.ExecuteAsync(request, Method.Options, cancellationToken); + + /// + /// Executes a OPTIONS-style request synchronously, authenticating if needed. + /// The response content then gets deserialized to T. + /// + /// Target deserialization type + /// Request to be executed + /// Deserialized response content + public RestResponse ExecuteOptions(RestRequest request) + => AsyncHelpers.RunSync(() => client.ExecuteAsync(request, Method.Options)); + + /// + /// Execute the request using OPTIONS HTTP method. Exception will be thrown if the request does not succeed. + /// + /// The request + /// Cancellation token + /// + public async Task OptionsAsync(RestRequest request, CancellationToken cancellationToken = default) { + var response = await client.ExecuteAsync(request, Method.Options, cancellationToken).ConfigureAwait(false); + return response.ThrowIfError(); + } + + /// + /// Execute the request using OPTIONS HTTP method. Exception will be thrown if the request does not succeed. + /// + /// The request + /// + public RestResponse Options(RestRequest request) => AsyncHelpers.RunSync(() => client.OptionsAsync(request)); + + /// + /// Execute the request using OPTIONS HTTP method. Exception will be thrown if the request does not succeed. + /// The response data is deserialized to the Data property of the returned response object. + /// + /// The request + /// Cancellation token + /// Expected result type + /// + public async Task OptionsAsync(RestRequest request, CancellationToken cancellationToken = default) { + var response = await client.ExecuteAsync(request, Method.Options, cancellationToken).ConfigureAwait(false); + return response.ThrowIfError().Data; + } + + /// + /// Execute the request using OPTIONS HTTP method. Exception will be thrown if the request does not succeed. + /// The response data is deserialized to the Data property of the returned response object. + /// + /// The request + /// Expected result type + /// + public T? Options(RestRequest request) => AsyncHelpers.RunSync(() => client.OptionsAsync(request)); + } +} diff --git a/src/RestSharp/RestClient.Extensions.Params.cs b/src/RestSharp/RestClient.Extensions.Params.cs new file mode 100644 index 000000000..cd3bb635c --- /dev/null +++ b/src/RestSharp/RestClient.Extensions.Params.cs @@ -0,0 +1,94 @@ +// Copyright (c) .NET Foundation and Contributors +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// http://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. +// + +namespace RestSharp; + +public static partial class RestClientExtensions { + /// instance + extension(IRestClient client) { + /// + /// Add a parameter to use on every request made with this client instance + /// + /// to add + /// + public IRestClient AddDefaultParameter(Parameter parameter) { + client.DefaultParameters.AddParameter(parameter); + return client; + } + + /// + /// Adds a default HTTP parameter (QueryString for GET, DELETE, OPTIONS and HEAD; Encoded form for POST and PUT) + /// Used on every request made by this client instance + /// + /// Name of the parameter + /// Value of the parameter + /// This request + public IRestClient AddDefaultParameter(string name, string value) + => client.AddDefaultParameter(new GetOrPostParameter(name, value)); + + /// + /// Adds a default parameter to the client options. There are four types of parameters: + /// - GetOrPost: Either a QueryString value or encoded form value based on method + /// - HttpHeader: Adds the name/value pair to the HTTP request's Headers collection + /// - UrlSegment: Inserted into URL if there is a matching url token e.g. {AccountId} + /// - RequestBody: Used by AddBody() (not recommended to use directly) + /// Used on every request made by this client instance + /// + /// Name of the parameter + /// Value of the parameter + /// The type of parameter to add + /// This request + public IRestClient AddDefaultParameter(string name, object value, ParameterType type) + => client.AddDefaultParameter(Parameter.CreateParameter(name, value, type)); + + /// + /// Adds a default header to the RestClient. Used on every request made by this client instance. + /// + /// Name of the header to add + /// Value of the header to add + /// + public IRestClient AddDefaultHeader(string name, string value) + => client.AddDefaultParameter(new HeaderParameter(name, value)); + + /// + /// Adds default headers to the RestClient. Used on every request made by this client instance. + /// + /// Dictionary containing the Names and Values of the headers to add + /// + public IRestClient AddDefaultHeaders(Dictionary headers) { + foreach (var header in headers) client.AddDefaultParameter(new HeaderParameter(header.Key, header.Value)); + + return client; + } + + /// + /// Adds a default URL segment parameter to the RestClient. Used on every request made by this client instance. + /// + /// Name of the segment to add + /// Value of the segment to add + /// + public IRestClient AddDefaultUrlSegment(string name, string value) + => client.AddDefaultParameter(new UrlSegmentParameter(name, value)); + + /// + /// Adds a default URL query parameter to the RestClient. Used on every request made by this client instance. + /// + /// Name of the query parameter to add + /// Value of the query parameter to add + /// + public IRestClient AddDefaultQueryParameter(string name, string value) + => client.AddDefaultParameter(new QueryParameter(name, value)); + } +} diff --git a/src/RestSharp/RestClient.Extensions.Patch.cs b/src/RestSharp/RestClient.Extensions.Patch.cs new file mode 100644 index 000000000..129f5fc19 --- /dev/null +++ b/src/RestSharp/RestClient.Extensions.Patch.cs @@ -0,0 +1,100 @@ +// Copyright (c) .NET Foundation and Contributors +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// http://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. +// + +namespace RestSharp; + +public static partial class RestClientExtensions { + /// + extension(IRestClient client) { + /// + /// Executes a PUT-style request asynchronously, authenticating if needed. + /// The response content then gets deserialized to T. + /// + /// Target deserialization type + /// Request to be executed + /// The cancellation token + /// Deserialized response content + public Task> ExecutePatchAsync( + RestRequest request, + CancellationToken cancellationToken = default + ) + => client.ExecuteAsync(request, Method.Patch, cancellationToken); + + /// + /// Executes a PATCH-style request synchronously, authenticating if needed. + /// The response content then gets deserialized to T. + /// + /// Target deserialization type + /// Request to be executed + /// Deserialized response content + public RestResponse ExecutePatch(RestRequest request) => AsyncHelpers.RunSync(() => client.ExecuteAsync(request, Method.Patch)); + + /// + /// Executes a PATCH-style request asynchronously, authenticating if needed + /// + /// Request to be executed + /// Cancellation token + public Task ExecutePatchAsync(RestRequest request, CancellationToken cancellationToken = default) + => client.ExecuteAsync(request, Method.Patch, cancellationToken); + + /// + /// Executes a PATCH-style synchronously, authenticating if needed + /// + /// Request to be executed + public RestResponse ExecutePatch(RestRequest request) => AsyncHelpers.RunSync(() => client.ExecuteAsync(request, Method.Patch)); + + /// + /// Execute the request using PATCH HTTP method. Exception will be thrown if the request does not succeed. + /// The response data is deserialized to the Data property of the returned response object. + /// + /// The request + /// Cancellation token + /// Expected result type + /// + public async Task PatchAsync(RestRequest request, CancellationToken cancellationToken = default) { + var response = await client.ExecuteAsync(request, Method.Patch, cancellationToken).ConfigureAwait(false); + return response.ThrowIfError().Data; + } + + /// + /// Execute the request using PATCH HTTP method. Exception will be thrown if the request does not succeed. + /// The response data is deserialized to the Data property of the returned response object. + /// + /// The request + /// Expected result type + /// + [PublicAPI] + public T? Patch(RestRequest request) => AsyncHelpers.RunSync(() => client.PatchAsync(request)); + + /// + /// Execute the request using PATCH HTTP method. Exception will be thrown if the request does not succeed. + /// + /// The request + /// Cancellation token + /// + public async Task PatchAsync(RestRequest request, CancellationToken cancellationToken = default) { + var response = await client.ExecuteAsync(request, Method.Patch, cancellationToken).ConfigureAwait(false); + return response.ThrowIfError(); + } + + /// + /// Execute the request using PATCH HTTP method. Exception will be thrown if the request does not succeed. + /// + /// The request + /// + [PublicAPI] + public RestResponse Patch(RestRequest request) => AsyncHelpers.RunSync(() => client.PatchAsync(request)); + } +} \ No newline at end of file diff --git a/src/RestSharp/RestClient.Extensions.Post.cs b/src/RestSharp/RestClient.Extensions.Post.cs new file mode 100644 index 000000000..b6eb436f0 --- /dev/null +++ b/src/RestSharp/RestClient.Extensions.Post.cs @@ -0,0 +1,159 @@ +// Copyright (c) .NET Foundation and Contributors +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// http://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. +// + +namespace RestSharp; + +public static partial class RestClientExtensions { + /// + extension(IRestClient client) { + /// + /// Executes a POST-style request asynchronously, authenticating if needed. + /// The response content then gets deserialized to T. + /// + /// Target deserialization type + /// Request to be executed + /// The cancellation token + /// Deserialized response content + public Task> ExecutePostAsync( + RestRequest request, + CancellationToken cancellationToken = default + ) + => client.ExecuteAsync(request, Method.Post, cancellationToken); + + /// + /// Executes a POST-style request synchronously, authenticating if needed. + /// The response content then gets deserialized to T. + /// + /// Target deserialization type + /// Request to be executed + /// Deserialized response content + public RestResponse ExecutePost(RestRequest request) => AsyncHelpers.RunSync(() => client.ExecuteAsync(request, Method.Post)); + + /// + /// Executes a POST-style asynchronously, authenticating if needed + /// + /// Request to be executed + /// Cancellation token + public Task ExecutePostAsync(RestRequest request, CancellationToken cancellationToken = default) + => client.ExecuteAsync(request, Method.Post, cancellationToken); + + /// + /// Executes a POST-style synchronously, authenticating if needed + /// + /// Request to be executed + public RestResponse ExecutePost(RestRequest request) => AsyncHelpers.RunSync(() => client.ExecuteAsync(request, Method.Post)); + + /// + /// Execute the request using POST HTTP method. Exception will be thrown if the request does not succeed. + /// The response data is deserialized to the Data property of the returned response object. + /// + /// The request + /// Cancellation token + /// Expected result type + /// + public async Task PostAsync(RestRequest request, CancellationToken cancellationToken = default) { + var response = await client.ExecutePostAsync(request, cancellationToken).ConfigureAwait(false); + return response.ThrowIfError().Data; + } + + /// + /// Execute the request using POST HTTP method. Exception will be thrown if the request does not succeed. + /// The response data is deserialized to the Data property of the returned response object. + /// + /// The request + /// Expected result type + /// + public T? Post(RestRequest request) => AsyncHelpers.RunSync(() => client.PostAsync(request)); + + /// + /// Execute the request using POST HTTP method. Exception will be thrown if the request does not succeed. + /// + /// The request + /// Cancellation token + /// + public async Task PostAsync(RestRequest request, CancellationToken cancellationToken = default) { + var response = await client.ExecutePostAsync(request, cancellationToken).ConfigureAwait(false); + return response.ThrowIfError(); + } + + /// + /// Execute the request using POST HTTP method. Exception will be thrown if the request does not succeed. + /// + /// The request + /// + public RestResponse Post(RestRequest request) => AsyncHelpers.RunSync(() => client.PostAsync(request)); + + /// + /// Serializes the request object to JSON and makes a POST call to the resource specified in the resource parameter. + /// Expects a JSON response back, deserializes it to TResponse type and returns it. + /// + /// Resource URL + /// Request object, must be serializable to JSON + /// Cancellation token + /// Request object type + /// Response object type + /// Deserialized response object + public Task PostJsonAsync( + string resource, + TRequest request, + CancellationToken cancellationToken = default + ) where TRequest : class { + var restRequest = new RestRequest(resource).AddJsonBody(request); + return client.PostAsync(restRequest, cancellationToken); + } + + /// + /// Serializes the request object to JSON and makes a POST call to the resource specified in the resource parameter. + /// Expects a JSON response back, deserializes it to TResponse type and returns it. + /// + /// Resource URL + /// Request object, must be serializable to JSON + /// Request object type + /// Response object type + /// Deserialized response object + public TResponse? PostJson(string resource, TRequest request) where TRequest : class + => AsyncHelpers.RunSync(() => client.PostJsonAsync(resource, request)); + + /// + /// Serializes the request object to JSON and makes a POST call to the resource specified in the resource parameter. + /// Expects no response back, just the status code. + /// + /// Resource URL + /// Request object, must be serializable to JSON + /// Cancellation token + /// Request object type + /// Response status code + public async Task PostJsonAsync( + string resource, + TRequest request, + CancellationToken cancellationToken = default + ) where TRequest : class { + var restRequest = new RestRequest(resource).AddJsonBody(request); + var response = await client.PostAsync(restRequest, cancellationToken).ConfigureAwait(false); + return response.StatusCode; + } + + /// + /// Serializes the request object to JSON and makes a POST call to the resource specified in the resource parameter. + /// Expects no response back, just the status code. + /// + /// Resource URL + /// Request object, must be serializable to JSON + /// Request object type + /// Response status code + public HttpStatusCode PostJson(string resource, TRequest request) where TRequest : class + => AsyncHelpers.RunSync(() => client.PostJsonAsync(resource, request)); + } +} \ No newline at end of file diff --git a/src/RestSharp/RestClient.Extensions.Put.cs b/src/RestSharp/RestClient.Extensions.Put.cs new file mode 100644 index 000000000..e404e4e34 --- /dev/null +++ b/src/RestSharp/RestClient.Extensions.Put.cs @@ -0,0 +1,159 @@ +// Copyright (c) .NET Foundation and Contributors +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// http://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. +// + +namespace RestSharp; + +public static partial class RestClientExtensions { + /// + extension(IRestClient client) { + /// + /// Executes a PUT-style request asynchronously, authenticating if needed. + /// The response content then gets deserialized to T. + /// + /// Target deserialization type + /// Request to be executed + /// The cancellation token + /// Deserialized response content + public Task> ExecutePutAsync( + RestRequest request, + CancellationToken cancellationToken = default + ) + => client.ExecuteAsync(request, Method.Put, cancellationToken); + + /// + /// Executes a PUT-style request synchronously, authenticating if needed. + /// The response content then gets deserialized to T. + /// + /// Target deserialization type + /// Request to be executed + /// Deserialized response content + public RestResponse ExecutePut(RestRequest request) => AsyncHelpers.RunSync(() => client.ExecuteAsync(request, Method.Put)); + + /// + /// Executes a PUP-style request asynchronously, authenticating if needed + /// + /// Request to be executed + /// Cancellation token + public Task ExecutePutAsync(RestRequest request, CancellationToken cancellationToken = default) + => client.ExecuteAsync(request, Method.Put, cancellationToken); + + /// + /// Executes a PUT-style synchronously, authenticating if needed + /// + /// Request to be executed + public RestResponse ExecutePut(RestRequest request) => AsyncHelpers.RunSync(() => client.ExecuteAsync(request, Method.Put)); + + /// + /// Execute the request using PUT HTTP method. Exception will be thrown if the request does not succeed. + /// The response data is deserialized to the Data property of the returned response object. + /// + /// The request + /// Cancellation token + /// Expected result type + /// Deserialaized response + public async Task PutAsync(RestRequest request, CancellationToken cancellationToken = default) { + var response = await client.ExecuteAsync(request, Method.Put, cancellationToken).ConfigureAwait(false); + return response.ThrowIfError().Data; + } + + /// + /// Execute the request using PUT HTTP method. Exception will be thrown if the request does not succeed. + /// The response data is deserialized to the Data property of the returned response object. + /// + /// The request + /// Expected result type + /// + public T? Put(RestRequest request) => AsyncHelpers.RunSync(() => client.PutAsync(request)); + + /// + /// Execute the request using PUT HTTP method. Exception will be thrown if the request does not succeed. + /// + /// The request + /// Cancellation token + /// + public async Task PutAsync(RestRequest request, CancellationToken cancellationToken = default) { + var response = await client.ExecuteAsync(request, Method.Put, cancellationToken).ConfigureAwait(false); + return response.ThrowIfError(); + } + + /// + /// Execute the request using PUT HTTP method. Exception will be thrown if the request does not succeed. + /// + /// The request + /// + public RestResponse Put(RestRequest request) => AsyncHelpers.RunSync(() => client.PutAsync(request)); + + /// + /// Serializes the request object to JSON and makes a PUT call to the resource specified in the resource parameter. + /// Expects a JSON response back, deserializes it to TResponse type and returns it. + /// + /// Resource URL + /// Request object, must be serializable to JSON + /// Cancellation token + /// Request object type + /// Response object type + /// Deserialized response object + public Task PutJsonAsync( + string resource, + TRequest request, + CancellationToken cancellationToken = default + ) where TRequest : class { + var restRequest = new RestRequest(resource).AddJsonBody(request); + return client.PutAsync(restRequest, cancellationToken); + } + + /// + /// Serializes the request object to JSON and makes a PUT call to the resource specified in the resource parameter. + /// Expects a JSON response back, deserializes it to TResponse type and returns it. + /// + /// Resource URL + /// Request object, must be serializable to JSON + /// Request object type + /// Response object type + /// Deserialized response object + public TResponse? PutJson(string resource, TRequest request) where TRequest : class + => AsyncHelpers.RunSync(() => client.PutJsonAsync(resource, request)); + + /// + /// Serializes the request object to JSON and makes a PUT call to the resource specified in the resource parameter. + /// Expects no response back, just the status code. + /// + /// Resource URL + /// Request object, must be serializable to JSON + /// Cancellation token + /// Request object type + /// Response status code + public async Task PutJsonAsync( + string resource, + TRequest request, + CancellationToken cancellationToken = default + ) where TRequest : class { + var restRequest = new RestRequest(resource).AddJsonBody(request); + var response = await client.PutAsync(restRequest, cancellationToken).ConfigureAwait(false); + return response.StatusCode; + } + + /// + /// Serializes the request object to JSON and makes a PUT call to the resource specified in the resource parameter. + /// Expects no response back, just the status code. + /// + /// Resource URL + /// Request object, must be serializable to JSON + /// Request object type + /// Response status code + public HttpStatusCode PutJson(string resource, TRequest request) where TRequest : class + => AsyncHelpers.RunSync(() => client.PutJsonAsync(resource, request)); + } +} \ No newline at end of file diff --git a/src/RestSharp/RestClient.Extensions.cs b/src/RestSharp/RestClient.Extensions.cs new file mode 100644 index 000000000..80d1263f0 --- /dev/null +++ b/src/RestSharp/RestClient.Extensions.cs @@ -0,0 +1,186 @@ +// Copyright (c) .NET Foundation and Contributors +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// http://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. + +using System.Runtime.CompilerServices; +using RestSharp.Extensions; + +namespace RestSharp; + +[PublicAPI] +public static partial class RestClientExtensions { + /// + extension(IRestClient client) { + [PublicAPI] + [Obsolete("Please use the async overload with a cancellation token")] + public RestResponse Deserialize(RestResponse response) + => AsyncHelpers.RunSync(() + => client.Serializers.Deserialize(response.Request, response, client.Options, CancellationToken.None).AsTask() + ); + + [PublicAPI] + public ValueTask> Deserialize(RestResponse response, CancellationToken cancellationToken) + => client.Serializers.Deserialize(response.Request, response, client.Options, cancellationToken); + + /// + /// Executes the request asynchronously, authenticating if needed + /// + /// Target deserialization type + /// Request to be executed + /// Cancellation token + public async Task> ExecuteAsync( + RestRequest request, + CancellationToken cancellationToken = default + ) { + Ensure.NotNull(request, nameof(request)); + + var response = await client.ExecuteAsync(request, cancellationToken).ConfigureAwait(false); + return await client.Serializers.Deserialize(request, response, client.Options, cancellationToken); + } + + /// + /// Executes the request synchronously, authenticating if needed + /// + /// Target deserialization type + /// Request to be executed + public RestResponse Execute(RestRequest request) => AsyncHelpers.RunSync(() => client.ExecuteAsync(request)); + + /// + /// Executes the request synchronously, authenticating if needed + /// + /// Request to be executed + public RestResponse Execute(RestRequest request) => AsyncHelpers.RunSync(() => client.ExecuteAsync(request)); + + /// + /// Executes the request asynchronously, authenticating if needed + /// + /// Request to be executed + /// Override the request method + /// Cancellation token + public Task ExecuteAsync( + RestRequest request, + Method httpMethod, + CancellationToken cancellationToken = default + ) { + Ensure.NotNull(request, nameof(request)); + + request.Method = httpMethod; + return client.ExecuteAsync(request, cancellationToken); + } + + /// + /// Executes the request synchronously, authenticating if needed + /// + /// Request to be executed + /// Override the request method + public RestResponse Execute(RestRequest request, Method httpMethod) => AsyncHelpers.RunSync(() => client.ExecuteAsync(request, httpMethod)); + + /// + /// Executes the request asynchronously, authenticating if needed + /// + /// Target deserialization type + /// Request to be executed + /// Override the request method + /// Cancellation token + public Task> ExecuteAsync( + RestRequest request, + Method httpMethod, + CancellationToken cancellationToken = default + ) { + Ensure.NotNull(request, nameof(request)); + + request.Method = httpMethod; + return client.ExecuteAsync(request, cancellationToken); + } + + /// + /// Executes the request synchronously, authenticating if needed + /// + /// Target deserialization type + /// Request to be executed + /// Override the request method + public RestResponse Execute(RestRequest request, Method httpMethod) + => AsyncHelpers.RunSync(() => client.ExecuteAsync(request, httpMethod)); + + /// + /// A specialized method to download files. + /// + /// Pre-configured request instance. + /// + /// The downloaded file. + [PublicAPI] + public async Task DownloadDataAsync(RestRequest request, CancellationToken cancellationToken = default) { +#if NET + await using var stream = await client.DownloadStreamAsync(request, cancellationToken).ConfigureAwait(false); +#else + using var stream = await client.DownloadStreamAsync(request, cancellationToken).ConfigureAwait(false); +#endif + return stream == null ? null : await stream.ReadAsBytes(cancellationToken).ConfigureAwait(false); + } + + /// + /// A specialized method to download files as streams. + /// + /// Pre-configured request instance. + /// The cancellation token + /// The downloaded stream. + [PublicAPI] + public Stream? DownloadStream(RestRequest request, CancellationToken cancellationToken = default) + => AsyncHelpers.RunSync(() => client.DownloadStreamAsync(request, cancellationToken)); + + /// + /// A specialized method to download files. + /// + /// Pre-configured request instance. + /// The downloaded file. + public byte[]? DownloadData(RestRequest request) => AsyncHelpers.RunSync(() => client.DownloadDataAsync(request)); + + /// + /// Reads a stream returned by the specified endpoint, deserializes each line to JSON and returns each object asynchronously. + /// It is required for each JSON object to be returned in a single line. + /// + /// + /// + /// + /// + [PublicAPI] + public async IAsyncEnumerable StreamJsonAsync( + string resource, + [EnumeratorCancellation] CancellationToken cancellationToken + ) { + var request = new RestRequest(resource); + +#if NET + await using var stream = await client.DownloadStreamAsync(request, cancellationToken).ConfigureAwait(false); +#else + using var stream = await client.DownloadStreamAsync(request, cancellationToken).ConfigureAwait(false); +#endif + if (stream == null) yield break; + + var serializer = client.Serializers.GetSerializer(DataFormat.Json); + + using var reader = new StreamReader(stream); + +#if NET7_0_OR_GREATER + while (await reader.ReadLineAsync(cancellationToken) is { } line && !cancellationToken.IsCancellationRequested) { +#else + while (await reader.ReadLineAsync() is { } line && !cancellationToken.IsCancellationRequested) { +#endif + if (string.IsNullOrWhiteSpace(line)) continue; + + var response = new RestResponse(request) { Content = line }; + yield return serializer.Deserializer.Deserialize(response)!; + } + } + } +} \ No newline at end of file diff --git a/src/RestSharp/RestClient.cs b/src/RestSharp/RestClient.cs new file mode 100644 index 000000000..d67a6fb7f --- /dev/null +++ b/src/RestSharp/RestClient.cs @@ -0,0 +1,297 @@ +// Copyright (c) .NET Foundation and Contributors +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// http://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. + +using System.Diagnostics.CodeAnalysis; +using System.Net.Http.Headers; +using System.Runtime.CompilerServices; +using RestSharp.Serializers; + +// ReSharper disable InvertIf + +// ReSharper disable VirtualMemberCallInConstructor +#pragma warning disable 618 + +namespace RestSharp; + +public delegate void ConfigureHeaders(HttpRequestHeaders headers); + +public delegate void ConfigureSerialization(SerializerConfig config); + +public delegate void ConfigureRestClient(RestClientOptions options); + +/// +/// Client to translate RestRequests into Http requests and process response result +/// +// ReSharper disable once ClassWithVirtualMembersNeverInherited.Global +public partial class RestClient : IRestClient { + /// + /// Content types that will be sent in the Accept header. The list is populated from the known serializers. + /// If you need to send something else by default, set this property to a different value. + /// + public string[] AcceptedContentTypes { + get; + [MethodImpl(MethodImplOptions.Synchronized)] + set; + } + + internal HttpClient HttpClient { get; } + + /// > + public ReadOnlyRestClientOptions Options { get; } + + /// > + public RestSerializers Serializers { get; private set; } + + /// + public DefaultParameters DefaultParameters { get; } + + /// + /// Creates an instance of RestClient using the provided + /// + /// Client options + /// Delegate to add default headers to the wrapped HttpClient instance + /// Delegate to configure serialization + /// Set to true if you wish to reuse the instance + public RestClient( + RestClientOptions options, + ConfigureHeaders? configureDefaultHeaders = null, + ConfigureSerialization? configureSerialization = null, + bool useClientFactory = false + ) { + if (useClientFactory && options.BaseUrl == null) { + throw new ArgumentException("BaseUrl must be set when using a client factory"); + } + + ConfigureSerializers(configureSerialization); + Options = new(options); + DefaultParameters = new(Options); + + if (useClientFactory) { + _disposeHttpClient = false; + HttpClient = SimpleClientFactory.GetClient(options.BaseUrl!, GetClient); + } + else { + _disposeHttpClient = true; + HttpClient = GetClient(); + } + + return; + + HttpClient GetClient() { + var handler = new HttpClientHandler(); + ConfigureHttpMessageHandler(handler, options); + var finalHandler = options.ConfigureMessageHandler?.Invoke(handler) ?? handler; + var httpClient = new HttpClient(finalHandler); + ConfigureHttpClient(httpClient, options); + + // We will use Options.Timeout in ExecuteAsInternalAsync method + httpClient.Timeout = Timeout.InfiniteTimeSpan; + + ConfigureDefaultParameters(options); + configureDefaultHeaders?.Invoke(httpClient.DefaultRequestHeaders); + return httpClient; + } + } + + static RestClientOptions ConfigureOptions(RestClientOptions options, ConfigureRestClient? configureRestClient) { + configureRestClient?.Invoke(options); + return options; + } + + /// + /// Creates an instance of RestClient using the default + /// + /// Delegate to configure the client options + /// Delegate to add default headers to the wrapped HttpClient instance + /// Delegate to configure serialization + /// Set to true if you wish to reuse the instance + public RestClient( + ConfigureRestClient? configureRestClient = null, + ConfigureHeaders? configureDefaultHeaders = null, + ConfigureSerialization? configureSerialization = null, + bool useClientFactory = false + ) : this(ConfigureOptions(new(), configureRestClient), configureDefaultHeaders, configureSerialization, useClientFactory) { } + + /// + /// + /// Creates an instance of RestClient using a specific BaseUrl for requests made by this client instance + /// + /// Base URI for the new client + /// Delegate to configure the client options + /// Delegate to add default headers to the wrapped HttpClient instance + /// Delegate to configure serialization + /// Set to true if you wish to reuse the instance + public RestClient( + Uri baseUrl, + ConfigureRestClient? configureRestClient = null, + ConfigureHeaders? configureDefaultHeaders = null, + ConfigureSerialization? configureSerialization = null, + bool useClientFactory = false + ) + : this( + ConfigureOptions(new() { BaseUrl = baseUrl }, configureRestClient), + configureDefaultHeaders, + configureSerialization, + useClientFactory + ) { } + + /// + /// Creates an instance of RestClient using a specific BaseUrl for requests made by this client instance + /// + /// Base URI for this new client as a string + /// Delegate to configure the client options + /// Delegate to add default headers to the wrapped HttpClient instance + /// Delegate to configure serialization + public RestClient( + string baseUrl, + ConfigureRestClient? configureRestClient = null, + ConfigureHeaders? configureDefaultHeaders = null, + ConfigureSerialization? configureSerialization = null + ) + : this(new Uri(Ensure.NotEmptyString(baseUrl, nameof(baseUrl))), configureRestClient, configureDefaultHeaders, configureSerialization) { } + + /// + /// Creates an instance of RestClient using a shared HttpClient and specific RestClientOptions and does not allocate one internally. + /// + /// HttpClient to use + /// RestClient options to use + /// True to dispose of the client, false to assume the caller does (defaults to false) + /// Delegate to configure serialization + public RestClient( + HttpClient httpClient, + RestClientOptions? options, + bool disposeHttpClient = false, + ConfigureSerialization? configureSerialization = null + ) { + ConfigureSerializers(configureSerialization); + + HttpClient = httpClient; + _disposeHttpClient = disposeHttpClient; + + if (httpClient.BaseAddress != null && options != null && options.BaseUrl == null) { + options.BaseUrl = httpClient.BaseAddress; + } + + var opt = options ?? new RestClientOptions(); + Options = new(opt); + DefaultParameters = new(Options); + + if (options != null) { + ConfigureHttpClient(httpClient, options); + ConfigureDefaultParameters(options); + } + } + + /// + /// Creates an instance of RestClient using a shared HttpClient and does not allocate one internally. + /// + /// HttpClient to use + /// True to dispose of the client, false to assume the caller does (defaults to false) + /// Delegate to configure the client options + /// Delegate to configure serialization + public RestClient( + HttpClient httpClient, + bool disposeHttpClient = false, + ConfigureRestClient? configureRestClient = null, + ConfigureSerialization? configureSerialization = null + ) + : this(httpClient, ConfigureOptions(new(), configureRestClient), disposeHttpClient, configureSerialization) { } + + /// + /// Creates a new instance of RestSharp using the message handler provided. By default, HttpClient disposes the provided handler + /// when the client itself is disposed. If you want to keep the handler not disposed, set disposeHandler argument to false. + /// + /// Message handler instance to use for HttpClient + /// Dispose the handler when disposing RestClient, true by default + /// Delegate to configure the client options + /// Delegate to configure serialization + public RestClient( + HttpMessageHandler handler, + bool disposeHandler = true, + ConfigureRestClient? configureRestClient = null, + ConfigureSerialization? configureSerialization = null + ) + : this(new HttpClient(handler, disposeHandler), true, configureRestClient, configureSerialization) { } + + internal static void ConfigureHttpClient(HttpClient httpClient, RestClientOptions options) { + if (options.Expect100Continue != null) httpClient.DefaultRequestHeaders.ExpectContinue = options.Expect100Continue; + } + + // ReSharper disable once CognitiveComplexity + internal static void ConfigureHttpMessageHandler(HttpClientHandler handler, RestClientOptions options) { +#if NET + if (!OperatingSystem.IsBrowser()) { +#endif + handler.UseCookies = false; + handler.UseDefaultCredentials = options.UseDefaultCredentials; + if (options.Credentials != null) handler.Credentials = options.Credentials; + handler.AutomaticDecompression = options.AutomaticDecompression; + handler.PreAuthenticate = options.PreAuthenticate; + if (options.RemoteCertificateValidationCallback != null) + handler.ServerCertificateCustomValidationCallback = + (request, cert, chain, errors) => options.RemoteCertificateValidationCallback(request, cert, chain, errors); + + if (options.ClientCertificates != null) { + handler.ClientCertificates.AddRange(options.ClientCertificates); + handler.ClientCertificateOptions = ClientCertificateOption.Manual; + } +#if NET + } +#endif + handler.AllowAutoRedirect = false; + +#if NET + // ReSharper disable once InvertIf + if (!OperatingSystem.IsBrowser() && !OperatingSystem.IsIOS() && !OperatingSystem.IsTvOS()) { +#endif + if (handler.SupportsProxy) handler.Proxy = options.Proxy; +#if NET + } +#endif + } + + [MemberNotNull(nameof(Serializers))] + [MemberNotNull(nameof(AcceptedContentTypes))] + void ConfigureSerializers(ConfigureSerialization? configureSerialization) { + var serializerConfig = new SerializerConfig(); + serializerConfig.UseDefaultSerializers(); + configureSerialization?.Invoke(serializerConfig); + Serializers = new(serializerConfig); + AcceptedContentTypes = Serializers.GetAcceptedContentTypes(); + } + + void ConfigureDefaultParameters(RestClientOptions options) { + if (options.UserAgent == null) return; + + if (!options.AllowMultipleDefaultParametersWithSameName && + DefaultParameters.Any(parameter => parameter is { Type: ParameterType.HttpHeader, Name: KnownHeaders.UserAgent })) + DefaultParameters.RemoveParameter(KnownHeaders.UserAgent, ParameterType.HttpHeader); + DefaultParameters.AddParameter(Parameter.CreateParameter(KnownHeaders.UserAgent, options.UserAgent, ParameterType.HttpHeader)); + } + + readonly bool _disposeHttpClient; + bool _disposed; + + protected virtual void Dispose(bool disposing) { + if (!disposing || _disposed) return; + + _disposed = true; + if (_disposeHttpClient) HttpClient.Dispose(); + } + + public void Dispose() { + Dispose(true); + GC.SuppressFinalize(this); + } +} \ No newline at end of file diff --git a/src/RestSharp/RestSharp.csproj b/src/RestSharp/RestSharp.csproj new file mode 100644 index 000000000..fced951ab --- /dev/null +++ b/src/RestSharp/RestSharp.csproj @@ -0,0 +1,47 @@ + + + true + + + + + + + + + + + + + + RestClient.cs + + + PropertyCache.cs + + + RestClient.Extensions.cs + + + RestRequestExtensions.cs + + + + + + + + + + + + + + + + + + + + + diff --git a/src/RestSharp/RestSharp.csproj.DotSettings b/src/RestSharp/RestSharp.csproj.DotSettings new file mode 100644 index 000000000..40f3c00e7 --- /dev/null +++ b/src/RestSharp/RestSharp.csproj.DotSettings @@ -0,0 +1,7 @@ + + True + True + True + True + True + True \ No newline at end of file diff --git a/src/RestSharp/Serializers/DeseralizationException.cs b/src/RestSharp/Serializers/DeseralizationException.cs new file mode 100644 index 000000000..6bb193edd --- /dev/null +++ b/src/RestSharp/Serializers/DeseralizationException.cs @@ -0,0 +1,23 @@ +// Copyright (c) .NET Foundation and Contributors +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// http://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. + +// ReSharper disable once CheckNamespace + +namespace RestSharp; + +public class DeserializationException(RestResponse response, Exception innerException) + : Exception("Error occured while deserializing the response", innerException) { + [PublicAPI] + public RestResponse Response { get; } = response; +} \ No newline at end of file diff --git a/src/RestSharp/Serializers/IDeserializer.cs b/src/RestSharp/Serializers/IDeserializer.cs new file mode 100644 index 000000000..a1332ff50 --- /dev/null +++ b/src/RestSharp/Serializers/IDeserializer.cs @@ -0,0 +1,19 @@ +// Copyright (c) .NET Foundation and Contributors +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// http://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. + +namespace RestSharp.Serializers; + +public interface IDeserializer { + T? Deserialize(RestResponse response); +} \ No newline at end of file diff --git a/src/RestSharp/Serializers/IRestSerializer.cs b/src/RestSharp/Serializers/IRestSerializer.cs new file mode 100644 index 000000000..9f1f00fb6 --- /dev/null +++ b/src/RestSharp/Serializers/IRestSerializer.cs @@ -0,0 +1,28 @@ +// Copyright (c) .NET Foundation and Contributors +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// http://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. + +namespace RestSharp.Serializers; + +public interface IRestSerializer { + ISerializer Serializer { get; } + IDeserializer Deserializer { get; } + + string[] AcceptedContentTypes { get; } + + SupportsContentType SupportsContentType { get; } + + DataFormat DataFormat { get; } + + string? Serialize(Parameter parameter); +} \ No newline at end of file diff --git a/RestSharp/Serializers/ISerializer.cs b/src/RestSharp/Serializers/ISerializer.cs similarity index 62% rename from RestSharp/Serializers/ISerializer.cs rename to src/RestSharp/Serializers/ISerializer.cs index db1c4b052..6085f0380 100644 --- a/RestSharp/Serializers/ISerializer.cs +++ b/src/RestSharp/Serializers/ISerializer.cs @@ -1,6 +1,4 @@ -#region License - -// Copyright 2010 John Sheehan +// Copyright (c) .NET Foundation and Contributors // // Licensed under the Apache License, Version 2.0 (the "License"); // you may not use this file except in compliance with the License. @@ -14,20 +12,10 @@ // See the License for the specific language governing permissions and // limitations under the License. -#endregion - -namespace RestSharp.Serializers -{ - public interface ISerializer - { - string Serialize(object obj); - - string RootElement { get; set; } - - string Namespace { get; set; } +namespace RestSharp.Serializers; - string DateFormat { get; set; } +public interface ISerializer { + ContentType ContentType { get; set; } - string ContentType { get; set; } - } + string? Serialize(object obj); } diff --git a/src/RestSharp/Serializers/IWithDateFormat.cs b/src/RestSharp/Serializers/IWithDateFormat.cs new file mode 100644 index 000000000..ee693b959 --- /dev/null +++ b/src/RestSharp/Serializers/IWithDateFormat.cs @@ -0,0 +1,19 @@ +// Copyright (c) .NET Foundation and Contributors +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// http://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. + +namespace RestSharp.Serializers; + +public interface IWithDateFormat { + string? DateFormat { get; set; } +} \ No newline at end of file diff --git a/src/RestSharp/Serializers/IWithRootElement.cs b/src/RestSharp/Serializers/IWithRootElement.cs new file mode 100644 index 000000000..c4cdadca7 --- /dev/null +++ b/src/RestSharp/Serializers/IWithRootElement.cs @@ -0,0 +1,19 @@ +// Copyright (c) .NET Foundation and Contributors +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// http://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. + +namespace RestSharp.Serializers; + +public interface IWithRootElement { + string? RootElement { get; set; } +} \ No newline at end of file diff --git a/src/RestSharp/Serializers/Json/RestClientExtensions.cs b/src/RestSharp/Serializers/Json/RestClientExtensions.cs new file mode 100644 index 000000000..121f5b635 --- /dev/null +++ b/src/RestSharp/Serializers/Json/RestClientExtensions.cs @@ -0,0 +1,38 @@ +// Copyright (c) .NET Foundation and Contributors +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// http://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. + +using System.Text.Json; + +namespace RestSharp.Serializers.Json; + +[PublicAPI] +public static class RestClientExtensions { + /// + extension(SerializerConfig serializerConfig) { + /// + /// Use System.Text.Json serializer with default settings + /// + /// + public SerializerConfig UseSystemTextJson() + => serializerConfig.UseSerializer(() => new SystemTextJsonSerializer()); + + /// + /// Use System.Text.Json serializer with custom settings + /// + /// System.Text.Json serializer options + /// + public SerializerConfig UseSystemTextJson(JsonSerializerOptions options) + => serializerConfig.UseSerializer(() => new SystemTextJsonSerializer(options)); + } +} diff --git a/src/RestSharp/Serializers/Json/SystemTextJsonSerializer.cs b/src/RestSharp/Serializers/Json/SystemTextJsonSerializer.cs new file mode 100644 index 000000000..959ffe9e5 --- /dev/null +++ b/src/RestSharp/Serializers/Json/SystemTextJsonSerializer.cs @@ -0,0 +1,46 @@ +// Copyright (c) .NET Foundation and Contributors +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// http://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. + +using System.Text.Json; + +namespace RestSharp.Serializers.Json; + +public class SystemTextJsonSerializer : IRestSerializer, ISerializer, IDeserializer { + readonly JsonSerializerOptions _options; + + /// + /// Create the new serializer that uses System.Text.Json.JsonSerializer with default settings + /// + public SystemTextJsonSerializer() => _options = new(JsonSerializerDefaults.Web); + + /// + /// Create the new serializer that uses System.Text.Json.JsonSerializer with custom settings + /// + /// Json serializer settings + public SystemTextJsonSerializer(JsonSerializerOptions options) => _options = options; + + public string? Serialize(object? obj) => obj == null ? null : JsonSerializer.Serialize(obj, _options); + + public string? Serialize(Parameter bodyParameter) => Serialize(bodyParameter.Value); + + public T? Deserialize(RestResponse response) => JsonSerializer.Deserialize(response.Content!, _options); + + public ContentType ContentType { get; set; } = ContentType.Json; + + public ISerializer Serializer => this; + public IDeserializer Deserializer => this; + public DataFormat DataFormat => DataFormat.Json; + public string[] AcceptedContentTypes => ContentType.JsonAccept; + public SupportsContentType SupportsContentType => contentType => contentType.Value.EndsWith("json", StringComparison.InvariantCultureIgnoreCase); +} \ No newline at end of file diff --git a/src/RestSharp/Serializers/RestSerializers.cs b/src/RestSharp/Serializers/RestSerializers.cs new file mode 100644 index 000000000..157f5cf19 --- /dev/null +++ b/src/RestSharp/Serializers/RestSerializers.cs @@ -0,0 +1,126 @@ +// Copyright (c) .NET Foundation and Contributors +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// http://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. +// + +using System.Collections.ObjectModel; +using RestSharp.Extensions; +using RestSharp.Serializers.Xml; + +namespace RestSharp.Serializers; + +public class RestSerializers(Dictionary records) { + [PublicAPI] + public IReadOnlyDictionary Serializers { get; } = new ReadOnlyDictionary(records); + + public RestSerializers(SerializerConfig config) : this(config.Serializers) { } + + public IRestSerializer GetSerializer(DataFormat dataFormat) + => Serializers.TryGetValue(dataFormat, out var value) + ? value.GetSerializer() + : throw new InvalidOperationException($"Unable to find a serializer for {dataFormat}"); + + internal string[] GetAcceptedContentTypes() => Serializers.SelectMany(x => x.Value.AcceptedContentTypes).Distinct().ToArray(); + + internal async ValueTask> Deserialize(RestRequest request, RestResponse raw, ReadOnlyRestClientOptions options, CancellationToken cancellationToken) { + var response = RestResponse.FromResponse(raw); + + try { + await OnBeforeDeserialization(raw, cancellationToken).ConfigureAwait(false); +#pragma warning disable CS0618 // Type or member is obsolete + request.OnBeforeDeserialization?.Invoke(raw); +#pragma warning restore CS0618 // Type or member is obsolete + response.Data = DeserializeContent(raw); + } + catch (Exception ex) { + if (options.ThrowOnAnyError) throw; + + if (options.FailOnDeserializationError || options.ThrowOnDeserializationError) response.ResponseStatus = ResponseStatus.Error; + + response.AddException(ex); + + if (options.ThrowOnDeserializationError) throw new DeserializationException(response, ex); + } + + return response; + } + + static async ValueTask OnBeforeDeserialization(RestResponse response, CancellationToken cancellationToken) { + if (response.Request.Interceptors == null) return; + + foreach (var interceptor in response.Request.Interceptors) { + await interceptor.BeforeDeserialization(response, cancellationToken).ConfigureAwait(false); + } + } + + /// + /// Deserialize the response content into the specified type + /// + /// Response instance + /// Deserialized model type + /// + [PublicAPI] + public T? DeserializeContent(RestResponse response) { + // Only attempt to deserialize if the request has not errored due + // to a transport or framework exception. HTTP errors should attempt to + // be deserialized + if (response.Content == null) { + return default; + } + + // Only continue if there is a handler defined else there is no way to deserialize the data. + // This can happen when a request returns for example a 404 page instead of the requested JSON/XML resource + var deserializer = GetContentDeserializer(response); + + if (deserializer is not IXmlDeserializer xml || response.Request is not RestXmlRequest xmlRequest) + return deserializer != null ? deserializer.Deserialize(response) : default; + + if (xmlRequest.XmlNamespace.IsNotEmpty()) xml.Namespace = xmlRequest.XmlNamespace!; + + if (xml is IWithDateFormat withDateFormat && xmlRequest.DateFormat.IsNotEmpty()) withDateFormat.DateFormat = xmlRequest.DateFormat!; + + return deserializer.Deserialize(response); + } + + IDeserializer? GetContentDeserializer(RestResponseBase response) { + if (string.IsNullOrWhiteSpace(response.Content)) return null; + + var contentType = response.ContentType ?? DetectContentType()?.Value; + + if (contentType == null) { + Serializers.TryGetValue(response.Request.RequestFormat, out var serializerByRequestFormat); + return serializerByRequestFormat?.GetSerializer().Deserializer; + } + + var serializer = Serializers.Values.FirstOrDefault(x => x.SupportsContentType(contentType)); + + // ReSharper disable once InvertIf + if (serializer == null) { + var detectedType = DetectContentType()?.Value; + + if (detectedType != null && detectedType != contentType) + { + serializer = Serializers.Values.FirstOrDefault(x => x.SupportsContentType(detectedType)); + } + } + + return serializer?.GetSerializer().Deserializer; + + ContentType? DetectContentType() + => response.Content![0] switch { + '<' => ContentType.Xml, + '{' or '[' => ContentType.Json, + _ => null + }; + } +} diff --git a/src/RestSharp/Serializers/SerializerConfig.cs b/src/RestSharp/Serializers/SerializerConfig.cs new file mode 100644 index 000000000..27055cf12 --- /dev/null +++ b/src/RestSharp/Serializers/SerializerConfig.cs @@ -0,0 +1,82 @@ +// Copyright (c) .NET Foundation and Contributors +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// http://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. +// + +using RestSharp.Serializers.Json; +using RestSharp.Serializers.Xml; + +namespace RestSharp.Serializers; + +public class SerializerConfig { + internal Dictionary Serializers { get; } = new(); + + /// + /// Replace the default serializer with a custom one + /// + /// Function that returns the serializer instance + public SerializerConfig UseSerializer(Func serializerFactory) { + var instance = serializerFactory(); + + Serializers[instance.DataFormat] = new( + instance.DataFormat, + instance.AcceptedContentTypes, + instance.SupportsContentType, + serializerFactory + ); + return this; + } + + public void UseDefaultSerializers() => UseSerializer().UseSerializer(); + + /// + /// Replace the default serializer with a custom one + /// + /// The type that implements + /// + public SerializerConfig UseSerializer() where T : class, IRestSerializer, new() => UseSerializer(() => new T()); +} + +public static class SerializerConfigExtensions { + /// Configuration instance to work with + extension(SerializerConfig config) { + /// + /// Sets the to only use JSON + /// + /// Reference to the client instance + public SerializerConfig UseJson() { + config.Serializers.Remove(DataFormat.Xml); + return config; + } + + /// + /// Sets the to only use XML + /// + /// Reference to the client instance + public SerializerConfig UseXml() { + config.Serializers.Remove(DataFormat.Json); + return config; + } + + /// + /// Sets the to only use the passed in custom serializer + /// + /// Function that returns the serializer instance + /// Reference to the client instance + public SerializerConfig UseOnlySerializer(Func serializerFactory) { + config.Serializers.Clear(); + config.UseSerializer(serializerFactory); + return config; + } + } +} diff --git a/src/RestSharp/Serializers/SerializerRecord.cs b/src/RestSharp/Serializers/SerializerRecord.cs new file mode 100644 index 000000000..49ff58630 --- /dev/null +++ b/src/RestSharp/Serializers/SerializerRecord.cs @@ -0,0 +1,22 @@ +// Copyright (c) .NET Foundation and Contributors +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// http://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. + +namespace RestSharp.Serializers; + +public record SerializerRecord( + DataFormat DataFormat, + string[] AcceptedContentTypes, + SupportsContentType SupportsContentType, + Func GetSerializer +); \ No newline at end of file diff --git a/src/RestSharp/Serializers/Xml/DotNetXmlDeserializer.cs b/src/RestSharp/Serializers/Xml/DotNetXmlDeserializer.cs new file mode 100644 index 000000000..11ce197e4 --- /dev/null +++ b/src/RestSharp/Serializers/Xml/DotNetXmlDeserializer.cs @@ -0,0 +1,51 @@ +// Copyright (c) .NET Foundation and Contributors +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// http://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. + +using System.Text; + +namespace RestSharp.Serializers.Xml; + +/// +/// Wrapper for System.Xml.Serialization.XmlSerializer. +/// +public class DotNetXmlDeserializer : IXmlDeserializer { + /// + /// Encoding for serialized content + /// + public Encoding Encoding { get; set; } = Encoding.UTF8; + + /// + /// Name of the root element to use when serializing + /// + [Obsolete("DotnetXmlDeserializer does not support RootElement.")] + public string? RootElement { get; set; } + + /// + /// XML namespace to use when serializing + /// + public string? Namespace { get; set; } + + [Obsolete("DotnetXmlDeserializer does not support DateFormat.")] + public string? DateFormat { get; set; } + + public T? Deserialize(RestResponse response) { + if (string.IsNullOrEmpty(response.Content)) return default; + + using var stream = new MemoryStream(Encoding.GetBytes(response.Content!)); + + var serializer = new System.Xml.Serialization.XmlSerializer(typeof(T), Namespace); + + return (T?)serializer.Deserialize(stream); + } +} \ No newline at end of file diff --git a/src/RestSharp/Serializers/Xml/DotNetXmlSerializer.cs b/src/RestSharp/Serializers/Xml/DotNetXmlSerializer.cs new file mode 100644 index 000000000..ef7f2f091 --- /dev/null +++ b/src/RestSharp/Serializers/Xml/DotNetXmlSerializer.cs @@ -0,0 +1,126 @@ +// Copyright (c) .NET Foundation and Contributors +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// http://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. + +using System.Text; +using System.Xml.Serialization; + +namespace RestSharp.Serializers.Xml; + +/// +/// Wrapper for System.Xml.Serialization.XmlSerializer. +/// +public class DotNetXmlSerializer : IXmlSerializer { + /// + /// Default constructor, does not specify namespace + /// + public DotNetXmlSerializer() { + ContentType = ContentType.Xml; + Encoding = Encoding.UTF8; + } + + /// + /// + /// Specify the namespaced to be used when serializing + /// + /// XML namespace + [PublicAPI] + public DotNetXmlSerializer(string @namespace) : this() => Namespace = @namespace; + + /// + /// Encoding for serialized content + /// + public Encoding Encoding { get; set; } + + /// + /// Serialize the object as XML + /// + /// Object to serialize + /// XML as string + public string Serialize(object obj) { + var ns = new XmlSerializerNamespaces(); + + ns.Add(string.Empty, Namespace!); + + var serializer = GetXmlSerializer(obj.GetType(), RootElement); + var writer = new EncodingStringWriter(Encoding); + + serializer.Serialize(writer, obj, ns); + + return writer.ToString(); + } + + /// + /// Name of the root element to use when serializing + /// + public string? RootElement { get; set; } + + /// + /// XML namespace to use when serializing + /// + public string? Namespace { get; set; } + + /// + /// Content type for serialized content + /// + public ContentType ContentType { get; set; } + + static readonly Dictionary<(Type, string?), XmlSerializer> Cache = new(); + static readonly ReaderWriterLockSlim CacheLock = new(); + + static XmlSerializer GetXmlSerializer(Type type, string? rootElement) { + XmlSerializer? serializer = null; + + var key = (type, rootElement); + + CacheLock.EnterReadLock(); + + try { + if (Cache.TryGetValue(key, out var value)) { + serializer = value; + } + } + finally { + CacheLock.ExitReadLock(); + } + + if (serializer != null) { + return serializer; + } + + CacheLock.EnterWriteLock(); + + try { + // check again for a cached instance, because between the EnterWriteLock + // and the last check, some other thread could have added an instance + if (!Cache.TryGetValue(key, out var value)) { + var root = rootElement == null ? null : new XmlRootAttribute(rootElement); + value = new(type, root); + Cache[key] = value; + } + + serializer = value; + } + finally { + CacheLock.ExitWriteLock(); + } + + return serializer; + } + + class EncodingStringWriter(Encoding encoding) : StringWriter { + // Need to subclass StringWriter in order to override Encoding + + public override Encoding Encoding { get; } = encoding; + } +} \ No newline at end of file diff --git a/src/RestSharp/Serializers/Xml/DotNetXmlSerializerClientExtensions.cs b/src/RestSharp/Serializers/Xml/DotNetXmlSerializerClientExtensions.cs new file mode 100644 index 000000000..2a6d20d64 --- /dev/null +++ b/src/RestSharp/Serializers/Xml/DotNetXmlSerializerClientExtensions.cs @@ -0,0 +1,39 @@ +// Copyright (c) .NET Foundation and Contributors +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// http://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. + +using System.Text; + +namespace RestSharp.Serializers.Xml; + +[PublicAPI] +public static class DotNetXmlSerializerClientExtensions { + public static SerializerConfig UseDotNetXmlSerializer( + this SerializerConfig serializerConfig, + string? xmlNamespace = null, + Encoding? encoding = null + ) { + var xmlSerializer = new DotNetXmlSerializer(); + if (xmlNamespace != null) xmlSerializer.Namespace = xmlNamespace; + if (encoding != null) xmlSerializer.Encoding = encoding; + + var xmlDeserializer = new DotNetXmlDeserializer(); + if (encoding != null) xmlDeserializer.Encoding = encoding; + + var serializer = new XmlRestSerializer() + .WithXmlSerializer(xmlSerializer) + .WithXmlDeserializer(xmlDeserializer); + + return serializerConfig.UseSerializer(() => serializer); + } +} diff --git a/src/RestSharp/Serializers/Xml/IXmlDeserializer.cs b/src/RestSharp/Serializers/Xml/IXmlDeserializer.cs new file mode 100644 index 000000000..975cce014 --- /dev/null +++ b/src/RestSharp/Serializers/Xml/IXmlDeserializer.cs @@ -0,0 +1,19 @@ +// Copyright (c) .NET Foundation and Contributors +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// http://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. + +namespace RestSharp.Serializers.Xml; + +public interface IXmlDeserializer : IDeserializer { + string? Namespace { get; set; } +} \ No newline at end of file diff --git a/src/RestSharp/Serializers/Xml/IXmlSerializer.cs b/src/RestSharp/Serializers/Xml/IXmlSerializer.cs new file mode 100644 index 000000000..255c9e0fd --- /dev/null +++ b/src/RestSharp/Serializers/Xml/IXmlSerializer.cs @@ -0,0 +1,19 @@ +// Copyright (c) .NET Foundation and Contributors +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// http://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. + +namespace RestSharp.Serializers.Xml; + +public interface IXmlSerializer : ISerializer { + string? Namespace { get; set; } +} \ No newline at end of file diff --git a/src/RestSharp/Serializers/Xml/XmlRestSerializer.cs b/src/RestSharp/Serializers/Xml/XmlRestSerializer.cs new file mode 100644 index 000000000..db857095f --- /dev/null +++ b/src/RestSharp/Serializers/Xml/XmlRestSerializer.cs @@ -0,0 +1,56 @@ +// Copyright (c) .NET Foundation and Contributors +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// http://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. + +namespace RestSharp.Serializers.Xml; + +public class XmlRestSerializer(IXmlSerializer serializer, IXmlDeserializer deserializer) : IRestSerializer { + IXmlDeserializer _deserializer = deserializer; + IXmlSerializer _serializer = serializer; + + public XmlRestSerializer() : this(new DotNetXmlSerializer(), new DotNetXmlDeserializer()) { } + + public ISerializer Serializer => _serializer; + public IDeserializer Deserializer => _deserializer; + public string[] AcceptedContentTypes => ContentType.XmlAccept; + public SupportsContentType SupportsContentType => contentType => contentType.Value.EndsWith("xml", StringComparison.InvariantCultureIgnoreCase); + + public DataFormat DataFormat => DataFormat.Xml; + + public string? Serialize(Parameter parameter) { + if (parameter is not XmlParameter xmlParameter) + throw new ArgumentException("Supplied parameter is not an XML parameter", nameof(parameter)); + + if (parameter.Value == null) + throw new ArgumentNullException(nameof(parameter), "Parameter value is null"); + + var savedNamespace = _serializer.Namespace; + _serializer.Namespace = xmlParameter.XmlNamespace ?? savedNamespace; + + var result = _serializer.Serialize(parameter.Value); + + _serializer.Namespace = savedNamespace; + + return result; + } + + public XmlRestSerializer WithXmlSerializer(IXmlSerializer xmlSerializer) { + _serializer = xmlSerializer; + return this; + } + + public XmlRestSerializer WithXmlDeserializer(IXmlDeserializer xmlDeserializer) { + _deserializer = xmlDeserializer; + return this; + } +} \ No newline at end of file diff --git a/src/RestSharp/SimpleClientFactory.cs b/src/RestSharp/SimpleClientFactory.cs new file mode 100644 index 000000000..09ca395c1 --- /dev/null +++ b/src/RestSharp/SimpleClientFactory.cs @@ -0,0 +1,27 @@ +// Copyright (c) .NET Foundation and Contributors +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// http://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. +// + +using System.Collections.Concurrent; + +namespace RestSharp; + +static class SimpleClientFactory { + static readonly ConcurrentDictionary CachedClients = new(); + + public static HttpClient GetClient(Uri baseUrl, Func getClient) { + var key = baseUrl.ToString(); + return CachedClients.GetOrAdd(key, _ => getClient()); + } +} diff --git a/test/Directory.Build.props b/test/Directory.Build.props new file mode 100644 index 000000000..2279b675c --- /dev/null +++ b/test/Directory.Build.props @@ -0,0 +1,34 @@ + + + + true + false + net48;net8.0;net9.0;net10.0 + disable + xUnit1033 + trx%3bLogFileName=$(MSBuildProjectName).trx + $(RepoRoot)/test-results/$(TargetFramework) + + + + + + + + + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/test/RestSharp.InteractiveTests/AuthenticationTests.cs b/test/RestSharp.InteractiveTests/AuthenticationTests.cs new file mode 100644 index 000000000..72754b1a8 --- /dev/null +++ b/test/RestSharp.InteractiveTests/AuthenticationTests.cs @@ -0,0 +1,83 @@ +using System.Net; +using System.Web; +using RestSharp.Authenticators; + +namespace RestSharp.InteractiveTests; + +public class AuthenticationTests { + public class TwitterKeys { + public string ConsumerKey { get; set; } + public string ConsumerSecret { get; set; } + } + + public static async Task Can_Authenticate_With_OAuth_Async_With_Callback(TwitterKeys twitterKeys) { + Console.WriteLine("OAuth test with callback"); + + var baseUrl = new Uri("https://api.twitter.com"); + + using var client = new RestClient( + baseUrl, + options => + options.Authenticator = OAuth1Authenticator.ForRequestToken( + twitterKeys.ConsumerKey!, + twitterKeys.ConsumerSecret, + "https://restsharp.dev" + ) + ); + var request = new RestRequest("oauth/request_token"); + var response = await client.ExecuteAsync(request); + + Assert.NotNull(response); + Assert.Equal(HttpStatusCode.OK, response.StatusCode); + + var qs = HttpUtility.ParseQueryString(response.Content); + var oauthToken = qs["oauth_token"]; + var oauthTokenSecret = qs["oauth_token_secret"]; + + Assert.NotNull(oauthToken); + Assert.NotNull(oauthTokenSecret); + + request = new($"oauth/authorize?oauth_token={oauthToken}"); + + var url = client.BuildUriString(request); + + Console.WriteLine($"Open this URL in the browser: {url} and complete the authentication."); + Console.Write("Enter the verifier: "); + var verifier = Console.ReadLine(); + + request = new("oauth/access_token") { + Authenticator = OAuth1Authenticator.ForAccessToken( + twitterKeys.ConsumerKey!, + twitterKeys.ConsumerSecret, + oauthToken!, + oauthTokenSecret!, + verifier! + ) + }; + + response = await client.ExecuteAsync(request); + + Assert.NotNull(response); + Assert.Equal(HttpStatusCode.OK, response.StatusCode); + + qs = HttpUtility.ParseQueryString(response.Content); + oauthToken = qs["oauth_token"]; + oauthTokenSecret = qs["oauth_token_secret"]; + + Assert.NotNull(oauthToken); + Assert.NotNull(oauthTokenSecret); + + request = new("1.1/account/verify_credentials.json") { + Authenticator = OAuth1Authenticator.ForProtectedResource( + twitterKeys.ConsumerKey!, + twitterKeys.ConsumerSecret, + oauthToken!, + oauthTokenSecret! + ) + }; + + response = await client.ExecuteAsync(request); + + Console.WriteLine($"Code: {response.StatusCode}, response: {response.Content}"); + } +} diff --git a/test/RestSharp.InteractiveTests/Program.cs b/test/RestSharp.InteractiveTests/Program.cs new file mode 100644 index 000000000..bea2b8123 --- /dev/null +++ b/test/RestSharp.InteractiveTests/Program.cs @@ -0,0 +1,24 @@ +using RestSharp.InteractiveTests; +// ReSharper disable HeuristicUnreachableCode + +using var client = new TwitterClient("apikey", "apisecret"); + +await foreach (var tweet in client.SearchStream()) { + Console.WriteLine(tweet); +} + +return; + +#pragma warning disable CS0162 // Unreachable code detected +var keys = new AuthenticationTests.TwitterKeys { + ConsumerKey = Prompt("Consumer key"), + ConsumerSecret = Prompt("Consumer secret") +}; + +await AuthenticationTests.Can_Authenticate_With_OAuth_Async_With_Callback(keys); +#pragma warning restore CS0162 // Unreachable code detected + +static string Prompt(string message) { + Console.Write($"{message}: "); + return Console.ReadLine(); +} \ No newline at end of file diff --git a/test/RestSharp.InteractiveTests/RestSharp.InteractiveTests.csproj b/test/RestSharp.InteractiveTests/RestSharp.InteractiveTests.csproj new file mode 100644 index 000000000..75c24e34a --- /dev/null +++ b/test/RestSharp.InteractiveTests/RestSharp.InteractiveTests.csproj @@ -0,0 +1,11 @@ + + + Exe + false + net9.0 + + + + + + diff --git a/test/RestSharp.InteractiveTests/TwitterClient.cs b/test/RestSharp.InteractiveTests/TwitterClient.cs new file mode 100644 index 000000000..0df6d0555 --- /dev/null +++ b/test/RestSharp.InteractiveTests/TwitterClient.cs @@ -0,0 +1,112 @@ +// Copyright (c) .NET Foundation and Contributors +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// http://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. +// + +using System.Runtime.CompilerServices; +using System.Text.Json.Serialization; +using RestSharp.Authenticators; +// ReSharper disable ClassNeverInstantiated.Local + +namespace RestSharp.InteractiveTests; + +public interface ITwitterClient { + Task GetUser(string user); +} + +public class TwitterClient : ITwitterClient, IDisposable { + readonly RestClient _client; + + public TwitterClient(string apiKey, string apiKeySecret) { + var options = new RestClientOptions("https://api.twitter.com/2") { + Authenticator = new TwitterAuthenticator("https://api.twitter.com", apiKey, apiKeySecret) + }; + _client = new(options); + } + + public async Task GetUser(string user) { + var response = await _client.GetAsync>( + "users/by/username/{user}", + new { user } + ); + return response!.Data; + } + + public async Task AddSearchRules(params AddStreamSearchRule[] rules) { + var response = await _client.PostJsonAsync>( + "tweets/search/stream/rules", + new(rules) + ); + return response?.Data; + } + + public async Task GetSearchRules() { + var response = await _client.GetAsync>("tweets/search/stream/rules"); + return response?.Data; + } + + public async IAsyncEnumerable SearchStream([EnumeratorCancellation] CancellationToken cancellationToken = default) { + var response = _client.StreamJsonAsync>("tweets/search/stream", cancellationToken); + + await foreach (var item in response) { + yield return item.Data; + } + } + + record TwitterSingleObject(T Data); + + record TwitterCollectionObject(T[] Data); + + record AddSearchRulesRequest(AddStreamSearchRule[] Add); + + public void Dispose() { + _client?.Dispose(); + GC.SuppressFinalize(this); + } +} + +class TwitterAuthenticator(string baseUrl, string clientId, string clientSecret) : AuthenticatorBase("") { + protected override async ValueTask GetAuthenticationParameter(string accessToken) { + var token = string.IsNullOrEmpty(Token) ? await GetToken() : Token; + Token = token; + return new HeaderParameter(KnownHeaders.Authorization, token); + } + + async Task GetToken() { + var options = new RestClientOptions(baseUrl) { + Authenticator = new HttpBasicAuthenticator(clientId, clientSecret) + }; + + using var client = new RestClient(options); + + var request = new RestRequest("oauth2/token") + .AddParameter("grant_type", "client_credentials"); + var response = await client.PostAsync(request); + return $"{response!.TokenType} {response!.AccessToken}"; + } + + record TokenResponse { + [JsonPropertyName("token_type")] + public string TokenType { get; init; } + [JsonPropertyName("access_token")] + public string AccessToken { get; init; } + } +} + +public record TwitterUser(string Id, string Name, string Username); + +public record AddStreamSearchRule(string Value, string Tag); + +public record SearchRulesResponse(string Value, string Tag, string Id); + +public record SearchResponse(string Id, string Text); diff --git a/test/RestSharp.Tests.DependencyInjection/DefaultClientRequestTests.cs b/test/RestSharp.Tests.DependencyInjection/DefaultClientRequestTests.cs new file mode 100644 index 000000000..9d45b072e --- /dev/null +++ b/test/RestSharp.Tests.DependencyInjection/DefaultClientRequestTests.cs @@ -0,0 +1,20 @@ +using Microsoft.Extensions.DependencyInjection; +using RestSharp.Extensions.DependencyInjection; +using RestSharp.Tests.Shared; +using RestSharp.Tests.Shared.Server; + +namespace RestSharp.Tests.DependencyInjection; + +public sealed class DefaultClientRequestTests : RequestTestsBase, IClassFixture, IDisposable { + readonly ServiceProvider _provider; + + public DefaultClientRequestTests(WireMockTestServer server) : base(false) { + var services = new ServiceCollection(); + services.AddRestClient(new Uri(server.Url!)); + _provider = services.BuildServiceProvider(); + } + + public void Dispose() => _provider.Dispose(); + + protected override IRestClient GetClient() => _provider.GetRequiredService(); +} \ No newline at end of file diff --git a/test/RestSharp.Tests.DependencyInjection/NamedClientWithBaseUrlRequestTests.cs b/test/RestSharp.Tests.DependencyInjection/NamedClientWithBaseUrlRequestTests.cs new file mode 100644 index 000000000..387fce5c3 --- /dev/null +++ b/test/RestSharp.Tests.DependencyInjection/NamedClientWithBaseUrlRequestTests.cs @@ -0,0 +1,22 @@ +using Microsoft.Extensions.DependencyInjection; +using RestSharp.Extensions.DependencyInjection; +using RestSharp.Tests.Shared; +using RestSharp.Tests.Shared.Server; + +namespace RestSharp.Tests.DependencyInjection; + +public sealed class NamedClientWithBaseUrlRequestTests : RequestTestsBase, IClassFixture, IDisposable { + readonly ServiceProvider _provider; + + const string ClientName = "test"; + + public NamedClientWithBaseUrlRequestTests(WireMockTestServer server) : base(false) { + var services = new ServiceCollection(); + services.AddRestClient(ClientName, new Uri(server.Url!)); + _provider = services.BuildServiceProvider(); + } + + public void Dispose() => _provider.Dispose(); + + protected override IRestClient GetClient() => _provider.GetRequiredService().CreateClient(ClientName); +} \ No newline at end of file diff --git a/test/RestSharp.Tests.DependencyInjection/NamedClientWithOptionsRequestTests.cs b/test/RestSharp.Tests.DependencyInjection/NamedClientWithOptionsRequestTests.cs new file mode 100644 index 000000000..1fda7af5c --- /dev/null +++ b/test/RestSharp.Tests.DependencyInjection/NamedClientWithOptionsRequestTests.cs @@ -0,0 +1,22 @@ +using Microsoft.Extensions.DependencyInjection; +using RestSharp.Extensions.DependencyInjection; +using RestSharp.Tests.Shared; +using RestSharp.Tests.Shared.Server; + +namespace RestSharp.Tests.DependencyInjection; + +public sealed class NamedClientWithOptionsRequestTests : RequestTestsBase, IClassFixture, IDisposable { + readonly ServiceProvider _provider; + + const string ClientName = "test"; + + public NamedClientWithOptionsRequestTests(WireMockTestServer server) : base(false) { + var services = new ServiceCollection(); + services.AddRestClient(ClientName, new RestClientOptions(server.Url!)); + _provider = services.BuildServiceProvider(); + } + + public void Dispose() => _provider.Dispose(); + + protected override IRestClient GetClient() => _provider.GetRequiredService().CreateClient(ClientName); +} \ No newline at end of file diff --git a/test/RestSharp.Tests.DependencyInjection/RestSharp.Tests.DependencyInjection.csproj b/test/RestSharp.Tests.DependencyInjection/RestSharp.Tests.DependencyInjection.csproj new file mode 100644 index 000000000..90202d946 --- /dev/null +++ b/test/RestSharp.Tests.DependencyInjection/RestSharp.Tests.DependencyInjection.csproj @@ -0,0 +1,6 @@ + + + + + + diff --git a/RestSharp.IntegrationTests/Assets/Koala.jpg b/test/RestSharp.Tests.Integrated/Assets/Koala.jpg similarity index 100% rename from RestSharp.IntegrationTests/Assets/Koala.jpg rename to test/RestSharp.Tests.Integrated/Assets/Koala.jpg diff --git "a/test/RestSharp.Tests.Integrated/Assets/Koala\303\204\303\226\303\244\303\266.jpg" "b/test/RestSharp.Tests.Integrated/Assets/Koala\303\204\303\226\303\244\303\266.jpg" new file mode 100644 index 000000000..78704a099 Binary files /dev/null and "b/test/RestSharp.Tests.Integrated/Assets/Koala\303\204\303\226\303\244\303\266.jpg" differ diff --git a/RestSharp.IntegrationTests/Assets/TestFile.txt b/test/RestSharp.Tests.Integrated/Assets/TestFile.txt similarity index 100% rename from RestSharp.IntegrationTests/Assets/TestFile.txt rename to test/RestSharp.Tests.Integrated/Assets/TestFile.txt diff --git "a/test/RestSharp.Tests.Integrated/Assets/Test\303\245\303\246.txt" "b/test/RestSharp.Tests.Integrated/Assets/Test\303\245\303\246.txt" new file mode 100644 index 000000000..9cde37b4e --- /dev/null +++ "b/test/RestSharp.Tests.Integrated/Assets/Test\303\245\303\246.txt" @@ -0,0 +1 @@ +This is a test file for RestSharp. \ No newline at end of file diff --git a/test/RestSharp.Tests.Integrated/Authentication/AuthenticationTests.cs b/test/RestSharp.Tests.Integrated/Authentication/AuthenticationTests.cs new file mode 100644 index 000000000..6a8a43df2 --- /dev/null +++ b/test/RestSharp.Tests.Integrated/Authentication/AuthenticationTests.cs @@ -0,0 +1,28 @@ +using System.Text; +using System.Web; +using RestSharp.Authenticators; + +namespace RestSharp.Tests.Integrated.Authentication; + +public class AuthenticationTests(WireMockTestServer server) : IClassFixture { + [Fact] + public async Task Can_Authenticate_With_Basic_Http_Auth() { + const string userName = "testuser"; + const string password = "testpassword"; + + using var client = new RestClient( + server.Url!, + o => o.Authenticator = new HttpBasicAuthenticator(userName, password) + ); + var request = new RestRequest("headers"); + var response = await client.GetAsync(request); + + var header = response!.First(x => x.Name == KnownHeaders.Authorization); + var auth = HttpUtility.UrlDecode(header.Value)["Basic ".Length..]; + var value = Convert.FromBase64String(auth); + var parts = Encoding.UTF8.GetString(value).Split(':'); + + parts[0].Should().Be(userName); + parts[1].Should().Be(password); + } +} \ No newline at end of file diff --git a/test/RestSharp.Tests.Integrated/Authentication/OAuth2Tests.cs b/test/RestSharp.Tests.Integrated/Authentication/OAuth2Tests.cs new file mode 100644 index 000000000..3a15901a3 --- /dev/null +++ b/test/RestSharp.Tests.Integrated/Authentication/OAuth2Tests.cs @@ -0,0 +1,17 @@ +using RestSharp.Authenticators.OAuth2; + +namespace RestSharp.Tests.Integrated.Authentication; + +public class OAuth2Tests(WireMockTestServer server) : IClassFixture { + [Fact] + public async Task ShouldHaveProperHeader() { + var auth = new OAuth2AuthorizationRequestHeaderAuthenticator("token", "Bearer"); + using var client = new RestClient(server.Url!, o => o.Authenticator = auth); + + var response = await client.GetAsync("headers"); + var authHeader = response!.FirstOrDefault(x => x.Name == KnownHeaders.Authorization); + + authHeader.Should().NotBeNull(); + authHeader!.Value.Should().Be("Bearer token"); + } +} \ No newline at end of file diff --git a/test/RestSharp.Tests.Integrated/CompressionTests.cs b/test/RestSharp.Tests.Integrated/CompressionTests.cs new file mode 100644 index 000000000..c20526423 --- /dev/null +++ b/test/RestSharp.Tests.Integrated/CompressionTests.cs @@ -0,0 +1,71 @@ +using System.IO.Compression; +using RestSharp.Extensions; +using RestSharp.Tests.Shared.Extensions; + +namespace RestSharp.Tests.Integrated; + +public class CompressionTests { + static async Task GetBody(Func getStream, string value) { + using var memoryStream = new MemoryStream(); + + // ReSharper disable once UseAwaitUsing + using (var stream = getStream(memoryStream)) { + stream.WriteStringUtf8(value); + } + + memoryStream.Seek(0, SeekOrigin.Begin); + var body = await memoryStream.ReadAsBytes(default); + return body; + } + + static void ConfigureServer(WireMockServer server, byte[] body, string encoding) + => server + .Given(Request.Create().WithPath("/").UsingGet()) + .RespondWith(Response.Create().WithBody(body).WithHeader("Content-Encoding", encoding)); + + [Fact] + public async Task Can_Handle_Deflate_Compressed_Content() { + const string value = "This is some deflated content"; + using var server = WireMockServer.Start(); + + var body = await GetBody(s => new DeflateStream(s, CompressionMode.Compress, true), value); + ConfigureServer(server, body, "deflate"); + + using var client = new RestClient(server.Url!, options => options.AutomaticDecompression = DecompressionMethods.Deflate); + var request = new RestRequest(""); + var response = await client.ExecuteAsync(request); + + response.Content.Should().Be(value); + } + + [Fact] + public async Task Can_Handle_Gzip_Compressed_Content() { + const string value = "This is some gzipped content"; + using var server = WireMockServer.Start(); + + var body = await GetBody(s => new GZipStream(s, CompressionMode.Compress, true), value); + ConfigureServer(server, body, "gzip"); + + using var client = new RestClient(server.Url!); + var request = new RestRequest(""); + var response = await client.ExecuteAsync(request); + + response.Content.Should().Be(value); + } + + [Fact] + public async Task Can_Handle_Uncompressed_Content() { + const string value = "This is some sample content"; + using var server = WireMockServer.Start(); + + server + .Given(Request.Create().WithPath("/").UsingGet()) + .RespondWith(Response.Create().WithBody(value)); + + using var client = new RestClient(server.Url!); + var request = new RestRequest(""); + var response = await client.ExecuteAsync(request); + + response.Content.Should().Be(value); + } +} \ No newline at end of file diff --git a/test/RestSharp.Tests.Integrated/CookieRedirectTests.cs b/test/RestSharp.Tests.Integrated/CookieRedirectTests.cs new file mode 100644 index 000000000..bd9b25e0c --- /dev/null +++ b/test/RestSharp.Tests.Integrated/CookieRedirectTests.cs @@ -0,0 +1,367 @@ +using System.Text.Json; +using WireMock; +using WireMock.RequestBuilders; +using WireMock.ResponseBuilders; +using WireMock.Server; +using WireMock.Types; +using WireMock.Util; + +namespace RestSharp.Tests.Integrated; + +/// +/// Tests for cookie behavior during redirects and custom redirect handling. +/// Verifies fixes for https://github.com/restsharp/RestSharp/issues/2077 +/// and https://github.com/restsharp/RestSharp/issues/2059 +/// +public sealed class CookieRedirectTests(WireMockTestServer server) : IClassFixture, IDisposable { + readonly RestClient _client = new(server.Url!); + + RestClient CreateClient(Action? configure = null) { + var options = new RestClientOptions(server.Url!); + configure?.Invoke(options); + return new RestClient(options); + } + + // ─── Cookie tests ──────────────────────────────────────────────────── + + [Fact] + public async Task Redirect_Should_Forward_Cookies_Set_During_Redirect() { + using var client = CreateClient(o => o.CookieContainer = new()); + + var request = new RestRequest("/set-cookie-and-redirect"); + var response = await client.ExecuteAsync(request); + + response.StatusCode.Should().Be(HttpStatusCode.OK); + response.Content!.Should().Contain("redirectCookie", + "cookies from Set-Cookie headers on redirect responses should be forwarded to the final destination"); + } + + [Fact] + public async Task Redirect_Should_Capture_SetCookie_From_Redirect_In_CookieContainer() { + var cookieContainer = new CookieContainer(); + using var client = CreateClient(o => o.CookieContainer = cookieContainer); + + var request = new RestRequest("/set-cookie-and-redirect"); + var response = await client.ExecuteAsync(request); + + response.StatusCode.Should().Be(HttpStatusCode.OK); + cookieContainer.GetCookies(new Uri(server.Url!)).Cast() + .Should().Contain(c => c.Name == "redirectCookie" && c.Value == "value1", + "cookies from Set-Cookie headers on redirect responses should be stored in the CookieContainer"); + } + + [Fact] + public async Task Redirect_With_Existing_Cookies_Should_Include_Both_Old_And_New_Cookies() { + var host = new Uri(server.Url!).Host; + using var client = CreateClient(o => o.CookieContainer = new()); + + var request = new RestRequest("/set-cookie-and-redirect") { + CookieContainer = new() + }; + request.CookieContainer.Add(new Cookie("existingCookie", "existingValue", "/", host)); + + var response = await client.ExecuteAsync(request); + + response.StatusCode.Should().Be(HttpStatusCode.OK); + response.Content!.Should().Contain("existingCookie", + "pre-existing cookies should be forwarded through redirects"); + response.Content.Should().Contain("redirectCookie", + "cookies set during redirect should also arrive at the final destination"); + } + + // ─── FollowRedirects = false ───────────────────────────────────────── + + [Fact] + public async Task FollowRedirects_False_Should_Return_Redirect_Response() { + using var client = CreateClient(o => o.FollowRedirects = false); + + var request = new RestRequest("/set-cookie-and-redirect"); + var response = await client.ExecuteAsync(request); + + response.StatusCode.Should().Be(HttpStatusCode.Redirect); + } + + // ─── Max redirects ─────────────────────────────────────────────────── + + [Fact] + public async Task Should_Stop_After_MaxRedirects() { + using var client = CreateClient(o => o.RedirectOptions = new RedirectOptions { MaxRedirects = 3 }); + + var request = new RestRequest("/redirect-countdown?n=10"); + var response = await client.ExecuteAsync(request); + + response.StatusCode.Should().Be(HttpStatusCode.TemporaryRedirect); + } + + [Fact] + public async Task Should_Follow_All_Redirects_When_Under_MaxRedirects() { + using var client = CreateClient(o => o.RedirectOptions = new RedirectOptions { MaxRedirects = 50 }); + + var request = new RestRequest("/redirect-countdown?n=5"); + var response = await client.ExecuteAsync(request); + + response.StatusCode.Should().Be(HttpStatusCode.OK); + response.Content.Should().Contain("Done!"); + } + + // ─── Verb changes (parameterized) ──────────────────────────────────── + + [Theory] + [InlineData(302, "GET")] + [InlineData(303, "GET")] + [InlineData(307, "POST")] + [InlineData(308, "POST")] + public async Task Post_Redirect_Should_Use_Expected_Method(int statusCode, string expectedMethod) { + using var client = CreateClient(); + + var request = new RestRequest($"/redirect-with-status?status={statusCode}", Method.Post); + request.AddJsonBody(new { data = "test" }); + + var response = await client.ExecuteAsync(request); + + response.StatusCode.Should().Be(HttpStatusCode.OK); + var doc = JsonDocument.Parse(response.Content!); + doc.RootElement.GetProperty("Method").GetString().Should().Be(expectedMethod); + } + + [Fact] + public async Task Body_Should_Be_Dropped_When_Verb_Changes_To_Get() { + using var client = CreateClient(); + + var request = new RestRequest("/redirect-with-status?status=302", Method.Post); + request.AddJsonBody(new { data = "test" }); + + var response = await client.ExecuteAsync(request); + + response.StatusCode.Should().Be(HttpStatusCode.OK); + var doc = JsonDocument.Parse(response.Content!); + doc.RootElement.GetProperty("Method").GetString().Should().Be("GET"); + doc.RootElement.GetProperty("Body").GetString().Should().BeEmpty(); + } + + // ─── Header forwarding ────────────────────────────────────────────── + + [Theory] + [InlineData(true)] + [InlineData(false)] + public async Task ForwardHeaders_Controls_Custom_Header_Forwarding(bool forwardHeaders) { + using var client = CreateClient(o => + o.RedirectOptions = new RedirectOptions { ForwardHeaders = forwardHeaders } + ); + + var request = new RestRequest("/redirect-with-status?status=302"); + request.AddHeader("X-Custom-Header", "custom-value"); + + var response = await client.ExecuteAsync(request); + + response.StatusCode.Should().Be(HttpStatusCode.OK); + + if (forwardHeaders) + response.Content.Should().Contain("X-Custom-Header").And.Contain("custom-value"); + else + response.Content.Should().NotContain("X-Custom-Header"); + } + + [Theory] + [InlineData(true)] + [InlineData(false)] + public async Task ForwardAuthorization_Controls_Auth_Header_Forwarding(bool forwardAuth) { + using var client = CreateClient(o => + o.RedirectOptions = new RedirectOptions { ForwardAuthorization = forwardAuth } + ); + + var request = new RestRequest("/redirect-with-status?status=302"); + request.AddHeader("Authorization", "Bearer test-token"); + + var response = await client.ExecuteAsync(request); + + response.StatusCode.Should().Be(HttpStatusCode.OK); + + if (forwardAuth) + response.Content.Should().Contain("Bearer test-token"); + else + response.Content.Should().NotContain("Bearer test-token"); + } + + [Theory] + [InlineData(false, false)] + [InlineData(true, true)] + public async Task ForwardAuthorizationToExternalHost_Controls_Cross_Origin_Auth( + bool allowExternal, bool expectAuth + ) { + // Create a second server (different port = different origin) with echo endpoint + using var externalServer = WireMockServer.Start(); + externalServer + .Given(Request.Create().WithPath("/echo-request")) + .RespondWith(Response.Create().WithCallback(WireMockTestServer.EchoRequest)); + + // Main server redirects to the external server + var redirectPath = $"/redirect-external-{allowExternal}"; + server.Given(Request.Create().WithPath(redirectPath)) + .RespondWith(Response.Create().WithCallback(_ => new ResponseMessage { + StatusCode = 302, + Headers = new Dictionary> { + ["Location"] = new(externalServer.Url + "/echo-request") + } + })); + + using var client = CreateClient(o => + o.RedirectOptions = new RedirectOptions { + ForwardAuthorization = true, + ForwardAuthorizationToExternalHost = allowExternal + } + ); + + var request = new RestRequest(redirectPath); + request.AddHeader("Authorization", "Bearer secret-token"); + + var response = await client.ExecuteAsync(request); + + response.StatusCode.Should().Be(HttpStatusCode.OK); + + if (expectAuth) + response.Content.Should().Contain("Bearer secret-token"); + else + response.Content.Should().NotContain("Bearer secret-token"); + } + + [Fact] + public async Task ForwardCookies_False_Should_Not_Send_Cookies_On_Redirect() { + var host = new Uri(server.Url!).Host; + var cookieContainer = new CookieContainer(); + using var client = CreateClient(o => { + o.CookieContainer = cookieContainer; + o.RedirectOptions = new RedirectOptions { ForwardCookies = false }; + }); + + var request = new RestRequest("/set-cookie-and-redirect?url=/echo-cookies") { + CookieContainer = new() + }; + request.CookieContainer.Add(new Cookie("existingCookie", "existingValue", "/", host)); + + var response = await client.ExecuteAsync(request); + + response.StatusCode.Should().Be(HttpStatusCode.OK); + cookieContainer.GetCookies(new Uri(server.Url!)).Cast().Should() + .Contain(c => c.Name == "redirectCookie", + "Set-Cookie should still be stored even when ForwardCookies is false"); + response.Content.Should().NotContain("existingCookie"); + response.Content.Should().NotContain("redirectCookie"); + } + + // ─── ForwardBody ──────────────────────────────────────────────────── + + [Theory] + [InlineData(false)] + [InlineData(true)] + public async Task ForwardBody_Controls_Body_Forwarding_When_Verb_Preserved(bool forwardBody) { + using var client = CreateClient(o => + o.RedirectOptions = new RedirectOptions { ForwardBody = forwardBody } + ); + + var request = new RestRequest("/redirect-with-status?status=307", Method.Post); + request.AddJsonBody(new { data = "test-body" }); + + var response = await client.ExecuteAsync(request); + + response.StatusCode.Should().Be(HttpStatusCode.OK); + var doc = JsonDocument.Parse(response.Content!); + doc.RootElement.GetProperty("Method").GetString().Should().Be("POST"); + + if (forwardBody) + doc.RootElement.GetProperty("Body").GetString().Should().Contain("test-body"); + else + doc.RootElement.GetProperty("Body").GetString().Should().BeEmpty(); + } + + // ─── ForwardQuery ─────────────────────────────────────────────────── + + [Theory] + [InlineData(true, true)] + [InlineData(false, false)] + public async Task ForwardQuery_Controls_Query_String_Forwarding(bool forwardQuery, bool expectQuery) { + using var client = CreateClient(o => + o.RedirectOptions = new RedirectOptions { ForwardQuery = forwardQuery } + ); + + var request = new RestRequest("/redirect-no-query"); + request.AddQueryParameter("foo", "bar"); + + var response = await client.ExecuteAsync(request); + + response.StatusCode.Should().Be(HttpStatusCode.OK); + + if (expectQuery) + response.ResponseUri!.Query.Should().Contain("foo=bar"); + else + (response.ResponseUri!.Query ?? "").Should().NotContain("foo=bar"); + } + + // ─── RedirectStatusCodes customization ────────────────────────────── + + [Fact] + public async Task Custom_RedirectStatusCodes_Should_Follow_Custom_Code() { + using var client = CreateClient(o => + o.RedirectOptions = new RedirectOptions { + RedirectStatusCodes = [HttpStatusCode.Found, (HttpStatusCode)399] + } + ); + + var request = new RestRequest("/redirect-custom-status?status=399"); + var response = await client.ExecuteAsync(request); + + response.StatusCode.Should().Be(HttpStatusCode.OK, + "399 should be treated as a redirect because it's in RedirectStatusCodes"); + } + + [Fact] + public async Task Custom_RedirectStatusCodes_Should_Not_Follow_Excluded_Code() { + using var client = CreateClient(o => + o.RedirectOptions = new RedirectOptions { + RedirectStatusCodes = [(HttpStatusCode)399] + } + ); + + var request = new RestRequest("/redirect-with-status?status=302"); + var response = await client.ExecuteAsync(request); + + response.StatusCode.Should().Be(HttpStatusCode.Found, + "302 should NOT be followed because it's not in the custom RedirectStatusCodes"); + } + + // ─── FollowRedirectsToInsecure ────────────────────────────────────── + + [Theory] + [InlineData(false, HttpStatusCode.Redirect)] + [InlineData(true, HttpStatusCode.OK)] + public async Task FollowRedirectsToInsecure_Controls_Https_To_Http_Redirect( + bool allowInsecure, HttpStatusCode expectedStatus + ) { + using var httpsServer = WireMockServer.Start(new WireMock.Settings.WireMockServerSettings { + Port = 0, + UseSSL = true + }); + + httpsServer + .Given(Request.Create().WithPath("/https-redirect")) + .RespondWith(Response.Create().WithCallback(_ => new ResponseMessage { + StatusCode = 302, + Headers = new Dictionary> { + ["Location"] = new(server.Url + "/echo-request") + } + })); + + using var client = new RestClient(new RestClientOptions(httpsServer.Url!) { + // Cert validation disabled intentionally: local test HTTPS server uses self-signed cert + RemoteCertificateValidationCallback = (_, _, _, _) => true, + RedirectOptions = new RedirectOptions { FollowRedirectsToInsecure = allowInsecure } + }); + + var request = new RestRequest("/https-redirect"); + var response = await client.ExecuteAsync(request); + + response.StatusCode.Should().Be(expectedStatus); + } + + public void Dispose() => _client.Dispose(); +} diff --git a/test/RestSharp.Tests.Integrated/CookieTests.cs b/test/RestSharp.Tests.Integrated/CookieTests.cs new file mode 100644 index 000000000..1014fd3d4 --- /dev/null +++ b/test/RestSharp.Tests.Integrated/CookieTests.cs @@ -0,0 +1,197 @@ +using Microsoft.AspNetCore.Http; +using Microsoft.Extensions.Primitives; +using Microsoft.Net.Http.Headers; +using RestSharp.Tests.Integrated.Fixtures; +using WireMock.Types; +using WireMock.Util; + +namespace RestSharp.Tests.Integrated; + +public sealed class CookieTests : IDisposable { + readonly RestClient _client; + readonly string _host; + readonly WireMockServer _server = WireMockServer.Start(); + + public CookieTests() { + var options = new RestClientOptions(_server.Url!) { + CookieContainer = new CookieContainer() + }; + _client = new RestClient(options); + _host = _client.Options.BaseUrl!.Host; + + _server + .Given(Request.Create().WithPath("/get-cookies")) + .RespondWith(Response.Create().WithCallback(HandleGetCookies)); + + _server + .Given(Request.Create().WithPath("/set-cookies")) + .RespondWith(Response.Create().WithCallback(HandleSetCookies)); + + _server + .Given(Request.Create().WithPath("/invalid-cookies")) + .RespondWith(Response.Create().WithCallback(HandleInvalidCookies)); + } + + [Fact] + public async Task Can_Perform_GET_Async_With_Request_Cookies() { + var request = new RestRequest("get-cookies") { + CookieContainer = new CookieContainer() + }; + request.CookieContainer.Add(new Cookie("cookie", "value", null, _host)); + request.CookieContainer.Add(new Cookie("cookie2", "value2", null, _host)); + var response = await _client.ExecuteAsync(request); + response.Content.Should().Be("[\"cookie=value\",\"cookie2=value2\"]"); + } + + [Fact] + public async Task Can_Perform_GET_Async_With_Request_And_Client_Cookies() { + _client.Options.CookieContainer!.Add(new Cookie("clientCookie", "clientCookieValue", null, _host)); + + var request = new RestRequest("get-cookies") { + CookieContainer = new CookieContainer() + }; + request.CookieContainer.Add(new Cookie("cookie", "value", null, _host)); + request.CookieContainer.Add(new Cookie("cookie2", "value2", null, _host)); + var response = await _client.ExecuteAsync(request); + + var expected = new[] { "cookie=value", "cookie2=value2", "clientCookie=clientCookieValue" }; + response.Data.Should().BeEquivalentTo(expected); + } + + [Fact] + public async Task Can_Perform_GET_Async_With_Response_Cookies() { + var request = new RestRequest("set-cookies"); + var response = await _client.ExecuteAsync(request); + response.Content.Should().Be("success"); + + AssertCookie("cookie1", "value1", x => x == DateTime.MinValue); + response.Cookies.Find("cookie2").Should().BeNull("Cookie 2 should vanish as the path will not match"); + AssertCookie("cookie3", "value3", x => x > DateTime.UtcNow); + AssertCookie("cookie4", "value4", x => x > DateTime.UtcNow); + response.Cookies.Find("cookie5").Should().BeNull("Cookie 5 should vanish as the request is not SSL"); + AssertCookie("cookie6", "value6", x => x == DateTime.MinValue, true); + return; + + void AssertCookie(string name, string value, Func checkExpiration, bool httpOnly = false) { + var c = response.Cookies.Find(name)!; + c.Value.Should().Be(value); + c.Path.Should().Be("/"); + c.Domain.Should().Be(_host); + checkExpiration(c.Expires).Should().BeTrue($"Expires at {c.Expires}"); + c.HttpOnly.Should().Be(httpOnly); + } + } + + [Fact] + public async Task GET_Async_With_Response_Cookies_Should_Not_Fail_With_Cookie_With_Empty_Domain() { + var request = new RestRequest("set-cookies"); + var response = await _client.ExecuteAsync(request); + response.Content.Should().Be("success"); + + var notFoundCookie = response.Cookies.Find("cookie_empty_domain"); + notFoundCookie.Should().BeNull(); + + var emptyDomainCookieHeader = response + .GetHeaderValues(KnownHeaders.SetCookie) + .SingleOrDefault(h => h.StartsWith("cookie_empty_domain")); + emptyDomainCookieHeader.Should().NotBeNull(); + emptyDomainCookieHeader.Should().Contain("domain=;"); + } + + [Fact] + public async Task GET_Async_With_Invalid_Cookies_Should_Still_Return_Response_When_IgnoreInvalidCookies_Is_False() { + var request = new RestRequest("invalid-cookies") { + CookieContainer = new() + }; + var response = await _client.ExecuteAsync(request); + + // Even with IgnoreInvalidCookies = false, the response should be successful + // because AddCookies swallows CookieException by default + response.IsSuccessful.Should().BeTrue(); + response.Content.Should().Be("success"); + } + + [Fact] + public async Task GET_Async_With_Invalid_Cookies_Should_Return_Response_When_IgnoreInvalidCookies_Is_True() { + var options = new RestClientOptions(_server.Url!) { + CookieContainer = new() + }; + using var client = new RestClient(options); + + var request = new RestRequest("invalid-cookies"); + var response = await client.ExecuteAsync(request); + + response.IsSuccessful.Should().BeTrue(); + response.Content.Should().Be("success"); + } + + static ResponseMessage HandleGetCookies(IRequestMessage request) { + var response = request.Cookies!.Select(x => $"{x.Key}={x.Value}").ToArray(); + return WireMockTestServer.CreateJson(response); + } + + static ResponseMessage HandleSetCookies(IRequestMessage request) { + var cookies = new List { + new("cookie1", "value1", new()), + new("cookie2", "value2", new() { Path = "/path_extra" }), + new("cookie3", "value3", new() { Expires = DateTimeOffset.Now.AddDays(2) }), + new("cookie4", "value4", new() { MaxAge = TimeSpan.FromSeconds(100) }), + new("cookie5", "value5", new() { Secure = true }), + new("cookie6", "value6", new() { HttpOnly = true }), + new("cookie_empty_domain", "value_empty_domain", new() { HttpOnly = true, Domain = string.Empty }) + }; + + var response = new ResponseMessage { + Headers = new Dictionary>(), + BodyData = new BodyData { + DetectedBodyType = BodyType.String, + BodyAsString = "success" + } + }; + + var valuesList = new WireMockList(); + valuesList.AddRange(cookies.Select(cookie => cookie.Options.GetHeader(cookie.Name, cookie.Value))); + response.Headers.Add(KnownHeaders.SetCookie, valuesList); + + return response; + } + + static ResponseMessage HandleInvalidCookies(IRequestMessage request) { + var response = new ResponseMessage { + Headers = new Dictionary>(), + BodyData = new BodyData { + DetectedBodyType = BodyType.String, + BodyAsString = "success" + } + }; + + // Create an invalid cookie with a domain mismatch that will cause CookieException + // The cookie domain doesn't match the request URL domain + var valuesList = new WireMockList { "invalid_cookie=value; Domain=.invalid-domain.com" }; + response.Headers.Add(KnownHeaders.SetCookie, valuesList); + + return response; + } + + record CookieInternal(string Name, string Value, CookieOptions Options); + + public void Dispose() { + _client.Dispose(); + _server.Dispose(); + } +} + +static class CookieExtensions { + public static string GetHeader(this CookieOptions self, string name, string value) { + var cookieHeader = new SetCookieHeaderValue((StringSegment)name, (StringSegment)value) { + Domain = (StringSegment)self.Domain, + Path = (StringSegment)self.Path, + Expires = self.Expires, + Secure = self.Secure, + HttpOnly = self.HttpOnly, + MaxAge = self.MaxAge, + SameSite = (Microsoft.Net.Http.Headers.SameSiteMode)self.SameSite + }; + return cookieHeader.ToString(); + } +} \ No newline at end of file diff --git a/test/RestSharp.Tests.Integrated/DefaultParameterTests.cs b/test/RestSharp.Tests.Integrated/DefaultParameterTests.cs new file mode 100644 index 000000000..da058b238 --- /dev/null +++ b/test/RestSharp.Tests.Integrated/DefaultParameterTests.cs @@ -0,0 +1,122 @@ +using RestSharp.Tests.Shared.Extensions; +using RestSharp.Tests.Shared.Fixtures; + +namespace RestSharp.Tests.Integrated; + +public sealed class DefaultParameterTests(WireMockTestServer server) : IClassFixture { + readonly RequestBodyCapturer _capturer = server.ConfigureBodyCapturer(Method.Get, false); + readonly RequestBodyCapturer _capturerOnPath = server.ConfigureBodyCapturer(Method.Get); + + [Fact] + public async Task Should_add_default_and_request_query_get_parameters() { + using var client = new RestClient(server.Url!).AddDefaultParameter("foo", "bar", ParameterType.QueryString); + var request = new RestRequest().AddParameter("foo1", "bar1", ParameterType.QueryString); + + await client.GetAsync(request); + + var query = _capturer.Url!.Query; + query.Should().Contain("foo=bar"); + query.Should().Contain("foo1=bar1"); + } + + [Fact] + public async Task Should_add_default_and_request_url_get_parameters() { + using var client = new RestClient($"{server.Url}/{{foo}}/").AddDefaultParameter("foo", "bar", ParameterType.UrlSegment); + var request = new RestRequest("{foo1}").AddParameter("foo1", "bar1", ParameterType.UrlSegment); + + await client.GetAsync(request); + + _capturer.Url!.Segments.Should().BeEquivalentTo("/", "bar/", "bar1"); + } + + [Fact] + public async Task Should_not_throw_exception_when_name_is_null() { + using var client = new RestClient($"{server.Url}/request-echo").AddDefaultParameter("foo", "bar", ParameterType.UrlSegment); + var request = new RestRequest("{foo1}").AddParameter(null, "value", ParameterType.RequestBody); + + await client.ExecuteAsync(request); + } + + [Fact] + public async Task Should_not_encode_pipe_character_when_encode_is_false() { + using var client = new RestClient(server.Url!); + + var request = new RestRequest("capture"); + request.AddQueryParameter("ids", "in:001|116", false); + + await client.ExecuteAsync(request); + + var query = _capturer.RawUrl.Split('?')[1]; + query.Should().Contain("ids=in:001|116"); + } + + [Fact] + public async Task Should_include_multiple_default_query_params_with_same_name() { + using var client = new RestClient( + new RestClientOptions(server.Url!) { AllowMultipleDefaultParametersWithSameName = true } + ); + client.AddDefaultParameter("filter", "active", ParameterType.QueryString); + client.AddDefaultParameter("filter", "verified", ParameterType.QueryString); + + var request = new RestRequest("capture"); + await client.GetAsync(request); + + var query = _capturerOnPath.Url!.Query; + query.Should().Contain("filter=active"); + query.Should().Contain("filter=verified"); + } + + [Fact] + public async Task Should_include_default_query_params_in_BuildUriString_without_executing() { + using var client = new RestClient(server.Url!); + client.AddDefaultParameter("foo", "bar", ParameterType.QueryString); + + var request = new RestRequest("resource"); + var uri = client.BuildUriString(request); + + uri.Should().Contain("foo=bar"); + } + + [Fact] + public async Task Should_not_permanently_mutate_request_parameters_after_execute() { + using var client = new RestClient(server.Url!); + client.AddDefaultParameter("default_key", "default_val", ParameterType.QueryString); + + var request = new RestRequest("capture"); + var paramsBefore = request.Parameters.Count; + + await client.GetAsync(request); + + // Request parameters should not have been mutated by the execution. + request.Parameters.Count.Should().Be(paramsBefore); + + // Now replace the default parameter with a different value. + client.DefaultParameters.ReplaceParameter(new QueryParameter("default_key", "updated_val")); + + await client.GetAsync(request); + + // The second execution should use the updated default value, not the stale one. + var query = _capturerOnPath.Url!.Query; + query.Should().Contain("default_key=updated_val"); + query.Should().NotContain("default_key=default_val"); + } + + [Fact] + public async Task Should_include_default_params_in_merged_parameters_on_response() { + using var client = new RestClient(server.Url!); + client.AddDefaultParameter("default_key", "default_val", ParameterType.QueryString); + + var request = new RestRequest("capture").AddQueryParameter("req_key", "req_val"); + var response = await client.ExecuteAsync(request); + + var defaultParam = response.MergedParameters + .FirstOrDefault(p => p.Name == "default_key" && p.Type == ParameterType.QueryString); + defaultParam.Should().NotBeNull(); + defaultParam!.Value.Should().Be("default_val"); + + var requestParam = response.MergedParameters + .FirstOrDefault(p => p.Name == "req_key" && p.Type == ParameterType.QueryString); + requestParam.Should().NotBeNull(); + requestParam!.Value.Should().Be("req_val"); + } +} \ No newline at end of file diff --git a/test/RestSharp.Tests.Integrated/DownloadDataTests.cs b/test/RestSharp.Tests.Integrated/DownloadDataTests.cs new file mode 100644 index 000000000..2540b177f --- /dev/null +++ b/test/RestSharp.Tests.Integrated/DownloadDataTests.cs @@ -0,0 +1,79 @@ +using RestSharp.Extensions; + +namespace RestSharp.Tests.Integrated; + +public sealed class DownloadDataTests : IDisposable { + const string LocalPath = "Assets/Koala.jpg"; + + readonly WireMockServer _server = WireMockServer.Start(); + readonly RestClient _client; + readonly string _path = AppDomain.CurrentDomain.BaseDirectory; + + public DownloadDataTests() { + var pathToFile = Path.Combine(_path, Path.Combine(LocalPath.Split('/'))); + + _server + .Given(Request.Create().WithPath($"/{LocalPath}")) + .RespondWith(Response.Create().WithBodyFromFile(pathToFile)); + var options = new RestClientOptions($"{_server.Url}/{LocalPath}") { ThrowOnAnyError = true }; + _client = new(options); + } + + public void Dispose() => _server.Dispose(); + + [Fact] + public void DownloadDataAsync_returns_null_when_stream_is_null() { + var request = new RestRequest("/invalid-endpoint"); + + var action = () => _client.DownloadData(request); + + action.Should().ThrowExactly(); + } + + [Fact] + public async Task DownloadDataAsync_returns_bytes_when_stream_has_content() { + var request = new RestRequest(""); + + var bytes = await _client.DownloadDataAsync(request); + + bytes.Should().NotBeNull(); + bytes!.Length.Should().BeGreaterThan(0); + } + + [Fact] + public void DownloadData_sync_wraps_async() { + var request = new RestRequest(""); + + var bytes = _client.DownloadData(request); + + bytes.Should().NotBeNull(); + bytes!.Length.Should().BeGreaterThan(0); + } + + [Fact] + public void DownloadStream_sync_wraps_async() { + var request = new RestRequest(""); + + using var stream = _client.DownloadStream(request); + + stream.Should().NotBeNull(); + } + + [Fact] + public async Task DownloadStream_then_ReadAsBytes_matches_DownloadDataAsync() { + var request = new RestRequest(""); + +#if NET6_0_OR_GREATER + await using var stream = await _client.DownloadStreamAsync(request); +#else + using var stream = await _client.DownloadStreamAsync(request); +#endif + var bytesFromStream = stream == null ? null : await stream.ReadAsBytes(default); + + var bytesDirect = await _client.DownloadDataAsync(request); + + bytesFromStream.Should().NotBeNull(); + bytesDirect.Should().NotBeNull(); + bytesFromStream!.Should().BeEquivalentTo(bytesDirect); + } +} \ No newline at end of file diff --git a/test/RestSharp.Tests.Integrated/DownloadFileTests.cs b/test/RestSharp.Tests.Integrated/DownloadFileTests.cs new file mode 100644 index 000000000..10fd2658a --- /dev/null +++ b/test/RestSharp.Tests.Integrated/DownloadFileTests.cs @@ -0,0 +1,86 @@ +using System.Text; + +// ReSharper disable MethodHasAsyncOverload + +namespace RestSharp.Tests.Integrated; + +public sealed class DownloadFileTests : IDisposable { + const string LocalPath = "Assets/Koala.jpg"; + + public DownloadFileTests() { + var pathToFile = Path.Combine(_path, Path.Combine(LocalPath.Split('/'))); + + _server + .Given(Request.Create().WithPath($"/{LocalPath}")) + .RespondWith(Response.Create().WithBodyFromFile(pathToFile)); + var options = new RestClientOptions($"{_server.Url}/{LocalPath}") { ThrowOnAnyError = true }; + _client = new(options); + } + + public void Dispose() => _server.Dispose(); + + readonly WireMockServer _server = WireMockServer.Start(); + readonly RestClient _client; + readonly string _path = AppDomain.CurrentDomain.BaseDirectory; + + [Fact] + public async Task AdvancedResponseWriter_without_ResponseWriter_reads_stream() { + var tag = string.Empty; + + var rr = new RestRequest("") { + AdvancedResponseWriter = (response, request) => { + var buf = new byte[16]; + // ReSharper disable once MustUseReturnValue + using var stream = response.Content.ReadAsStreamAsync().GetAwaiter().GetResult(); +#if NET + stream.ReadExactly(buf); +#else + stream.Read(buf, 0, buf.Length); +#endif + tag = Encoding.ASCII.GetString(buf, 6, 4); + return new RestResponse(request); + } + }; + + await _client.ExecuteAsync(rr); + Assert.Equal(0, string.Compare("JFIF", tag, StringComparison.Ordinal)); + } + + [Fact] + public async Task Handles_File_Download_Failure() { + var request = new RestRequest("some/other/path"); + var task = () => _client.DownloadDataAsync(request); + await task.Should().ThrowAsync().WithMessage("Request failed with status code NotFound"); + } + + [Fact] + public async Task Handles_Binary_File_Download() { + var request = new RestRequest(""); + var response = await _client.DownloadDataAsync(request); + var expected = File.ReadAllBytes(Path.Combine(_path, Path.Combine(LocalPath.Split('/')))); + + Assert.Equal(expected, response); + } + + [Fact] + public async Task Writes_Response_To_Stream() { + var tempFile = Path.GetTempFileName(); + + var request = new RestRequest("") { + ResponseWriter = responseStream => { + using var writer = File.OpenWrite(tempFile); + responseStream.CopyTo(writer); + return null; + } + }; + + var response = await _client.DownloadDataAsync(request); + + Assert.Null(response); + + var fromTemp = File.ReadAllBytes(tempFile); + var expected = File.ReadAllBytes(Path.Combine(_path, Path.Combine(LocalPath.Split('/')))); + + Assert.Equal(expected, fromTemp); + } +} \ No newline at end of file diff --git a/test/RestSharp.Tests.Integrated/Fixtures/CaptureFixture.cs b/test/RestSharp.Tests.Integrated/Fixtures/CaptureFixture.cs new file mode 100644 index 000000000..2ca70efb7 --- /dev/null +++ b/test/RestSharp.Tests.Integrated/Fixtures/CaptureFixture.cs @@ -0,0 +1,22 @@ +using System.Collections.Specialized; + +namespace RestSharp.Tests.Integrated.Fixtures; + +public class CaptureFixture { + protected CaptureFixture() => RequestHeadCapturer.Initialize(); + + protected class RequestHeadCapturer { + public const string Resource = "Capture"; + + public static NameValueCollection? CapturedHeaders { get; private set; } + + public static void Initialize() => CapturedHeaders = null; + + // ReSharper disable once UnusedMember.Global + public static void Capture(HttpListenerContext context) { + var request = context.Request; + + CapturedHeaders = request.Headers; + } + } +} diff --git a/test/RestSharp.Tests.Integrated/Fixtures/CookieExtensions.cs b/test/RestSharp.Tests.Integrated/Fixtures/CookieExtensions.cs new file mode 100644 index 000000000..5d508d68b --- /dev/null +++ b/test/RestSharp.Tests.Integrated/Fixtures/CookieExtensions.cs @@ -0,0 +1,13 @@ +namespace RestSharp.Tests.Integrated.Fixtures; + +static class CookieExtensions { + public static Cookie? Find(this CookieCollection? cookieCollection, string name) { + if (cookieCollection == null) return null; + for (var i = 0; i < cookieCollection.Count; i++) { + var cookie = cookieCollection[i]; + if (cookie.Name == name) return cookie; + } + + return null; + } +} \ No newline at end of file diff --git a/test/RestSharp.Tests.Integrated/HttpClientTests.cs b/test/RestSharp.Tests.Integrated/HttpClientTests.cs new file mode 100644 index 000000000..1acf553c3 --- /dev/null +++ b/test/RestSharp.Tests.Integrated/HttpClientTests.cs @@ -0,0 +1,16 @@ +namespace RestSharp.Tests.Integrated; + +public sealed class HttpClientTests(WireMockTestServer server) : IClassFixture { + [Fact] + public async Task ShouldUseBaseAddress() { + using var httpClient = new HttpClient(); + httpClient.BaseAddress = new Uri(server.Url!); + using var client = new RestClient(httpClient); + + var request = new RestRequest("success"); + var response = await client.ExecuteAsync(request); + + response.StatusCode.Should().Be(HttpStatusCode.OK); + response.Data!.Message.Should().Be("Works!"); + } +} \ No newline at end of file diff --git a/test/RestSharp.Tests.Integrated/HttpHeadersTests.cs b/test/RestSharp.Tests.Integrated/HttpHeadersTests.cs new file mode 100644 index 000000000..2a0a60084 --- /dev/null +++ b/test/RestSharp.Tests.Integrated/HttpHeadersTests.cs @@ -0,0 +1,109 @@ +namespace RestSharp.Tests.Integrated; + +public sealed class HttpHeadersTests(WireMockTestServer server) : IClassFixture, IDisposable { + const string UserAgent = "RestSharp/test"; + + readonly RestClient _client = new(new RestClientOptions(server.Url!) { ThrowOnAnyError = true, UserAgent = UserAgent }); + + [Fact] + public async Task Ensure_headers_correctly_set_in_the_interceptor() { + const string headerName = "HeaderName"; + const string headerValue = "HeaderValue"; + + var request = new RestRequest("/headers") { + Interceptors = [new HeaderInterceptor(headerName, headerValue)] + }; + + var response = await _client.ExecuteAsync(request); + + response.StatusCode.Should().Be(HttpStatusCode.OK); + var header = FindHeader(response, headerName); + header.Should().NotBeNull(); + header.Value.Should().Be(headerValue); + } + + [Fact, Obsolete("Obsolete")] + public async Task Ensure_headers_correctly_set_in_the_hook() { + const string headerName = "HeaderName"; + const string headerValue = "HeaderValue"; + + var request = new RestRequest("/headers") { + OnBeforeRequest = http => { + http.Headers.Add(headerName, headerValue); + return default; + } + }; + + var response = await _client.ExecuteAsync(request); + + response.StatusCode.Should().Be(HttpStatusCode.OK); + response.Data.Should().NotBeNull(); + var header = FindHeader(response, headerName); + header.Should().NotBeNull(); + header.Value.Should().Be(headerValue); + } + + [Fact] + public async Task Should_use_both_default_and_request_headers() { + var defaultHeader = new Header("defName", "defValue"); + var requestHeader = new Header("reqName", "reqValue"); + + _client.AddDefaultHeader(defaultHeader.Name, defaultHeader.Value); + + var request = new RestRequest("/headers").AddHeader(requestHeader.Name, requestHeader.Value); + + var response = await _client.ExecuteAsync(request); + CheckHeader(response, defaultHeader); + CheckHeader(response, requestHeader); + } + + [Fact] + public async Task Should_sent_custom_UserAgent() { + var request = new RestRequest("/headers"); + var response = await _client.ExecuteAsync(request); + var h = FindHeader(response, "User-Agent"); + h.Should().NotBeNull(); + h.Value.Should().Be(UserAgent); + + response.GetHeaderValue("Server").Should().Be("Kestrel"); + } + + [Fact] + public async Task Default_headers_should_appear_in_response_merged_parameters() { + const string headerName = "X-Custom-Default"; + const string headerValue = "DefaultValue123"; + + _client.AddDefaultHeader(headerName, headerValue); + + var request = new RestRequest("/headers"); + var response = await _client.ExecuteAsync(request); + + response.StatusCode.Should().Be(HttpStatusCode.OK); + + var param = response.MergedParameters + .FirstOrDefault(p => p.Name == headerName && p.Type == ParameterType.HttpHeader); + + param.Should().NotBeNull(); + param!.Value.Should().Be(headerValue); + } + + static void CheckHeader(RestResponse response, Header header) { + var h = FindHeader(response, header.Name); + h.Should().NotBeNull(); + h.Value.Should().Be(header.Value); + } + + static TestServerResponse FindHeader(RestResponse response, string headerName) + => response.Data!.First(x => x.Name == headerName); + + record Header(string Name, string Value); + + class HeaderInterceptor(string headerName, string headerValue) : Interceptors.Interceptor { + public override ValueTask BeforeHttpRequest(HttpRequestMessage requestMessage, CancellationToken cancellationToken) { + requestMessage.Headers.Add(headerName, headerValue); + return default; + } + } + + public void Dispose() => _client.Dispose(); +} \ No newline at end of file diff --git a/test/RestSharp.Tests.Integrated/HttpTracer/HttpMessageParts.cs b/test/RestSharp.Tests.Integrated/HttpTracer/HttpMessageParts.cs new file mode 100644 index 000000000..89610bebf --- /dev/null +++ b/test/RestSharp.Tests.Integrated/HttpTracer/HttpMessageParts.cs @@ -0,0 +1,23 @@ + +namespace RestSharp.Tests.Integrated.HttpTracer; + +[Flags] +public enum HttpMessageParts { + Unspecified = 0, + RequestBody = 1 << 1, + RequestHeaders = 1 << 2, + ResponseBody = 1 << 3, + ResponseHeaders = 1 << 4, + RequestCookies = 1 << 5, + + RequestAll = RequestBody | RequestHeaders | RequestCookies, + ResponseAll = ResponseBody | ResponseHeaders, + All = ResponseAll | RequestAll +} + +[Flags] +public enum JsonFormatting { + None = 0, + IndentRequest = 1 << 0, + IndentResponse = 1 << 1 +} \ No newline at end of file diff --git a/test/RestSharp.Tests.Integrated/HttpTracer/HttpTracerHandler.cs b/test/RestSharp.Tests.Integrated/HttpTracer/HttpTracerHandler.cs new file mode 100644 index 000000000..c652de86e --- /dev/null +++ b/test/RestSharp.Tests.Integrated/HttpTracer/HttpTracerHandler.cs @@ -0,0 +1,244 @@ +using System.Diagnostics; +using System.Net.Http.Headers; +using System.Text; + +namespace RestSharp.Tests.Integrated.HttpTracer; + +public sealed class HttpTracerHandler : DelegatingHandler { + static HttpMessageParts DefaultVerbosity => HttpMessageParts.All; + + static string DefaultDurationFormat => "Duration: {0:ss\\:fffffff}"; + + static string LogMessageIndicatorPrefix => MessageIndicator; + + static string LogMessageIndicatorSuffix => MessageIndicator; + + /// + /// Instance verbosity bitmask, setting the instance verbosity overrides + /// + HttpMessageParts Verbosity { + get => field == HttpMessageParts.Unspecified ? DefaultVerbosity : field; + init; + } + + JsonFormatting JsonFormatting => JsonFormatting.None; + + /// Constructs the with a custom and a custom + /// User defined + /// User defined + /// Instance verbosity bitmask, setting the instance verbosity overrides + public HttpTracerHandler(HttpMessageHandler? handler, IHttpTracerLogger logger, HttpMessageParts verbosity = HttpMessageParts.Unspecified) { + InnerHandler = handler ?? + new HttpClientHandler { + AutomaticDecompression = DecompressionMethods.GZip | DecompressionMethods.Deflate + }; + _logger = logger; + Verbosity = verbosity; + } + + protected override async Task SendAsync(HttpRequestMessage request, CancellationToken cancellationToken) { + try { + await LogHttpRequest(request).ConfigureAwait(false); + + var stopwatch = new Stopwatch(); + stopwatch.Start(); + var response = await base.SendAsync(request, cancellationToken).ConfigureAwait(false); + stopwatch.Stop(); + + await LogHttpResponse(response, stopwatch.Elapsed).ConfigureAwait(false); + return response; + } + catch (Exception ex) { + LogHttpException(request.Method, request.RequestUri, ex); + throw; + } + } + + static string ProcessRequestUri(Uri? uri) => uri?.ToString() ?? string.Empty; + + static string ProcessResponseLogHeading(HttpStatusCode statusCode, bool isSuccessStatusCode) { + const string succeeded = "SUCCEEDED"; + const string failed = "FAILED"; + + string responseResult; + + if (statusCode == default) { + responseResult = failed; + } + else { + responseResult = isSuccessStatusCode + ? $"{succeeded}: {(int)statusCode} {statusCode}" + : $"{failed}: {(int)statusCode} {statusCode}"; + } + + return responseResult; + } + + static string ProcessRequestHeaders(HttpRequestHeaders requestHeaders) => $"{requestHeaders.ToString().TrimEnd().TrimEnd('}').TrimStart('{')}"; + + static string ProcessResponseHeaders(HttpResponseMessage? responseHeaders) => responseHeaders?.ToString() ?? string.Empty; + + static string ProcessCookieHeader(CookieContainer cookieContainer, Uri requestRequestUri) => cookieContainer.GetCookieHeader(requestRequestUri); + + static Task ProcessRequestBody(HttpContent? requestContent) => requestContent?.ReadAsStringAsync() ?? Task.FromResult(string.Empty); + + static Task ProcessResponseBody(HttpContent? responseContent) => responseContent?.ReadAsStringAsync() ?? Task.FromResult(string.Empty); + + async Task LogHttpRequest(HttpRequestMessage request) { + var sb = new StringBuilder(); + + ConditionalAddRequestPrefix(request.Method, request.RequestUri, sb); + ConditionalAddRequestHeaders(request.Headers, sb); + ConditionalAddCookies(request.RequestUri, sb); + await ConditionalAddRequestBody(request.Content, sb); + + if (sb.Length > 0) + _logger.Log(sb.ToString()); + } + + async Task LogHttpResponse(HttpResponseMessage? response, TimeSpan duration) { + var sb = new StringBuilder(); + + ConditionalAddResponsePrefix( + response?.StatusCode, + response?.IsSuccessStatusCode, + response?.RequestMessage?.Method, + response?.RequestMessage?.RequestUri, + sb + ); + ConditionalAddResponseHeaders(response, sb); + await ConditionalAddResponseBody(response?.Content, sb); + ConditionalAddResponsePostfix(duration, sb); + + if (sb.Length > 0) + _logger.Log(sb.ToString()); + } + + void LogHttpException(HttpMethod requestMethod, Uri? requestUri, Exception ex) { + var httpExceptionString = $""" + {LogMessageIndicatorPrefix} HTTP EXCEPTION: [{requestMethod}]{LogMessageIndicatorSuffix} + {requestMethod} {requestUri} + {ex} + """; + _logger.Log(httpExceptionString); + } + + private void ConditionalAddResponsePostfix(TimeSpan duration, StringBuilder sb) { + if (!Verbosity.HasFlag(HttpMessageParts.ResponseHeaders) && !Verbosity.HasFlag(HttpMessageParts.ResponseBody)) return; + + var httpResponsePostfix = string.Format(DefaultDurationFormat, duration); + sb.AppendLine(httpResponsePostfix); + } + + private async Task ConditionalAddResponseBody(HttpContent? responseContent, StringBuilder sb) { + if (!Verbosity.HasFlag(HttpMessageParts.ResponseBody)) return; + + var httpResponseContent = await ProcessResponseBody(responseContent).ConfigureAwait(false); + + if (JsonFormatting.HasFlag(JsonFormatting.IndentResponse) && responseContent?.Headers.ContentType?.MediaType == JsonContentType) { + httpResponseContent = PrettyFormatJson(httpResponseContent); + } + + sb.AppendLine(httpResponseContent); + } + + private void ConditionalAddResponseHeaders(HttpResponseMessage? responseHeaders, StringBuilder sb) { + if (!Verbosity.HasFlag(HttpMessageParts.ResponseHeaders)) return; + + var httpResponseHeaders = ProcessResponseHeaders(responseHeaders); + sb.AppendLine(httpResponseHeaders); + } + + private void ConditionalAddResponsePrefix( + HttpStatusCode? responseStatusCode, + bool? responseIsSuccessStatusCode, + HttpMethod? requestMessageMethod, + Uri? requestMessageRequestUri, + StringBuilder sb + ) { + if (!Verbosity.HasFlag(HttpMessageParts.ResponseHeaders) && !Verbosity.HasFlag(HttpMessageParts.ResponseBody)) return; + + var responseResult = ProcessResponseLogHeading(responseStatusCode ?? default, responseIsSuccessStatusCode ?? false); + + var httpResponsePrefix = $"{LogMessageIndicatorPrefix}HTTP RESPONSE: [{responseResult}]{LogMessageIndicatorSuffix}"; + sb.AppendLine(httpResponsePrefix); + + var httpRequestMethodUri = $"{requestMessageMethod} {ProcessRequestUri(requestMessageRequestUri)}"; + sb.AppendLine(httpRequestMethodUri); + } + + private async Task ConditionalAddRequestBody(HttpContent? requestContent, StringBuilder sb) { + if (!Verbosity.HasFlag(HttpMessageParts.RequestBody)) return; + + var httpRequestBody = await ProcessRequestBody(requestContent).ConfigureAwait(false); + + if (JsonFormatting.HasFlag(JsonFormatting.IndentRequest) && requestContent?.Headers.ContentType?.MediaType == JsonContentType) { + httpRequestBody = PrettyFormatJson(httpRequestBody); + } + + sb.AppendLine(httpRequestBody); + } + + private void ConditionalAddRequestHeaders(HttpRequestHeaders requestHeaders, StringBuilder sb) { + if (!Verbosity.HasFlag(HttpMessageParts.RequestHeaders)) return; + + var httpErrorRequestHeaders = ProcessRequestHeaders(requestHeaders); + sb.AppendLine(httpErrorRequestHeaders); + } + + private void ConditionalAddRequestPrefix(HttpMethod requestMethod, Uri? requestUri, StringBuilder sb) { + if (!Verbosity.HasFlag(HttpMessageParts.RequestHeaders) && !Verbosity.HasFlag(HttpMessageParts.RequestBody)) return; + + var httpRequestPrefix = $"{LogMessageIndicatorPrefix}HTTP REQUEST: [{requestMethod}]{LogMessageIndicatorSuffix}"; + sb.AppendLine(httpRequestPrefix); + + var httpRequestMethodUri = $"{requestMethod} {ProcessRequestUri(requestUri)}"; + sb.AppendLine(httpRequestMethodUri); + } + + private void ConditionalAddCookies(Uri? requestUri, StringBuilder sb) { + if (!Verbosity.HasFlag(HttpMessageParts.RequestCookies) || + InnerHandler is not HttpClientHandler httpClientHandler) return; + + var cookieHeader = ProcessCookieHeader(httpClientHandler.CookieContainer, requestUri ?? new Uri("")); + if (string.IsNullOrWhiteSpace(cookieHeader)) return; + + sb.AppendLine($"{Environment.NewLine}Cookie: {cookieHeader}"); + } + + private static string PrettyFormatJson(string json) { + var indentation = 0; + var quoteCount = 0; + + var result = json.Select(ch => new { ch, quotes = ch == '"' ? quoteCount++ : quoteCount }) + .Select(t => new { + t, + lineBreak = t.ch == ',' && t.quotes % 2 == 0 + ? $"{t.ch}{Environment.NewLine}{string.Concat(Enumerable.Repeat(JsonIndentationString, indentation))}" + : null + } + ) + .Select(t => new { + t, + openChar = t.t.ch is '{' or '[' + ? $"{t.t.ch}{Environment.NewLine}{string.Concat(Enumerable.Repeat(JsonIndentationString, ++indentation))}" + : t.t.ch.ToString() + } + ) + .Select(t => new { + t, + closeChar = t.t.t.ch is '}' or ']' + ? $"{Environment.NewLine}{string.Concat(Enumerable.Repeat(JsonIndentationString, --indentation))}{t.t.t.ch}" + : t.t.t.ch.ToString() + } + ) + .Select(t => t.t.t.lineBreak ?? (t.t.openChar.Length > 1 ? t.t.openChar : t.closeChar)); + + return string.Concat(result); + } + + private readonly IHttpTracerLogger _logger; + private const string JsonContentType = "application/json"; + private const string MessageIndicator = " ==================== "; + private const string JsonIndentationString = " "; +} \ No newline at end of file diff --git a/test/RestSharp.Tests.Integrated/HttpTracer/IHttpTracerLogger.cs b/test/RestSharp.Tests.Integrated/HttpTracer/IHttpTracerLogger.cs new file mode 100644 index 000000000..e19172655 --- /dev/null +++ b/test/RestSharp.Tests.Integrated/HttpTracer/IHttpTracerLogger.cs @@ -0,0 +1,9 @@ +namespace RestSharp.Tests.Integrated.HttpTracer; + +public interface IHttpTracerLogger { + void Log(string message); +} + +public class OutputHttpTracerLogger(ITestOutputHelper output) : IHttpTracerLogger { + public void Log(string message) => output.WriteLine(message); +} diff --git a/test/RestSharp.Tests.Integrated/Interceptor/InterceptorTests.cs b/test/RestSharp.Tests.Integrated/Interceptor/InterceptorTests.cs new file mode 100644 index 000000000..d52577217 --- /dev/null +++ b/test/RestSharp.Tests.Integrated/Interceptor/InterceptorTests.cs @@ -0,0 +1,166 @@ +// ReSharper disable AccessToDisposedClosure + +namespace RestSharp.Tests.Integrated.Interceptor; + +public class InterceptorTests(WireMockTestServer server) : IClassFixture { + [Fact] + public async Task Should_call_client_interceptor() { + // Arrange + var request = CreateRequest(); + + var (client, interceptor) = SetupClient( + test => test.BeforeRequestAction = req => req.AddHeader("foo", "bar") + ); + + //Act + var response = await client.ExecutePostAsync(request); + + //Assert + response.Request.Parameters.Should().Contain(x => x.Name == "foo" && (string)x.Value! == "bar"); + interceptor.BeforeRequestCalled.Should().BeTrue(); + interceptor.BeforeHttpRequestCalled.Should().BeTrue(); + interceptor.AfterHttpRequestCalled.Should().BeTrue(); + interceptor.AfterRequestCalled.Should().BeTrue(); + interceptor.BeforeDeserializationCalled.Should().BeTrue(); + + client.Dispose(); + } + + [Fact] + public async Task Should_call_request_interceptor() { + // Arrange + var request = CreateRequest(); + var interceptor = new TestInterceptor(); + request.Interceptors = new List { interceptor }; + + //Act + using var client = new RestClient(server.Url!); + await client.ExecutePostAsync(request); + + //Assert + interceptor.ShouldHaveCalledAll(); + } + + [Fact] + public async Task Should_call_both_client_and_request_interceptors() { + // Arrange + var request = CreateRequest(); + var (client, interceptor) = SetupClient(); + var requestInterceptor = new TestInterceptor(); + request.Interceptors = new List { requestInterceptor }; + + //Act + await client.ExecutePostAsync(request); + + //Assert + interceptor.ShouldHaveCalledAll(); + requestInterceptor.ShouldHaveCalledAll(); + + client.Dispose(); + } + + [Fact] + public async Task ThrowExceptionIn_InterceptBeforeRequest() { + //Arrange + var request = CreateRequest(); + var (client, interceptor) = SetupClient(test => test.BeforeRequestAction = req => throw new Exception("DummyException")); + + //Act + var action = () => client.ExecutePostAsync(request); + + //Assert + await action.Should().ThrowAsync().WithMessage("DummyException"); + interceptor.BeforeRequestCalled.Should().BeTrue(); + interceptor.BeforeHttpRequestCalled.Should().BeFalse(); + interceptor.AfterHttpRequestCalled.Should().BeFalse(); + interceptor.AfterRequestCalled.Should().BeFalse(); + interceptor.BeforeDeserializationCalled.Should().BeFalse(); + + client.Dispose(); + } + + [Fact] + public async Task ThrowExceptionIn_InterceptBeforeHttpRequest() { + // Arrange + var request = CreateRequest(); + var (client, interceptor) = SetupClient(test => test.BeforeHttpRequestAction = req => throw new Exception("DummyException")); + + //Act + var action = () => client.ExecutePostAsync(request); + + //Assert + await action.Should().ThrowAsync().WithMessage("DummyException"); + interceptor.BeforeRequestCalled.Should().BeTrue(); + interceptor.BeforeHttpRequestCalled.Should().BeTrue(); + interceptor.AfterHttpRequestCalled.Should().BeFalse(); + interceptor.AfterRequestCalled.Should().BeFalse(); + interceptor.BeforeDeserializationCalled.Should().BeFalse(); + + client.Dispose(); + } + + [Fact] + public async Task ThrowException_InInterceptAfterHttpRequest() { + // Arrange + var request = CreateRequest(); + var (client, interceptor) = SetupClient(test => test.AfterHttpRequestAction = req => throw new Exception("DummyException")); + + //Act + var action = () => client.ExecutePostAsync(request); + + //Assert + await action.Should().ThrowAsync().WithMessage("DummyException"); + interceptor.BeforeRequestCalled.Should().BeTrue(); + interceptor.BeforeHttpRequestCalled.Should().BeTrue(); + interceptor.AfterHttpRequestCalled.Should().BeTrue(); + interceptor.AfterRequestCalled.Should().BeFalse(); + interceptor.BeforeDeserializationCalled.Should().BeFalse(); + + client.Dispose(); + } + + [Fact] + public async Task ThrowExceptionIn_InterceptAfterRequest() { + // Arrange + var request = CreateRequest(); + var (client, interceptor) = SetupClient(test => test.AfterRequestAction = req => throw new Exception("DummyException")); + + //Act + var action = () => client.ExecutePostAsync(request); + + //Assert + await action.Should().ThrowAsync().WithMessage("DummyException"); + interceptor.BeforeRequestCalled.Should().BeTrue(); + interceptor.BeforeHttpRequestCalled.Should().BeTrue(); + interceptor.AfterHttpRequestCalled.Should().BeTrue(); + interceptor.AfterRequestCalled.Should().BeTrue(); + interceptor.BeforeDeserializationCalled.Should().BeFalse(); + + client.Dispose(); + } + + (RestClient client, TestInterceptor interceptor) SetupClient(Action? configureInterceptor = null) { + var interceptor = new TestInterceptor(); + configureInterceptor?.Invoke(interceptor); + + var options = new RestClientOptions(server.Url!) { + Interceptors = [interceptor] + }; + return (new RestClient(options), interceptor); + } + + static RestRequest CreateRequest() { + var body = new TestRequest("foo", 100); + return new RestRequest("post/json").AddJsonBody(body); + } +} + +static class InterceptorChecks { + public static void ShouldHaveCalledAll(this TestInterceptor interceptor) { + interceptor.BeforeRequestCalled.Should().BeTrue(); + interceptor.BeforeHttpRequestCalled.Should().BeTrue(); + interceptor.AfterHttpRequestCalled.Should().BeTrue(); + interceptor.AfterRequestCalled.Should().BeTrue(); + interceptor.BeforeDeserializationCalled.Should().BeTrue(); + } +} \ No newline at end of file diff --git a/test/RestSharp.Tests.Integrated/Interceptor/TestInterceptor.cs b/test/RestSharp.Tests.Integrated/Interceptor/TestInterceptor.cs new file mode 100644 index 000000000..c5c88f8f9 --- /dev/null +++ b/test/RestSharp.Tests.Integrated/Interceptor/TestInterceptor.cs @@ -0,0 +1,45 @@ +namespace RestSharp.Tests.Integrated.Interceptor; + +class TestInterceptor : Interceptors.Interceptor { + internal bool BeforeRequestCalled { get; private set; } + internal bool BeforeHttpRequestCalled { get; private set; } + internal bool AfterHttpRequestCalled { get; private set; } + internal bool AfterRequestCalled { get; private set; } + internal bool BeforeDeserializationCalled { get; private set; } + + internal Action? BeforeRequestAction { get; set; } + internal Action? BeforeHttpRequestAction { get; set; } + internal Action? AfterHttpRequestAction { get; set; } + internal Action? AfterRequestAction { get; set; } + internal Action? BeforeDeserializationAction { get; set; } + + public override ValueTask BeforeHttpRequest(HttpRequestMessage req, CancellationToken cancellationToken) { + BeforeHttpRequestCalled = true; + BeforeHttpRequestAction?.Invoke(req); + return base.BeforeHttpRequest(req, cancellationToken); + } + + public override ValueTask AfterHttpRequest(HttpResponseMessage responseMessage, CancellationToken cancellationToken) { + AfterHttpRequestCalled = true; + AfterHttpRequestAction?.Invoke(responseMessage); + return base.AfterHttpRequest(responseMessage, cancellationToken); + } + + public override ValueTask AfterRequest(RestResponse response, CancellationToken cancellationToken) { + AfterRequestCalled = true; + AfterRequestAction?.Invoke(response); + return base.AfterRequest(response, cancellationToken); + } + + public override ValueTask BeforeRequest(RestRequest request, CancellationToken cancellationToken) { + BeforeRequestCalled = true; + BeforeRequestAction?.Invoke(request); + return base.BeforeRequest(request, cancellationToken); + } + + public override ValueTask BeforeDeserialization(RestResponse response, CancellationToken cancellationToken) { + BeforeDeserializationCalled = true; + BeforeDeserializationAction?.Invoke(response); + return base.BeforeDeserialization(response, cancellationToken); + } +} diff --git a/test/RestSharp.Tests.Integrated/JsonBodyTests.cs b/test/RestSharp.Tests.Integrated/JsonBodyTests.cs new file mode 100644 index 000000000..993702b94 --- /dev/null +++ b/test/RestSharp.Tests.Integrated/JsonBodyTests.cs @@ -0,0 +1,59 @@ +using System.Text.Json; +using RestSharp.Tests.Shared.Extensions; +using RestSharp.Tests.Shared.Fixtures; + +namespace RestSharp.Tests.Integrated; + +public sealed class JsonBodyTests : IDisposable { + readonly WireMockServer _server = WireMockServer.Start(); + readonly RestClient _client; + + public JsonBodyTests() => _client = new RestClient(_server.Url!); + + [Fact] + public async Task Query_Parameters_With_Json_Body() { + var capturer = _server.ConfigureBodyCapturer(Method.Put); + + var request = new RestRequest(RequestBodyCapturer.Resource, Method.Put) + .AddJsonBody(new { displayName = "Display Name" }) + .AddQueryParameter("key", "value"); + + await _client.ExecuteAsync(request); + + capturer.ContentType.Should().Be("application/json; charset=utf-8"); + capturer.Body.Should().Be("{\"displayName\":\"Display Name\"}"); + capturer.Url.Should().Be($"{_server.Url}{RequestBodyCapturer.Resource}?key=value"); + } + + [Fact] + public async Task Add_JSON_body_JSON_string() { + const string payload = "{\"displayName\":\"Display Name\"}"; + + var capturer = _server.ConfigureBodyCapturer(Method.Post); + var request = new RestRequest(RequestBodyCapturer.Resource, Method.Post).AddJsonBody(payload); + + await _client.ExecuteAsync(request); + + capturer.ContentType.Should().Be("application/json; charset=utf-8"); + capturer.Body.Should().Be(payload); + } + + [Fact] + public async Task Add_JSON_body_string() { + var payload = $" \"requestBody\": {{ \"content\": {{ \"{ContentType.Json}\": {{ \"schema\": {{ \"type\": \"string\" }} }} }} }}"; + + var expected = JsonSerializer.Serialize(payload); + var capturer = _server.ConfigureBodyCapturer(Method.Post); + var request = new RestRequest(RequestBodyCapturer.Resource, Method.Post).AddJsonBody(payload, true); + + await _client.ExecuteAsync(request); + + capturer.ContentType.Should().Be("application/json; charset=utf-8"); + capturer.Body.Should().Be(expected); + } + + public void Dispose() { + _server.Dispose(); + _client.Dispose(); + } +} \ No newline at end of file diff --git a/test/RestSharp.Tests.Integrated/MultipartFormDataTests.cs b/test/RestSharp.Tests.Integrated/MultipartFormDataTests.cs new file mode 100644 index 000000000..5fba92f84 --- /dev/null +++ b/test/RestSharp.Tests.Integrated/MultipartFormDataTests.cs @@ -0,0 +1,234 @@ +using RestSharp.Tests.Integrated.HttpTracer; +using RestSharp.Tests.Shared.Extensions; +using RestSharp.Tests.Shared.Fixtures; + +namespace RestSharp.Tests.Integrated; + +public sealed class MultipartFormDataTests : IDisposable { + readonly ITestOutputHelper _output; + + public MultipartFormDataTests(ITestOutputHelper output) { + _output = output; + _server = WireMockServer.Start(); + + _capturer = _server.ConfigureBodyCapturer(Method.Post); + + var options = new RestClientOptions($"{_server.Url!}{RequestBodyCapturer.Resource}") { + ConfigureMessageHandler = handler => new HttpTracerHandler(handler, new OutputHttpTracerLogger(output), HttpMessageParts.All) + }; + _client = new RestClient(options); + } + + public void Dispose() { + _server.Dispose(); + _client.Dispose(); + } + + const string LineBreak = "\r\n"; + + const string CharsetString = "charset=utf-8"; + const string ContentTypeString = $"{KnownHeaders.ContentType}: text/plain; {CharsetString}"; + const string ContentDispositionString = $"{KnownHeaders.ContentDisposition}: form-data;"; + + const string Expected = + $"--{{0}}{LineBreak}{ContentTypeString}{LineBreak}{ContentDispositionString} name=\"foo\"{LineBreak}{LineBreak}bar{LineBreak}" + + $"--{{0}}{LineBreak}{ContentTypeString}{LineBreak}{ContentDispositionString} name=\"a name with spaces\"{LineBreak}{LineBreak}somedata{LineBreak}" + + $"--{{0}}--{LineBreak}"; + + const string ExpectedFileAndBodyRequestContent = + "--{0}" + + $"{LineBreak}{KnownHeaders.ContentType}: application/octet-stream" + + $"{LineBreak}{KnownHeaders.ContentDisposition}: form-data; name=\"fileName\"; filename=\"TestFile.txt\"" + + $"{LineBreak}{LineBreak}This is a test file for RestSharp.{LineBreak}" + + $"--{{0}}{LineBreak}{KnownHeaders.ContentType}: application/json; {CharsetString}" + + $"{LineBreak}{KnownHeaders.ContentDisposition}: form-data; name=\"controlName\"" + + $"{LineBreak}{LineBreak}test{LineBreak}" + + $"--{{0}}--{LineBreak}"; + + const string ExpectedDefaultMultipartContentType = "multipart/form-data; boundary=\"{0}\""; + + const string ExpectedCustomMultipartContentType = "multipart/vnd.resteasy+form-data; boundary=\"{0}\""; + + readonly WireMockServer _server; + readonly RestClient _client; + readonly RequestBodyCapturer _capturer; + + static void AddParameters(RestRequest request) { + request.AddParameter("foo", "bar"); + request.AddParameter("a name with spaces", "somedata"); + } + + [Fact] + public async Task AlwaysMultipartFormData_WithParameter_Execute() { + var request = new RestRequest("?json_route=/posts") { + AlwaysMultipartFormData = true, + Method = Method.Post + }; + + request.AddParameter("title", "test", ParameterType.RequestBody); + + var response = await _client.ExecuteAsync(request); + + Assert.Null(response.ErrorException); + } + + [Fact] + public async Task MultipartFormData_NoBoundaryQuotes() { + var request = new RestRequest("/", Method.Post) { AlwaysMultipartFormData = true }; + + AddParameters(request); + request.MultipartFormQuoteBoundary = false; + + await _client.ExecuteAsync(request); + + var expected = string.Format(Expected, request.FormBoundary); + + _capturer.Body.Should().Be(expected); + _capturer.ContentType.Should().Be($"multipart/form-data; boundary={request.FormBoundary}"); + } + + [Fact] + public async Task MultipartFormData() { + var request = new RestRequest("/", Method.Post) { AlwaysMultipartFormData = true }; + + AddParameters(request); + + var response = await _client.ExecuteAsync(request); + + var expected = string.Format(Expected, request.FormBoundary); + + _output.WriteLine($"Expected: {expected}"); + _output.WriteLine($"Actual: {response.Content}"); + + _capturer.Body.Should().Be(expected); + _capturer.ContentType.Should().Be($"multipart/form-data; boundary=\"{request.FormBoundary}\""); + } + + [Fact] + public async Task MultipartFormData_HasDefaultContentType() { + var request = new RestRequest("/", Method.Post); + + var path = Path.Combine(AppDomain.CurrentDomain.BaseDirectory, "Assets", "TestFile.txt"); + request.AddFile("fileName", path); + + request.AddParameter(new BodyParameter("controlName", "test", ContentType.Json)); + + var response = await _client.ExecuteAsync(request); + + var boundary = request.FormBoundary; + + var expectedFileAndBodyRequestContent = string.Format(ExpectedFileAndBodyRequestContent, boundary); + var expectedDefaultMultipartContentType = string.Format(ExpectedDefaultMultipartContentType, boundary); + + _output.WriteLine($"Expected: {expectedFileAndBodyRequestContent}"); + _output.WriteLine($"Actual: {response.Content}"); + + _capturer.Body.Should().Be(expectedFileAndBodyRequestContent); + _capturer.ContentType.Should().Be(expectedDefaultMultipartContentType); + } + + [Fact] + public async Task MultipartFormData_WithCustomContentType() { + var request = new RestRequest("/", Method.Post); + + var path = Path.Combine(AppDomain.CurrentDomain.BaseDirectory, "Assets", "TestFile.txt"); + + const string customContentType = "multipart/vnd.resteasy+form-data"; + request.AddHeader(KnownHeaders.ContentType, customContentType); + request.AddFile("fileName", path); + request.AddParameter(new BodyParameter("controlName", "test", ContentType.Json)); + + await _client.ExecuteAsync(request); + var boundary = request.FormBoundary; + + var expectedFileAndBodyRequestContent = string.Format(ExpectedFileAndBodyRequestContent, boundary); + var expectedCustomMultipartContentType = string.Format(ExpectedCustomMultipartContentType, boundary); + + _capturer.Body.Should().Be(expectedFileAndBodyRequestContent); + _capturer.ContentType.Should().Be(expectedCustomMultipartContentType); + } + + [Fact] + public async Task MultipartFormData_WithParameterAndFile_Async() { + var request = new RestRequest("/", Method.Post) { + AlwaysMultipartFormData = true + }; + + var path = Path.Combine(AppDomain.CurrentDomain.BaseDirectory, "Assets", "TestFile.txt"); + request.AddFile("fileName", path); + + request.AddParameter(new BodyParameter("controlName", "test", ContentType.Json)); + + await _client.ExecuteAsync(request); + var boundary = request.FormBoundary; + + var expectedFileAndBodyRequestContent = string.Format(ExpectedFileAndBodyRequestContent, boundary); + + _capturer.Body.Should().Be(expectedFileAndBodyRequestContent); + } + + [Fact] + public async Task MultipartFormDataAsync() { + var request = new RestRequest("/", Method.Post) { AlwaysMultipartFormData = true }; + + AddParameters(request); + + await _client.ExecuteAsync(request); + + var boundary = request.FormBoundary; + var expected = string.Format(Expected, boundary); + + _capturer.Body.Should().Be(expected); + } + + [Fact] + public async Task MultipartFormData_Without_File_Creates_A_Valid_RequestBody() { + using var client = new RestClient(_server.Url!); + + var request = new RestRequest(RequestBodyCapturer.Resource, Method.Post) { + AlwaysMultipartFormData = true + }; + var capturer = _server.ConfigureBodyCapturer(Method.Post); + + const string bodyData = "abc123 foo bar baz BING!"; + const string multipartName = "mybody"; + + request.AddParameter(new BodyParameter(multipartName, bodyData, ContentType.Plain)); + + await client.ExecuteAsync(request); + + var expectedBody = new[] { + ContentTypeString, + $"{ContentDispositionString} name=\"{multipartName}\"", + bodyData + }; + + var actual = capturer.Body!.Replace("\n", string.Empty).Split('\r'); + actual.Should().Contain(expectedBody); + } + + [Fact] + public async Task PostParameter_contentType_in_multipart_form() { + using var client = new RestClient(_server.Url!); + + var request = new RestRequest(RequestBodyCapturer.Resource, Method.Post) { + AlwaysMultipartFormData = true + }; + var capturer = _server.ConfigureBodyCapturer(Method.Post); + + const string parameterName = "Arequest"; + const string parameterValue = "{\"attributeFormat\":\"pdf\"}"; + + var parameter = new GetOrPostParameter(parameterName, parameterValue) { + ContentType = "application/json" + }; + request.AddParameter(parameter); + + await client.ExecuteAsync(request); + + var actual = capturer.Body!.Replace("\n", string.Empty).Split('\r'); + actual[1].Should().Be("Content-Type: application/json; charset=utf-8"); + actual[2].Should().Be($"Content-Disposition: form-data; name=\"{parameterName}\""); + actual[4].Should().Be(parameterValue); + } +} \ No newline at end of file diff --git a/test/RestSharp.Tests.Integrated/NonProtocolExceptionHandlingTests.cs b/test/RestSharp.Tests.Integrated/NonProtocolExceptionHandlingTests.cs new file mode 100644 index 000000000..b11f1ba02 --- /dev/null +++ b/test/RestSharp.Tests.Integrated/NonProtocolExceptionHandlingTests.cs @@ -0,0 +1,68 @@ +namespace RestSharp.Tests.Integrated; + +public sealed class NonProtocolExceptionHandlingTests : IDisposable { + public NonProtocolExceptionHandlingTests() + => _server + .Given(Request.Create().WithPath("/timeout")) + .RespondWith(Response.Create().WithDelay(TimeSpan.FromSeconds(1))); + + // ReSharper disable once ClassNeverInstantiated.Local + class StupidClass { + // ReSharper disable once UnusedMember.Local + public string Property { get; set; } = null!; + } + + public void Dispose() => _server.Dispose(); + + readonly WireMockServer _server = WireMockServer.Start(); + +#if NET + [Fact] + public async Task Handles_HttpClient_Timeout_Error() { + using var client = new RestClient(new HttpClient { Timeout = TimeSpan.FromMilliseconds(500) }); + + var request = new RestRequest($"{_server.Url}/timeout"); + var response = await client.ExecuteAsync(request); + + response.ErrorException.Should().BeOfType(); + response.ResponseStatus.Should().Be(ResponseStatus.TimedOut, response.ErrorMessage); + } +#endif + + [Fact] + public async Task Handles_Server_Timeout_Error() { + using var client = new RestClient(_server.Url!); + + var request = new RestRequest("timeout") { Timeout = TimeSpan.FromMilliseconds(500) }; + var response = await client.ExecuteAsync(request); + + response.ErrorException.Should().BeOfType(); + response.ResponseStatus.Should().Be(ResponseStatus.TimedOut); + } + + [Fact] + public async Task Handles_Server_Timeout_Error_With_Deserializer() { + using var client = new RestClient(_server.Url!); + + var request = new RestRequest("timeout") { Timeout = TimeSpan.FromMilliseconds(500) }; + var response = await client.ExecuteAsync(request); + + response.Data.Should().BeNull(); + response.ErrorException.Should().BeOfType(); + response.ResponseStatus.Should().Be(ResponseStatus.TimedOut); + } + + [Fact] + public async Task Handles_Non_Existent_Domain() { + using var client = new RestClient("http://this.cannot.exist:8001"); + + var request = new RestRequest("/") { + RequestFormat = DataFormat.Json, + Method = Method.Get + }; + var response = await client.ExecuteAsync(request); + + response.ErrorException.Should().BeOfType(); + response.ResponseStatus.Should().Be(ResponseStatus.Error); + } +} \ No newline at end of file diff --git a/test/RestSharp.Tests.Integrated/NtlmTests.cs b/test/RestSharp.Tests.Integrated/NtlmTests.cs new file mode 100644 index 000000000..3edb1c140 --- /dev/null +++ b/test/RestSharp.Tests.Integrated/NtlmTests.cs @@ -0,0 +1,65 @@ +using System.Runtime.InteropServices; +using RestSharp.Tests.Integrated.Fixtures; +using RestSharp.Tests.Shared.Fixtures; + +namespace RestSharp.Tests.Integrated; + +/// +/// These tests use NTML auth and don't work on Linux, at least not in GH Actions +/// +public class NtlmTests : CaptureFixture { + [Fact] + public async Task Does_Not_Pass_Default_Credentials_When_Server_Does_Not_Negotiate() { + if (RuntimeInformation.IsOSPlatform(OSPlatform.Linux)) return; + + using var server = SimpleServer.Create(Handlers.Generic()); + using var client = new RestClient(new RestClientOptions(server.Url) { UseDefaultCredentials = true }); + + var request = new RestRequest(RequestHeadCapturer.Resource); + await client.ExecuteAsync(request); + + Assert.NotNull(RequestHeadCapturer.CapturedHeaders); + var keys = RequestHeadCapturer.CapturedHeaders.Keys.Cast().ToArray(); + + Assert.False( + keys.Contains(KnownHeaders.Authorization), + "Authorization header was present in HTTP request from client, even though server does not use the Negotiate scheme" + ); + } + + [Fact] + public async Task Does_Not_Pass_Default_Credentials_When_UseDefaultCredentials_Is_False() { + if (RuntimeInformation.IsOSPlatform(OSPlatform.Linux)) return; + + using var server = SimpleServer.Create(Handlers.Generic(), AuthenticationSchemes.Negotiate); + using var client = new RestClient(new RestClientOptions(server.Url) { UseDefaultCredentials = false }); + + var request = new RestRequest(RequestHeadCapturer.Resource); + var response = await client.ExecuteAsync(request); + + Assert.Equal(HttpStatusCode.Unauthorized, response.StatusCode); + Assert.Null(RequestHeadCapturer.CapturedHeaders); + } + + [Fact] + public async Task Passes_Default_Credentials_When_UseDefaultCredentials_Is_True() { + if (!RuntimeInformation.IsOSPlatform(OSPlatform.Windows)) return; + + using var server = SimpleServer.Create(Handlers.Generic(), AuthenticationSchemes.Negotiate); + using var client = new RestClient(new RestClientOptions(server.Url) { UseDefaultCredentials = true }); + + var request = new RestRequest(RequestHeadCapturer.Resource); + var response = await client.ExecuteAsync(request); + + response.StatusCode.Should().BeOneOf(HttpStatusCode.OK, HttpStatusCode.Unauthorized); + RequestHeadCapturer.CapturedHeaders.Should().NotBeNull(); + + var keys = RequestHeadCapturer.CapturedHeaders!.Keys.Cast().ToArray(); + + keys.Should() + .Contain( + KnownHeaders.Authorization, + "Authorization header not present in HTTP request from client, even though UseDefaultCredentials = true" + ); + } +} \ No newline at end of file diff --git a/test/RestSharp.Tests.Integrated/PostTests.cs b/test/RestSharp.Tests.Integrated/PostTests.cs new file mode 100644 index 000000000..68b2777f0 --- /dev/null +++ b/test/RestSharp.Tests.Integrated/PostTests.cs @@ -0,0 +1,75 @@ +namespace RestSharp.Tests.Integrated; + +public sealed class PostTests(WireMockTestServer server) : IClassFixture, IDisposable { + readonly RestClient _client = new(server.Url!); + + [Fact] + public async Task Should_post_json() { + var body = new TestRequest("foo", 100); + var request = new RestRequest("post/json").AddJsonBody(body); + var response = await _client.ExecutePostAsync(request); + + response.Data!.Message.Should().Be(body.Data); + } + + [Fact] + public async Task Should_post_json_with_PostAsync() { + var body = new TestRequest("foo", 100); + var request = new RestRequest("post/json").AddJsonBody(body); + var response = await _client.PostAsync(request); + + response!.Message.Should().Be(body.Data); + } + + [Fact] + public async Task Should_post_json_with_PostJsonAsync() { + var body = new TestRequest("foo", 100); + var response = await _client.PostJsonAsync("post/json", body); + + response!.Message.Should().Be(body.Data); + } + + [Fact] + public async Task Should_post_large_form_data() { + const int length = 1024 * 1024; + + var superLongString = new string('?', length); + var request = new RestRequest("post/form", Method.Post).AddParameter("big_string", superLongString); + var response = await _client.ExecuteAsync(request); + + response.StatusCode.Should().Be(HttpStatusCode.OK); + response.Data!.Message.Should().Be($"Works! Length: {length}"); + } + + [Fact] + public async Task Should_post_both_default_and_request_parameters() { + var defParam = new PostParameter("default", "default"); + var reqParam = new PostParameter("request", "request"); + + _client.AddDefaultParameter(defParam.Name, defParam.Value); + + var request = new RestRequest("post/data") + .AddParameter(reqParam.Name, reqParam.Value); + + var response = await _client.ExecutePostAsync(request); + response.StatusCode.Should().Be(HttpStatusCode.OK); + + CheckResponse(defParam); + CheckResponse(reqParam); + return; + + void CheckResponse(PostParameter parameter) { + var p = response.Data!.FirstOrDefault(x => x.Name == parameter.Name); + p.Should().NotBeNull(); + p!.Value.Should().Be(parameter.Value); + } + } + + class Response { + public string Message { get; set; } = null!; + } + + record PostParameter(string Name, string Value); + + public void Dispose() => _client.Dispose(); +} \ No newline at end of file diff --git a/test/RestSharp.Tests.Integrated/ProxyTests.cs b/test/RestSharp.Tests.Integrated/ProxyTests.cs new file mode 100644 index 000000000..5562fe3fd --- /dev/null +++ b/test/RestSharp.Tests.Integrated/ProxyTests.cs @@ -0,0 +1,15 @@ +namespace RestSharp.Tests.Integrated; + +public class ProxyTests { + [Fact] + public async Task Set_Invalid_Proxy_Fails() { + using var server = WireMockServer.Start(); + using var client = new RestClient(new RestClientOptions(server.Url!) { Proxy = new WebProxy("non_existent_proxy", false) }); + + var request = new RestRequest(); + var response = await client.ExecuteAsync(request); + + response.IsSuccessful.Should().BeFalse(); + response.ErrorException.Should().BeOfType(); + } +} \ No newline at end of file diff --git a/test/RestSharp.Tests.Integrated/PutTests.cs b/test/RestSharp.Tests.Integrated/PutTests.cs new file mode 100644 index 000000000..70a784d07 --- /dev/null +++ b/test/RestSharp.Tests.Integrated/PutTests.cs @@ -0,0 +1,42 @@ +using System.Text.Json; + +namespace RestSharp.Tests.Integrated; + +public sealed class PutTests(WireMockTestServer server) : IClassFixture, IDisposable { + readonly RestClient _client = new(server.Url!); + + static readonly JsonSerializerOptions Options = new(JsonSerializerDefaults.Web); + + [Fact] + public async Task Should_put_json_body() { + var body = new TestRequest("foo", 100); + var request = new RestRequest("/content").AddJsonBody(body); + + var response = await _client.PutAsync(request); + + var expected = JsonSerializer.Serialize(body, Options); + response.Content.Should().Be(expected); + } + + [Fact] + public async Task Should_put_json_body_using_extension() { + var body = new TestRequest("foo", 100); + var response = await _client.PutJsonAsync("/content", body); + + response.Should().BeEquivalentTo(body); + } + + [Fact] + public async Task Can_Timeout_PUT_Async() { + var request = new RestRequest("/timeout", Method.Put).AddBody("Body_Content"); + + // Half the value of ResponseHandler.Timeout + request.Timeout = TimeSpan.FromMilliseconds(200); + + var response = await _client.ExecuteAsync(request); + + Assert.Equal(ResponseStatus.TimedOut, response.ResponseStatus); + } + + public void Dispose() => _client.Dispose(); +} diff --git a/test/RestSharp.Tests.Integrated/RedirectTests.cs b/test/RestSharp.Tests.Integrated/RedirectTests.cs new file mode 100644 index 000000000..970c567cd --- /dev/null +++ b/test/RestSharp.Tests.Integrated/RedirectTests.cs @@ -0,0 +1,37 @@ +namespace RestSharp.Tests.Integrated; + +public sealed class RedirectTests(WireMockTestServer server) : IClassFixture, IDisposable { + readonly RestClient _client = new(new RestClientOptions(server.Url!) { FollowRedirects = true }); + + [Fact] + public async Task Can_Perform_GET_Async_With_Redirect() { + const string val = "Works!"; + + var request = new RestRequest("redirect"); + var response = await _client.ExecuteAsync(request); + + response.StatusCode.Should().Be(HttpStatusCode.OK); + response.Data!.Message.Should().Be(val); + } + + [Fact] + public async Task ResponseUri_Should_Be_Final_Url_When_FollowRedirects_True() { + var request = new RestRequest("redirect"); + var response = await _client.ExecuteAsync(request); + + response.ResponseUri.Should().Be(new Uri(new Uri(server.Url!), "success")); + } + + [Fact] + public async Task ResponseUri_Should_Be_Redirect_Target_When_FollowRedirects_False() { + using var client = new RestClient(new RestClientOptions(server.Url!) { FollowRedirects = false }); + + var request = new RestRequest("redirect"); + var response = await client.ExecuteAsync(request); + + response.StatusCode.Should().Be(HttpStatusCode.Redirect); + response.ResponseUri.Should().Be(new Uri(new Uri(server.Url!), "success")); + } + + public void Dispose() => _client.Dispose(); +} \ No newline at end of file diff --git a/test/RestSharp.Tests.Integrated/RequestBodyTests.cs b/test/RestSharp.Tests.Integrated/RequestBodyTests.cs new file mode 100644 index 000000000..a2636d5e0 --- /dev/null +++ b/test/RestSharp.Tests.Integrated/RequestBodyTests.cs @@ -0,0 +1,88 @@ +using RestSharp.Tests.Shared.Extensions; +using RestSharp.Tests.Shared.Fixtures; + +namespace RestSharp.Tests.Integrated; + +public sealed class RequestBodyTests : IDisposable { + // const string NewLine = "\r\n"; + + static readonly string ExpectedTextContentType = $"{ContentType.Plain}; charset=utf-8"; + static readonly string ExpectedTextContentTypeNoCharset = ContentType.Plain; + + readonly WireMockServer _server = WireMockServer.Start(s => s.AllowBodyForAllHttpMethods = true); + + async Task AssertBody(Method method, bool disableCharset = false) { +#if NET + var options = new RestClientOptions(_server.Url!) { DisableCharset = disableCharset }; + using var client = new RestClient(options); + var request = new RestRequest(RequestBodyCapturer.Resource, method); + var capturer = _server.ConfigureBodyCapturer(method); + + const string bodyData = "abc123 foo bar baz BING!"; + + request.AddBody(bodyData, ContentType.Plain); + + await client.ExecuteAsync(request); + + var expected = disableCharset ? ExpectedTextContentTypeNoCharset : ExpectedTextContentType; + AssertHasRequestBody(capturer, expected, bodyData); +#endif + } + + [Fact] + public Task Can_Be_Added_To_COPY_Request() => AssertBody(Method.Copy); + + [Fact] + public Task Can_Be_Added_To_DELETE_Request() => AssertBody(Method.Delete); + + [Fact] + public Task Can_Be_Added_To_OPTIONS_Request() => AssertBody(Method.Options); + + [Fact] + public Task Can_Be_Added_To_PATCH_Request() => AssertBody(Method.Patch); + + [Fact] + public Task Can_Be_Added_To_POST_Request_NoCharset() => AssertBody(Method.Post, true); + + [Fact] + public Task Can_Be_Added_To_POST_Request() => AssertBody(Method.Post); + + [Fact] + public Task Can_Be_Added_To_PUT_Request_NoCharset() => AssertBody(Method.Put, true); + + [Fact] + public Task Can_Be_Added_To_PUT_Request() => AssertBody(Method.Put); + + [Fact] + public async Task Can_Have_No_Body_Added_To_POST_Request() { + const Method httpMethod = Method.Post; + + using var client = new RestClient(_server.Url!); + var request = new RestRequest(RequestBodyCapturer.Resource, httpMethod); + var capturer = _server.ConfigureBodyCapturer(httpMethod); + + await client.ExecuteAsync(request); + + AssertHasNoRequestBody(capturer); + } + + [Fact] + public Task Can_Be_Added_To_GET_Request() => AssertBody(Method.Get); + + [Fact] + public Task Can_Be_Added_To_HEAD_Request() => AssertBody(Method.Head); + + static void AssertHasNoRequestBody(RequestBodyCapturer capturer) { + capturer.ContentType.Should().BeNull(); + capturer.HasBody.Should().BeFalse(); + capturer.Body.Should().BeNullOrEmpty(); + } + + static void AssertHasRequestBody(RequestBodyCapturer capturer, string contentType, string bodyData) { + capturer.ContentType.Should().Be(contentType); + capturer.HasBody.Should().BeTrue(); + capturer.Body.Should().Be(bodyData); + } + + public void Dispose() => _server.Dispose(); +} \ No newline at end of file diff --git a/test/RestSharp.Tests.Integrated/RequestFailureTests.cs b/test/RestSharp.Tests.Integrated/RequestFailureTests.cs new file mode 100644 index 000000000..c74306db5 --- /dev/null +++ b/test/RestSharp.Tests.Integrated/RequestFailureTests.cs @@ -0,0 +1,83 @@ +// ReSharper disable ClassNeverInstantiated.Local + +namespace RestSharp.Tests.Integrated; + +public sealed class RequestFailureTests(WireMockTestServer server) : IClassFixture, IDisposable { + readonly RestClient _client = new(server.Url!); + + [Fact] + public async Task Handles_GET_Request_Errors() { + var request = new RestRequest("status?code=404"); + var response = await _client.ExecuteAsync(request); + + response.StatusCode.Should().Be(HttpStatusCode.NotFound); + } + + [Fact] + public async Task Handles_GET_Request_Errors_With_Response_Type() { + var request = new RestRequest("status?code=404"); + var response = await _client.ExecuteAsync(request); + + response.StatusCode.Should().Be(HttpStatusCode.NotFound); + response.IsSuccessStatusCode.Should().BeFalse(); + response.ErrorException.Should().NotBeNull(); + response.Data.Should().Be(null); + } + + [Fact] + public async Task Does_not_throw_on_unsuccessful_status_code_with_option() { + using var client = new RestClient(new RestClientOptions(server.Url!) { SetErrorExceptionOnUnsuccessfulStatusCode = false }); + var request = new RestRequest("status?code=404"); + var response = await client.ExecuteAsync(request); + + response.StatusCode.Should().Be(HttpStatusCode.NotFound); + response.IsSuccessStatusCode.Should().BeFalse(); + response.ErrorException.Should().BeNull(); + response.Data.Should().Be(null); + } + + [Fact] + public async Task Throws_on_unsuccessful_call() { + using var client = new RestClient(new RestClientOptions(server.Url!) { ThrowOnAnyError = true }); + var request = new RestRequest("status?code=500"); + + // ReSharper disable once AccessToDisposedClosure + var task = () => client.ExecuteAsync(request); + await task.Should().ThrowExactlyAsync(); + } + + [Fact] + public async Task GetAsync_throws_on_unsuccessful_call() { + var request = new RestRequest("status?code=500"); + + var task = () => _client.GetAsync(request); + await task.Should().ThrowExactlyAsync(); + } + + [Fact] + public async Task GetAsync_completes_on_404() { + var request = new RestRequest("status?code=404"); + + var response = await _client.GetAsync(request); + response.StatusCode.Should().Be(HttpStatusCode.NotFound); + response.ResponseStatus.Should().Be(ResponseStatus.Completed); + } + + [Fact] + public async Task GetAsync_generic_throws_on_unsuccessful_call() { + var request = new RestRequest("status?code=500"); + + var task = () => _client.GetAsync(request); + await task.Should().ThrowExactlyAsync(); + } + + [Fact] + public async Task GetAsync_returns_null_on_404() { + var request = new RestRequest("status?code=404"); + + var response = await _client.GetAsync(request); + response.Should().BeNull(); + } + + public void Dispose() => _client.Dispose(); +} \ No newline at end of file diff --git a/test/RestSharp.Tests.Integrated/RequestTests.cs b/test/RestSharp.Tests.Integrated/RequestTests.cs new file mode 100644 index 000000000..ea845ec61 --- /dev/null +++ b/test/RestSharp.Tests.Integrated/RequestTests.cs @@ -0,0 +1,10 @@ +namespace RestSharp.Tests.Integrated; + +public sealed class RequestTests(WireMockTestServer server) + : RequestTestsBase(false), IClassFixture, IDisposable { + readonly RestClient _client = new(server.Url!); + + public void Dispose() => _client.Dispose(); + + protected override IRestClient GetClient() => _client; +} diff --git a/test/RestSharp.Tests.Integrated/ResourceStringParametersTests.cs b/test/RestSharp.Tests.Integrated/ResourceStringParametersTests.cs new file mode 100644 index 000000000..e046cf926 --- /dev/null +++ b/test/RestSharp.Tests.Integrated/ResourceStringParametersTests.cs @@ -0,0 +1,28 @@ +namespace RestSharp.Tests.Integrated; + +public sealed class ResourceStringParametersTests : IDisposable { + readonly WireMockServer _server = WireMockServer.Start(); + + public void Dispose() => _server.Dispose(); + + [Fact] + public async Task Should_keep_to_parameters_with_the_same_name() { + const string parameters = "?priority=Low&priority=Medium"; + + var url = ""; + _server + .Given(Request.Create()) + .RespondWith(Response.Create().WithCallback(req => { + url = req.Url; + return new ResponseMessage(); + })); + + using var client = new RestClient(_server.Url!); + var request = new RestRequest(parameters); + + await client.GetAsync(request); + + var query = new Uri(url).Query; + query.Should().Be(parameters); + } +} \ No newline at end of file diff --git a/test/RestSharp.Tests.Integrated/RestSharp.Tests.Integrated.csproj b/test/RestSharp.Tests.Integrated/RestSharp.Tests.Integrated.csproj new file mode 100644 index 000000000..8018e61be --- /dev/null +++ b/test/RestSharp.Tests.Integrated/RestSharp.Tests.Integrated.csproj @@ -0,0 +1,31 @@ + + + enable + + + + + + + + + + + + + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/test/RestSharp.Tests.Integrated/RootElementTests.cs b/test/RestSharp.Tests.Integrated/RootElementTests.cs new file mode 100644 index 000000000..81da44392 --- /dev/null +++ b/test/RestSharp.Tests.Integrated/RootElementTests.cs @@ -0,0 +1,32 @@ +using RestSharp.Serializers.Xml; + +namespace RestSharp.Tests.Integrated; + +public class RootElementTests { + [Fact] + public async Task Copy_RootElement_From_Request_To_IWithRootElement_Deserializer() { + using var server = WireMockServer.Start(); + + const string xmlBody = + """ + + + + Works! + + + """; + server + .Given(Request.Create().WithPath("/success")) + .RespondWith(Response.Create().WithBody(xmlBody).WithHeader(KnownHeaders.ContentType, ContentType.Xml)); + + using var client = new RestClient(server.Url!, configureSerialization: cfg => cfg.UseXmlSerializer()); + + var request = new RestRequest("success") { RootElement = "Success" }; + + var response = await client.ExecuteAsync(request); + + response.Data.Should().NotBeNull(); + response.Data!.Message.Should().Be("Works!"); + } +} \ No newline at end of file diff --git a/test/RestSharp.Tests.Integrated/StatusCodeTests.cs b/test/RestSharp.Tests.Integrated/StatusCodeTests.cs new file mode 100644 index 000000000..bb821e574 --- /dev/null +++ b/test/RestSharp.Tests.Integrated/StatusCodeTests.cs @@ -0,0 +1,85 @@ +using RestSharp.Serializers.Xml; + +// ReSharper disable UnusedMember.Local +// ReSharper disable InconsistentNaming + +namespace RestSharp.Tests.Integrated; + +public sealed class StatusCodeTests : IDisposable { + public StatusCodeTests() { + _client = new RestClient(_server.Url!, configureSerialization: cfg => cfg.UseXmlSerializer()); + _server + .Given(Request.Create()) + .RespondWith(Response.Create().WithCallback(CreateResponse)); + return; + + ResponseMessage CreateResponse(IRequestMessage request) { + var url = new Uri(request.Url); + + return new ResponseMessage { + StatusCode = int.Parse(url.Segments.Last()) + }; + } + } + + public void Dispose() { + _server.Dispose(); + _client.Dispose(); + } + + readonly WireMockServer _server = WireMockServer.Start(); + readonly RestClient _client; + + [Fact] + public async Task Handles_GET_Request_404_Error() { + var request = new RestRequest("404"); + var response = await _client.ExecuteAsync(request); + + response.StatusCode.Should().Be(HttpStatusCode.NotFound); + } + + [Fact] + public async Task Reports_1xx_Status_Code_Success_Accurately() { + var request = new RestRequest("100"); + var response = await _client.ExecuteAsync(request); + + response.IsSuccessful.Should().BeFalse(); + response.IsSuccessStatusCode.Should().BeFalse(); + } + + [Fact] + public async Task Reports_2xx_Status_Code_Success_Accurately() { + var request = new RestRequest("204"); + var response = await _client.ExecuteAsync(request); + + response.IsSuccessful.Should().BeTrue(); + response.IsSuccessStatusCode.Should().BeTrue(); + } + + [Fact] + public async Task Reports_3xx_Status_Code_Success_Accurately() { + var request = new RestRequest("301"); + var response = await _client.ExecuteAsync(request); + + response.IsSuccessful.Should().BeFalse(); + response.IsSuccessStatusCode.Should().BeFalse(); + } + + [Fact] + public async Task Reports_4xx_Status_Code_Success_Accurately() { + var request = new RestRequest("404"); + var response = await _client.ExecuteAsync(request); + + response.IsSuccessful.Should().BeFalse(); + response.IsSuccessStatusCode.Should().BeFalse(); + } + + [Fact] + public async Task Reports_5xx_Status_Code_Success_Accurately() { + var request = new RestRequest("503"); + var response = await _client.ExecuteAsync(request); + + response.IsSuccessful.Should().BeFalse(); + response.IsSuccessStatusCode.Should().BeFalse(); + } +} \ No newline at end of file diff --git a/test/RestSharp.Tests.Integrated/StructuredSyntaxSuffixTests.cs b/test/RestSharp.Tests.Integrated/StructuredSyntaxSuffixTests.cs new file mode 100644 index 000000000..255ce7058 --- /dev/null +++ b/test/RestSharp.Tests.Integrated/StructuredSyntaxSuffixTests.cs @@ -0,0 +1,100 @@ +using System.Text; +using RestSharp.Serializers.Xml; +using WireMock.Types; +using WireMock.Util; + +// ReSharper disable UnusedAutoPropertyAccessor.Local + +namespace RestSharp.Tests.Integrated; + +public sealed class StructuredSyntaxSuffixTests : IDisposable { + readonly WireMockServer _server; + + class Person { + public string Name { get; set; } = null!; + + public int Age { get; set; } + } + + const string XmlContent = "Bob50"; + const string JsonContent = """{ "name":"Bob", "age":50 }"""; + + public StructuredSyntaxSuffixTests() { + _server = WireMockServer.Start(); + _server.Given(Request.Create().WithPath("/").UsingGet()).RespondWith(Response.Create().WithCallback(Handle)); + return; + + static ResponseMessage Handle(IRequestMessage request) { + var response = new ResponseMessage { + Headers = new Dictionary> { + [KnownHeaders.ContentType] = new(request.Query!["ct"]) + }, + StatusCode = 200, + BodyData = new BodyData { + BodyAsString = request.Query["c"].First(), + Encoding = Encoding.UTF8, + DetectedBodyType = BodyType.String + } + }; + return response; + } + } + + public void Dispose() => _server.Dispose(); + + [Fact] + public async Task By_default_application_json_content_type_should_deserialize_as_JSON() { + using var client = new RestClient(_server.Url!); + + var request = new RestRequest() + .AddParameter("ct", ContentType.Json) + .AddParameter("c", JsonContent); + + var response = await client.ExecuteAsync(request); + + response.Data!.Name.Should().Be("Bob"); + response.Data.Age.Should().Be(50); + } + + [Fact] + public async Task By_default_content_types_with_JSON_structured_syntax_suffix_should_deserialize_as_JSON() { + using var client = new RestClient(_server.Url!); + + var request = new RestRequest() + .AddParameter("ct", "application/vnd.somebody.something+json") + .AddParameter("c", JsonContent); + + var response = await client.ExecuteAsync(request); + + response.Data!.Name.Should().Be("Bob"); + response.Data.Age.Should().Be(50); + } + + [Fact] + public async Task By_default_content_types_with_XML_structured_syntax_suffix_should_deserialize_as_XML() { + using var client = new RestClient(_server.Url!, configureSerialization: cfg => cfg.UseXmlSerializer()); + + var request = new RestRequest() + .AddParameter("ct", "application/vnd.somebody.something+xml") + .AddParameter("c", XmlContent); + + var response = await client.ExecuteAsync(request); + + response.Data!.Name.Should().Be("Bob"); + response.Data.Age.Should().Be(50); + } + + [Fact] + public async Task By_default_text_xml_content_type_should_deserialize_as_XML() { + using var client = new RestClient(_server.Url!, configureSerialization: cfg => cfg.UseXmlSerializer()); + + var request = new RestRequest() + .AddParameter("ct", "text/xml") + .AddParameter("c", XmlContent); + + var response = await client.ExecuteAsync(request); + + Assert.Equal("Bob", response.Data!.Name); + Assert.Equal(50, response.Data.Age); + } +} \ No newline at end of file diff --git a/test/RestSharp.Tests.Integrated/UploadFileTests.cs b/test/RestSharp.Tests.Integrated/UploadFileTests.cs new file mode 100644 index 000000000..533208669 --- /dev/null +++ b/test/RestSharp.Tests.Integrated/UploadFileTests.cs @@ -0,0 +1,114 @@ +// ReSharper disable MethodHasAsyncOverload + +using HttpMultipartParser; +using RestSharp.Extensions; + +namespace RestSharp.Tests.Integrated; + +public sealed class UploadFileTests : IDisposable { + readonly ITestOutputHelper _output; + readonly RestClient _client; + readonly string _basePath = AppDomain.CurrentDomain.BaseDirectory; + readonly string _path; + readonly UploadResponse _expected; + readonly WireMockServer _server = WireMockServer.Start(); + + const string Filename = "Koala.jpg"; + + public UploadFileTests(ITestOutputHelper output) { + _output = output; + _client = new RestClient(new RestClientOptions(_server.Url!)); + _path = Path.Combine(_basePath, "Assets", Filename); + _expected = new UploadResponse(Filename, new FileInfo(_path).Length, true); + + _server + .Given(Request.Create().WithPath("/upload")) + .RespondWith(Response.Create().WithCallback(HandleUpload)); + } + + [Fact] + public async Task Should_upload_from_file() { + var request = new RestRequest("upload").AddFile("file", _path); + var response = await _client.ExecutePostAsync(request); + + response.StatusCode.Should().Be(HttpStatusCode.OK); + + _output.WriteLine(response.Content); + response.Data.Should().BeEquivalentTo(_expected); + } + + [Fact] + public async Task Should_upload_from_bytes() { + var bytes = File.ReadAllBytes(_path); + + var request = new RestRequest("upload").AddFile("file", bytes, Filename); + var response = await _client.ExecutePostAsync(request); + + _output.WriteLine(response.Content); + response.Data.Should().BeEquivalentTo(_expected); + } + + [Fact] + public async Task Should_upload_from_stream() { + var request = new RestRequest("upload").AddFile("file", () => File.OpenRead(_path), Filename); + var response = await _client.ExecutePostAsync(request); + + _output.WriteLine(response.Content); + response.Data.Should().BeEquivalentTo(_expected); + } + + // This test fails because MultipartFormDataParser doesn't understand filename* + [Fact] + public async Task Should_upload_from_stream_non_ascii() { + const string nonAsciiFilename = "Präsentation_Export.zip"; + + var options = new FileParameterOptions { DisableFilenameEncoding = true, DisableFilenameStar = false }; + + var request = new RestRequest("upload") + .AddFile("file", () => File.OpenRead(_path), nonAsciiFilename, options: options) + .AddQueryParameter("checkFile", "false"); + var response = await _client.ExecutePostAsync(request); + + _output.WriteLine(response.Content); + response.Data.Should().BeEquivalentTo(new UploadResponse(nonAsciiFilename, new FileInfo(_path).Length, true)); + } + + static async Task HandleUpload(IRequestMessage request) { + var response = new ResponseMessage(); + + var checkFile = request.Query == null || + request.Query.Count == 0 || + request.Query.ContainsKey("checkFile") && bool.Parse(request.Query["checkFile"][0]); + + using var stream = new MemoryStream(request.BodyAsBytes!); + var form = await MultipartFormDataParser.ParseAsync(stream); + if (form.Files.Count == 0) return response; + + var fileSection = form.Files[0]; + var fileLength = fileSection.Data.Length; + var fileName = fileSection.FileName; + + // ReSharper disable once InvertIf + if (checkFile) { + var assetPath = Path.Combine(AppDomain.CurrentDomain.BaseDirectory, "Assets"); + + try { + var expected = File.ReadAllBytes(Path.Combine(assetPath, fileName)); + fileSection.Data.Seek(0, SeekOrigin.Begin); + var received = await fileSection.Data.ReadAsBytes(default); + var equal = received.SequenceEqual(expected); + return WireMockTestServer.CreateJson(new UploadResponse(fileName, fileLength, equal)); + } + catch (Exception) { + return response; + } + } + + return WireMockTestServer.CreateJson(new UploadResponse(fileName, fileLength, true)); + } + + public void Dispose() { + _client.Dispose(); + _server.Dispose(); + } +} \ No newline at end of file diff --git a/test/RestSharp.Tests.Integrated/XmlResponseTests.cs b/test/RestSharp.Tests.Integrated/XmlResponseTests.cs new file mode 100644 index 000000000..257f18ad6 --- /dev/null +++ b/test/RestSharp.Tests.Integrated/XmlResponseTests.cs @@ -0,0 +1,124 @@ +using RestSharp.Interceptors; +using RestSharp.Serializers.Xml; + +namespace RestSharp.Tests.Integrated; + +public sealed class XmlResponseTests : IDisposable { + public XmlResponseTests() { + _server = WireMockServer.Start(); + + _server + .Given(Request.Create().WithPath("/contenttype_odata")) + .RespondWith(Response.Create().WithCallback(ContentTypeOData)); + + _server + .Given(Request.Create().WithPath("/success")) + .RespondWith( + Response + .Create() + .WithHeader(KnownHeaders.ContentType, ContentType.Xml) + .WithBody( + """ + + + + Works! + + + """ + ) + ); + + _server + .Given(Request.Create().WithPath("/error")) + .RespondWith( + Response + .Create() + .WithStatusCode(400) + .WithHeader(KnownHeaders.ContentType, ContentType.Xml) + .WithBody( + """ + + + + Not found! + + + """ + ) + ); + + _client = new RestClient(_server.Url!, configureSerialization: cfg => cfg.UseXmlSerializer()); + } + + public void Dispose() => _server.Dispose(); + + readonly WireMockServer _server; + readonly RestClient _client; + + [Fact] + public async Task Handles_Default_Root_Element_On_No_Error() { + var request = new RestRequest("success") { + RootElement = "Success" + }; + + var interceptor = new CompatibilityInterceptor { + OnBeforeDeserialization = resp => { + if (resp.StatusCode == HttpStatusCode.NotFound) request.RootElement = "Error"; + } + }; + request.Interceptors = [interceptor]; + + var response = await _client.ExecuteAsync(request); + + response.StatusCode.Should().Be(HttpStatusCode.OK); + response.Data!.Message.Should().Be("Works!"); + } + + [Fact] + public async Task Handles_Different_Root_Element_On_Http_Error() { + var request = new RestRequest("error") { + RootElement = "Success", + Interceptors = [ + new CompatibilityInterceptor { + OnBeforeDeserialization = resp => { + if (resp.StatusCode == HttpStatusCode.BadRequest) resp.RootElement = "Error"; + } + } + ] + }; + + var response = await _client.ExecuteAsync(request); + + response.StatusCode.Should().Be(HttpStatusCode.BadRequest); + response.Data!.Message.Should().Be("Not found!"); + } + + [Fact] + public async Task ContentType_Additional_Information() { + var request = new RestRequest("", Method.Post) { + RequestFormat = DataFormat.Json, + Resource = "contenttype_odata" + }; + request.AddBody("bodyadsodajjd"); + request.AddHeader("X-RequestDigest", "xrequestdigestasdasd"); + request.AddHeader(KnownHeaders.Accept, $"{ContentType.Json}; odata=verbose"); + request.AddHeader(KnownHeaders.ContentType, $"{ContentType.Json}; odata=verbose"); + + var response = await _client.ExecuteAsync(request); + + response.StatusCode.Should().Be(HttpStatusCode.OK); + response.IsSuccessful.Should().BeTrue(); + response.IsSuccessStatusCode.Should().BeTrue(); + } + + static ResponseMessage ContentTypeOData(IRequestMessage request) { + var contentType = request.Headers![KnownHeaders.ContentType]; + var hasCorrectHeader = contentType.Contains($"{ContentType.Json}; odata=verbose"); + + var response = new ResponseMessage { + StatusCode = hasCorrectHeader ? 200 : 400 + }; + return response; + } +} \ No newline at end of file diff --git a/test/RestSharp.Tests.Serializers.Csv/CsvHelperTests.cs b/test/RestSharp.Tests.Serializers.Csv/CsvHelperTests.cs new file mode 100644 index 000000000..bb3ac3df7 --- /dev/null +++ b/test/RestSharp.Tests.Serializers.Csv/CsvHelperTests.cs @@ -0,0 +1,126 @@ +using RestSharp.Serializers.CsvHelper; +using RestSharp.Serializers.Json; +using System.Globalization; + +namespace RestSharp.Tests.Serializers.Csv; + +public sealed class CsvHelperTests : IDisposable { + static readonly Fixture Fixture = new(); + + static CsvHelperTests() => Fixture.Customize(new TestObjectCustomization()); + + readonly WireMockServer _server = WireMockServer.Start(); + + void ConfigureResponse(object expected) { + var serializer = new CsvHelperSerializer(); + + _server + .Given(Request.Create().WithPath("/").UsingGet()) + .RespondWith(Response.Create().WithBody(serializer.Serialize(expected)!).WithHeader(KnownHeaders.ContentType, ContentType.Csv)); + } + + [Fact] + public async Task Use_CsvHelper_For_Response() { + var expected = Fixture.Create(); + ConfigureResponse(expected); + using var client = new RestClient(_server.Url!, configureSerialization: cfg => cfg.UseCsvHelper()); + + var actual = await client.GetAsync(new RestRequest()); + actual.Should().BeEquivalentTo(expected); + } + + [Fact] + public async Task Use_CsvHelper_For_Collection_Response() { + var expected = Fixture.CreateMany(); + + ConfigureResponse(expected); + using var client = new RestClient(_server.Url!, configureSerialization: cfg => cfg.UseCsvHelper()); + + var actual = await client.GetAsync>(new RestRequest()); + actual.Should().BeEquivalentTo(expected); + } + + [Fact] + public async Task Invalid_csv_request_body_should_fail() { + _server + .Given(Request.Create().WithPath("/").UsingGet()) + .RespondWith(Response.Create().WithBody("invalid csv").WithHeader(KnownHeaders.ContentType, ContentType.Csv)); + + using var client = new RestClient(_server.Url!, configureSerialization: cfg => cfg.UseCsvHelper()); + + var response = await client.ExecuteAsync(new()); + response.IsSuccessStatusCode.Should().BeTrue(); + response.IsSuccessful.Should().BeFalse(); + } + + [Fact] + public async Task Valid_csv_response_should_succeed() { + var item = Fixture.Create(); + ConfigureResponse(item); + + using var client = new RestClient(_server.Url!, configureSerialization: cfg => cfg.UseSystemTextJson()); + + var response = await client.ExecuteAsync(new()); + response.IsSuccessStatusCode.Should().BeTrue(); + response.IsSuccessful.Should().BeTrue(); + } + + [Fact] + public void SerializedObject_Should_Be() { + var serializer = new CsvHelperSerializer(new(CultureInfo.InvariantCulture) { NewLine = ";" }); + + var item = Fixture.Create(); + var actual = serializer.Serialize(item); + var expected = $"{TestObject.Titles};{item.ToString(CultureInfo.InvariantCulture)};"; + + actual.Should().Be(expected); + } + + [Fact] + public void SerializedCollection_Should_Be() { + var serializer = new CsvHelperSerializer(new(CultureInfo.InvariantCulture) { NewLine = ";" }); + + var items = new TestObject[] { + new() { + Int32Value = 32, + SingleValue = 16.5f, + StringValue = "hello", + TimeSpanValue = TimeSpan.FromMinutes(10), + DateTimeValue = new(2024, 1, 20) + }, + new() { + Int32Value = 65, + DecimalValue = 89.555m, + TimeSpanValue = TimeSpan.FromSeconds(61), + DateTimeValue = new(2022, 8, 19, 5, 15, 21) + }, + new() { + SingleValue = 80000, + DoubleValue = 20.00001, + StringValue = "String, with comma" + } + }; + string[] strings = [TestObject.Titles, .. items.Select(i => i.ToString(CultureInfo.InvariantCulture))]; + + var expected = $"{string.Join(";", strings)};"; + var actual = serializer.Serialize(items); + + actual.Should().Be(expected); + } + + public void Dispose() => _server?.Dispose(); +} + +class TestObjectCustomization : ICustomization { + public void Customize(IFixture fixture) + => fixture.Customize(o => o + .WithAutoProperties() + .With( + p => p.DateTimeValue, + () => { + var dt = fixture.Create(); + return new(dt.Year, dt.Month, dt.Day, dt.Hour, dt.Minute, dt.Second); + } + ) + ); +} \ No newline at end of file diff --git a/test/RestSharp.Tests.Serializers.Csv/RestSharp.Tests.Serializers.Csv.csproj b/test/RestSharp.Tests.Serializers.Csv/RestSharp.Tests.Serializers.Csv.csproj new file mode 100644 index 000000000..c5305e02b --- /dev/null +++ b/test/RestSharp.Tests.Serializers.Csv/RestSharp.Tests.Serializers.Csv.csproj @@ -0,0 +1,15 @@ + + + + + + + + + + + + + + + diff --git a/test/RestSharp.Tests.Serializers.Csv/TestObject.cs b/test/RestSharp.Tests.Serializers.Csv/TestObject.cs new file mode 100644 index 000000000..6844f7040 --- /dev/null +++ b/test/RestSharp.Tests.Serializers.Csv/TestObject.cs @@ -0,0 +1,21 @@ +using System.Globalization; + +namespace RestSharp.Tests.Serializers.Csv; + +class TestObject { + public string StringValue { get; set; } + public int Int32Value { get; set; } + public decimal DecimalValue { get; set; } + public double DoubleValue { get; set; } + public float SingleValue { get; set; } + public DateTime DateTimeValue { get; set; } + public TimeSpan TimeSpanValue { get; set; } + + public const string Titles = + $"{nameof(StringValue)},{nameof(Int32Value)},{nameof(DecimalValue)},{nameof(DoubleValue)},{nameof(SingleValue)},{nameof(DateTimeValue)},{nameof(TimeSpanValue)}"; + + public string ToString(CultureInfo c) { + var str = StringValue?.Contains(',') == true ? $"\"{StringValue}\"" : StringValue; + return $"{str},{Int32Value},{DecimalValue.ToString(c)},{DoubleValue.ToString(c)},{SingleValue.ToString(c)},{DateTimeValue.ToString(c)},{TimeSpanValue.ToString()}"; + } +} \ No newline at end of file diff --git a/test/RestSharp.Tests.Serializers.Json/NewtonsoftJson/IntegratedSimpleTests.cs b/test/RestSharp.Tests.Serializers.Json/NewtonsoftJson/IntegratedSimpleTests.cs new file mode 100644 index 000000000..995834822 --- /dev/null +++ b/test/RestSharp.Tests.Serializers.Json/NewtonsoftJson/IntegratedSimpleTests.cs @@ -0,0 +1,68 @@ +using RestSharp.Serializers.NewtonsoftJson; +using RestSharp.Tests.Shared.Extensions; + +namespace RestSharp.Tests.Serializers.Json.NewtonsoftJson; + +public sealed class IntegratedSimpleTests : IDisposable { + static readonly Fixture Fixture = new(); + + readonly WireMockServer _server = WireMockServer.Start(); + readonly RestClient _client; + + public IntegratedSimpleTests() => _client = new(_server.Url!, configureSerialization: cfg => cfg.UseNewtonsoftJson()); + + [Fact] + public async Task Should_serialize_request() { + var capturer = _server.ConfigureBodyCapturer(Method.Post, false); + var serializer = new JsonNetSerializer(); + var testData = Fixture.Create(); + var request = new RestRequest().AddJsonBody(testData); + + await _client.PostAsync(request); + var actual = serializer.Deserialize(new(request) { Content = capturer.Body! }); + + actual.Should().BeEquivalentTo(testData); + } + + [Fact] + public async Task Should_deserialize_response() { + var expected = Fixture.Create(); + + _server + .Given(Request.Create().WithPath("/").UsingGet()) + .RespondWith(Response.Create().WithBodyAsJson(expected)); + + var actual = await _client.GetAsync(new RestRequest()); + actual.Should().BeEquivalentTo(expected); + } + + [Fact] + public async Task Invalid_json_body_request_should_fail() { + _server + .Given(Request.Create().WithPath("/").UsingGet()) + .RespondWith(Response.Create().WithBody("invalid json").WithHeader(KnownHeaders.ContentType, ContentType.Json)); + + + var response = await _client.ExecuteAsync(new()); + response.IsSuccessStatusCode.Should().BeTrue(); + response.IsSuccessful.Should().BeFalse(); + } + + [Fact] + public async Task Valid_json_response_should_succeed() { + var item = Fixture.Create(); + + _server + .Given(Request.Create().WithPath("/").UsingGet()) + .RespondWith(Response.Create().WithBodyAsJson(item)); + + var response = await _client.ExecuteAsync(new()); + response.IsSuccessStatusCode.Should().BeTrue(); + response.IsSuccessful.Should().BeTrue(); + } + + public void Dispose() { + _server?.Dispose(); + _client.Dispose(); + } +} \ No newline at end of file diff --git a/test/RestSharp.Tests.Serializers.Json/NewtonsoftJson/IntegratedTests.cs b/test/RestSharp.Tests.Serializers.Json/NewtonsoftJson/IntegratedTests.cs new file mode 100644 index 000000000..82925da7d --- /dev/null +++ b/test/RestSharp.Tests.Serializers.Json/NewtonsoftJson/IntegratedTests.cs @@ -0,0 +1,48 @@ +using Newtonsoft.Json; +using Newtonsoft.Json.Serialization; +using RestSharp.Serializers.NewtonsoftJson; + +namespace RestSharp.Tests.Serializers.Json.NewtonsoftJson; + +public sealed class IntegratedTests : IDisposable { + static readonly Fixture Fixture = new(); + + readonly WireMockServer _server = WireMockServer.Start(); + + [Fact, Obsolete("Obsolete")] + public async Task Use_with_GetJsonAsync() { + var data = Fixture.Create(); + var serialized = JsonConvert.SerializeObject(data, JsonNetSerializer.DefaultSettings); + + _server + .Given(Request.Create().WithPath("/test").UsingGet()) + .RespondWith(Response.Create().WithBody(serialized).WithHeader(KnownHeaders.ContentType, ContentType.Json)); + + using var client = new RestClient(_server.Url!, configureSerialization: cfg => cfg.UseNewtonsoftJson()); + + var response = await client.GetAsync("/test"); + + response.Should().BeEquivalentTo(data); + } + + [Fact] + public async Task Use_with_GetJsonAsync_custom_settings() { + var settings = new JsonSerializerSettings { + ContractResolver = new DefaultContractResolver { NamingStrategy = new SnakeCaseNamingStrategy() } + }; + var data = Fixture.Create(); + var serialized = JsonConvert.SerializeObject(data, settings); + + _server + .Given(Request.Create().WithPath("/test").UsingGet()) + .RespondWith(Response.Create().WithBody(serialized).WithHeader(KnownHeaders.ContentType, ContentType.Json)); + + using var client = new RestClient(_server.Url!, configureSerialization: cfg => cfg.UseNewtonsoftJson(settings)); + + var response = await client.GetAsync("/test"); + + response.Should().BeEquivalentTo(data); + } + + public void Dispose() => _server?.Dispose(); +} diff --git a/test/RestSharp.Tests.Serializers.Json/NewtonsoftJson/SerializationTests.cs b/test/RestSharp.Tests.Serializers.Json/NewtonsoftJson/SerializationTests.cs new file mode 100644 index 000000000..f996b6a3b --- /dev/null +++ b/test/RestSharp.Tests.Serializers.Json/NewtonsoftJson/SerializationTests.cs @@ -0,0 +1,45 @@ +using Newtonsoft.Json; +using Newtonsoft.Json.Serialization; +using RestSharp.Serializers.NewtonsoftJson; + +namespace RestSharp.Tests.Serializers.Json.NewtonsoftJson; + +public class SerializationTests { + static readonly Fixture Fixture = new(); + + readonly JsonSerializerSettings _jsonSerializerSettings = new() { + ContractResolver = new DefaultContractResolver { + NamingStrategy = new CamelCaseNamingStrategy() + }, + Formatting = Formatting.None + }; + + [Fact] + public void Serialize_multiple_objects_within_one_thread() { + var serializer = new JsonNetSerializer(); + var dummy = Fixture.CreateMany().ToArray(); + var expectedSerializations = dummy.Select( + d => JsonConvert.SerializeObject(d, _jsonSerializerSettings) + ).ToList(); + var actualSerializations = dummy.Select(serializer.Serialize).ToList(); + actualSerializations.Should().BeEquivalentTo(expectedSerializations); + } + + [Fact] + public void Serialize_within_multiple_threads() { + var serializer = new JsonNetSerializer(); + + Parallel.For( + 0, + 100, + _ => { + var dummy = Fixture.Create(); + + var expectedSerialization = JsonConvert.SerializeObject(dummy, _jsonSerializerSettings); + var actualSerialization = serializer.Serialize(dummy); + + actualSerialization.Should().Be(expectedSerialization); + } + ); + } +} \ No newline at end of file diff --git a/test/RestSharp.Tests.Serializers.Json/RestSharp.Tests.Serializers.Json.csproj b/test/RestSharp.Tests.Serializers.Json/RestSharp.Tests.Serializers.Json.csproj new file mode 100644 index 000000000..ef87290b5 --- /dev/null +++ b/test/RestSharp.Tests.Serializers.Json/RestSharp.Tests.Serializers.Json.csproj @@ -0,0 +1,16 @@ + + + + + + + + + + + + + + + + diff --git a/test/RestSharp.Tests.Serializers.Json/SampleData.cs b/test/RestSharp.Tests.Serializers.Json/SampleData.cs new file mode 100644 index 000000000..171d4b2ac --- /dev/null +++ b/test/RestSharp.Tests.Serializers.Json/SampleData.cs @@ -0,0 +1,14 @@ +// ReSharper disable UnusedMember.Global +namespace RestSharp.Tests.Serializers.Json; + +public class TestClass { + public string SimpleString { get; set; } + public int SimpleInt { get; set; } + public List List { get; set; } + public Subclass Sub { get; set; } + + public class Subclass { + public string Thing { get; set; } + public int AnotherThing { get; set; } + } +} \ No newline at end of file diff --git a/test/RestSharp.Tests.Serializers.Json/SystemTextJson/SystemTextJsonTests.cs b/test/RestSharp.Tests.Serializers.Json/SystemTextJson/SystemTextJsonTests.cs new file mode 100644 index 000000000..5e913b2d2 --- /dev/null +++ b/test/RestSharp.Tests.Serializers.Json/SystemTextJson/SystemTextJsonTests.cs @@ -0,0 +1,68 @@ +using RestSharp.Serializers.Json; +using RestSharp.Tests.Shared.Extensions; + +namespace RestSharp.Tests.Serializers.Json.SystemTextJson; + +public sealed class SystemTextJsonTests : IDisposable { + static readonly Fixture Fixture = new(); + + readonly WireMockServer _server = WireMockServer.Start(); + readonly RestClient _client; + + public SystemTextJsonTests() => _client = new(_server.Url!); + + [Fact] + public async Task Should_serialize_request() { + var serializer = new SystemTextJsonSerializer(); + var capturer = _server.ConfigureBodyCapturer(Method.Post, false); + + var testData = Fixture.Create(); + var request = new RestRequest().AddJsonBody(testData); + + await _client.PostAsync(request); + + var actual = serializer.Deserialize(new(request) { Content = capturer.Body }); + actual.Should().BeEquivalentTo(testData); + } + + [Fact] + public async Task Should_deserialize_response_with_GenericGet() { + var expected = Fixture.Create(); + + _server + .Given(Request.Create().WithPath("/").UsingGet()) + .RespondWith(Response.Create().WithBodyAsJson(expected)); + + var actual = await _client.GetAsync(new RestRequest()); + actual.Should().BeEquivalentTo(expected); + } + + [Fact] + public async Task Posting_invalid_json_should_fail() { + _server + .Given(Request.Create().WithPath("/").UsingGet()) + .RespondWith(Response.Create().WithBody("invalid json").WithHeader(KnownHeaders.ContentType, ContentType.Json)); + + var response = await _client.ExecuteAsync(new()); + response.IsSuccessStatusCode.Should().BeTrue(); + response.IsSuccessful.Should().BeFalse(); + } + + [Fact] + public async Task Receiving_valid_json_should_succeed() { + var item = Fixture.Create(); + + _server + .Given(Request.Create().WithPath("/").UsingGet()) + .RespondWith(Response.Create().WithBodyAsJson(item)); + + var response = await _client.ExecuteAsync(new()); + response.IsSuccessStatusCode.Should().BeTrue(); + response.IsSuccessful.Should().BeTrue(); + } + + public void Dispose() { + _server?.Dispose(); + _client.Dispose(); + } +} \ No newline at end of file diff --git a/test/RestSharp.Tests.Serializers.Xml/NamespacedXmlTests.cs b/test/RestSharp.Tests.Serializers.Xml/NamespacedXmlTests.cs new file mode 100644 index 000000000..a0572b45d --- /dev/null +++ b/test/RestSharp.Tests.Serializers.Xml/NamespacedXmlTests.cs @@ -0,0 +1,327 @@ +using System.Xml.Linq; +using RestSharp.Serializers.Xml; +using RestSharp.Tests.Serializers.Xml.SampleClasses; +using RestSharp.Tests.Serializers.Xml.SampleClasses.DeserializeAsTest; + +namespace RestSharp.Tests.Serializers.Xml; + +public class NamespacedXmlTests { + const string GuidString = "AC1FC4BC-087A-4242-B8EE-C53EBE9887A5"; + + static string CreateListOfPrimitivesXml() { + var doc = new XDocument(); + var ns = XNamespace.Get("http://restsharp.org"); + var root = new XElement(ns + "artists"); + + root.Add(new XElement(ns + "artist", "first")); + root.Add(new XElement(ns + "artist", "second")); + doc.Add(root); + + return doc.ToString(); + } + + static string CreateUnderscoresXml() { + var doc = new XDocument(); + var ns = XNamespace.Get("http://restsharp.org"); + var root = new XElement(ns + "Person"); + + root.Add(new XElement(ns + "Name", "John Sheehan")); + root.Add(new XElement(ns + "Start_Date", new DateTime(2009, 9, 25, 0, 6, 1))); + root.Add(new XAttribute(ns + "Age", 28)); + root.Add(new XElement(ns + "Percent", 99.9999m)); + root.Add(new XElement(ns + "Big_Number", long.MaxValue)); + root.Add(new XAttribute(ns + "Is_Cool", false)); + root.Add(new XElement(ns + "Ignore", "dummy")); + root.Add(new XAttribute(ns + "Read_Only", "dummy")); + root.Add(new XAttribute(ns + "Unique_Id", new Guid(GuidString))); + root.Add(new XElement(ns + "Url", "http://example.com")); + root.Add(new XElement(ns + "Url_Path", "/foo/bar")); + + root.Add( + new XElement( + ns + "Best_Friend", + new XElement(ns + "Name", "The Fonz"), + new XAttribute(ns + "Since", 1952) + ) + ); + + var friends = new XElement(ns + "Friends"); + + for (var i = 0; i < 10; i++) { + friends.Add( + new XElement( + ns + "Friend", + new XElement(ns + "Name", "Friend" + i), + new XAttribute(ns + "Since", DateTime.Now.Year - i) + ) + ); + } + + root.Add(friends); + + var foes = new XElement(ns + "Foes"); + + foes.Add(new XAttribute(ns + "Team", "Yankees")); + + for (var i = 0; i < 5; i++) foes.Add(new XElement(ns + "Foe", new XElement(ns + "Nickname", $"Foe{i}"))); + + root.Add(foes); + doc.Add(root); + + return doc.ToString(); + } + + static string CreateElementsXml() { + var doc = new XDocument(); + var ns = XNamespace.Get("http://restsharp.org"); + var root = new XElement(ns + "Person"); + + root.Add(new XElement(ns + "Name", "John Sheehan")); + root.Add(new XElement(ns + "StartDate", new DateTime(2009, 9, 25, 0, 6, 1))); + root.Add(new XElement(ns + "Age", 28)); + root.Add(new XElement(ns + "Percent", 99.9999m)); + root.Add(new XElement(ns + "BigNumber", long.MaxValue)); + root.Add(new XElement(ns + "IsCool", false)); + root.Add(new XElement(ns + "Ignore", "dummy")); + root.Add(new XElement(ns + "ReadOnly", "dummy")); + root.Add(new XElement(ns + "UniqueId", new Guid(GuidString))); + root.Add(new XElement(ns + "Url", "http://example.com")); + root.Add(new XElement(ns + "UrlPath", "/foo/bar")); + + root.Add( + new XElement( + ns + "BestFriend", + new XElement(ns + "Name", "The Fonz"), + new XElement(ns + "Since", 1952) + ) + ); + + var friends = new XElement(ns + "Friends"); + + for (var i = 0; i < 10; i++) { + friends.Add( + new XElement( + ns + "Friend", + new XElement(ns + "Name", "Friend" + i), + new XElement(ns + "Since", DateTime.Now.Year - i) + ) + ); + } + + root.Add(friends); + + root.Add( + new XElement( + ns + "FavoriteBand", + new XElement(ns + "Name", "Goldfinger") + ) + ); + + doc.Add(root); + + return doc.ToString(); + } + + static string CreateAttributesXml() { + var doc = new XDocument(); + var ns = XNamespace.Get("http://restsharp.org"); + var root = new XElement(ns + "Person"); + + root.Add(new XAttribute(ns + "Name", "John Sheehan")); + root.Add(new XAttribute(ns + "StartDate", new DateTime(2009, 9, 25, 0, 6, 1))); + root.Add(new XAttribute(ns + "Age", 28)); + root.Add(new XAttribute(ns + "Percent", 99.9999m)); + root.Add(new XAttribute(ns + "BigNumber", long.MaxValue)); + root.Add(new XAttribute(ns + "IsCool", false)); + root.Add(new XAttribute(ns + "Ignore", "dummy")); + root.Add(new XAttribute(ns + "ReadOnly", "dummy")); + root.Add(new XAttribute(ns + "UniqueId", new Guid(GuidString))); + root.Add(new XAttribute(ns + "Url", "http://example.com")); + root.Add(new XAttribute(ns + "UrlPath", "/foo/bar")); + + root.Add( + new XElement( + ns + "BestFriend", + new XAttribute(ns + "Name", "The Fonz"), + new XAttribute(ns + "Since", 1952) + ) + ); + + doc.Add(root); + + return doc.ToString(); + } + + [Fact] + public void Can_Deserialize_Attribute_Using_Exact_Name_Defined_In_DeserializeAs_Attribute() { + const string @namespace = "http://restsharp.org"; + + var ns = XNamespace.Get(@namespace); + + var doc = new XDocument( + new XElement( + ns + "response", + new XAttribute(ns + "attribute-value", "711"), + "random value" + ) + ); + + var expected = new NodeWithAttributeAndValue { + AttributeValue = "711" + }; + + var xml = new XmlDeserializer { Namespace = @namespace }; + var output = xml.Deserialize(new RestResponse { Content = doc.ToString() }); + + Assert.Equal(expected.AttributeValue, output.AttributeValue); + } + + [Fact] + public void Can_Deserialize_Attributes_With_Namespace() { + var doc = CreateAttributesXml(); + var response = new RestResponse { Content = doc }; + var d = new XmlDeserializer { Namespace = "http://restsharp.org" }; + var p = d.Deserialize(response); + + Assert.Equal("John Sheehan", p.Name); + Assert.Equal(new(2009, 9, 25, 0, 6, 1), p.StartDate); + Assert.Equal(28, p.Age); + Assert.Equal(long.MaxValue, p.BigNumber); + Assert.Equal(99.9999m, p.Percent); + Assert.False(p.IsCool); + Assert.Equal(new(GuidString), p.UniqueId); + Assert.Equal(new("http://example.com", UriKind.RelativeOrAbsolute), p.Url); + Assert.Equal(new("/foo/bar", UriKind.RelativeOrAbsolute), p.UrlPath); + Assert.NotNull(p.BestFriend); + Assert.Equal("The Fonz", p.BestFriend.Name); + Assert.Equal(1952, p.BestFriend.Since); + } + + [Fact] + public void Can_Deserialize_Elements_With_Namespace() { + var doc = CreateElementsXml(); + var response = new RestResponse { Content = doc }; + var d = new XmlDeserializer { Namespace = "http://restsharp.org" }; + var p = d.Deserialize(response); + + Assert.Equal("John Sheehan", p.Name); + Assert.Equal(new(2009, 9, 25, 0, 6, 1), p.StartDate); + Assert.Equal(28, p.Age); + Assert.Equal(long.MaxValue, p.BigNumber); + Assert.Equal(99.9999m, p.Percent); + Assert.False(p.IsCool); + Assert.Equal(new(GuidString), p.UniqueId); + Assert.Equal(new("http://example.com", UriKind.RelativeOrAbsolute), p.Url); + Assert.Equal(new("/foo/bar", UriKind.RelativeOrAbsolute), p.UrlPath); + Assert.NotNull(p.Friends); + Assert.Equal(10, p.Friends.Count); + Assert.NotNull(p.BestFriend); + Assert.Equal("The Fonz", p.BestFriend.Name); + Assert.Equal(1952, p.BestFriend.Since); + } + + [Fact] + public void Can_Deserialize_Elements_With_Namespace_Autodetect_Namespace() { + var doc = CreateElementsXml(); + var response = new RestResponse { Content = doc }; + var d = new XmlDeserializer(); + var p = d.Deserialize(response); + + Assert.Equal("John Sheehan", p.Name); + Assert.Equal(new(2009, 9, 25, 0, 6, 1), p.StartDate); + Assert.Equal(28, p.Age); + Assert.Equal(long.MaxValue, p.BigNumber); + Assert.Equal(99.9999m, p.Percent); + Assert.False(p.IsCool); + Assert.Equal(new(GuidString), p.UniqueId); + Assert.Equal(new("http://example.com", UriKind.RelativeOrAbsolute), p.Url); + Assert.Equal(new("/foo/bar", UriKind.RelativeOrAbsolute), p.UrlPath); + Assert.NotNull(p.Friends); + Assert.Equal(10, p.Friends.Count); + Assert.NotNull(p.BestFriend); + Assert.Equal("The Fonz", p.BestFriend.Name); + Assert.Equal(1952, p.BestFriend.Since); + } + + [Fact] + public void Can_Deserialize_List_Of_Primitives_With_Namespace() { + var doc = CreateListOfPrimitivesXml(); + var response = new RestResponse { Content = doc }; + var d = new XmlDeserializer { Namespace = "http://restsharp.org" }; + var a = d.Deserialize>(response); + + Assert.Equal(2, a.Count); + Assert.Equal("first", a[0].Value); + Assert.Equal("second", a[1].Value); + } + + [Fact] + public void Can_Deserialize_Names_With_Underscores_With_Namespace() { + var doc = CreateUnderscoresXml(); + var response = new RestResponse { Content = doc }; + var d = new XmlDeserializer { Namespace = "http://restsharp.org" }; + var p = d.Deserialize(response); + + Assert.Equal("John Sheehan", p.Name); + Assert.Equal(new(2009, 9, 25, 0, 6, 1), p.StartDate); + Assert.Equal(28, p.Age); + Assert.Equal(long.MaxValue, p.BigNumber); + Assert.Equal(99.9999m, p.Percent); + Assert.False(p.IsCool); + Assert.Equal(new(GuidString), p.UniqueId); + Assert.Equal(new("http://example.com", UriKind.RelativeOrAbsolute), p.Url); + Assert.Equal(new("/foo/bar", UriKind.RelativeOrAbsolute), p.UrlPath); + Assert.NotNull(p.Friends); + Assert.Equal(10, p.Friends.Count); + Assert.NotNull(p.BestFriend); + Assert.Equal("The Fonz", p.BestFriend.Name); + Assert.Equal(1952, p.BestFriend.Since); + Assert.NotNull(p.Foes); + Assert.Equal(5, p.Foes.Count); + Assert.Equal("Yankees", p.Foes.Team); + } + + [Fact] + public void Can_Deserialize_Node_Using_Exact_Name_Defined_In_DeserializeAs_Attribute() { + const string @namespace = "http://restsharp.org"; + var ns = XNamespace.Get(@namespace); + + var doc = new XDocument( + new XElement( + ns + "response", + new XElement(ns + "node-value", "711") + ) + ); + + var expected = new SingleNode { + Node = "711" + }; + + var xml = new XmlDeserializer(); + var output = xml.Deserialize(new() { Content = doc.ToString() }); + + Assert.NotNull(output); + + Assert.Equal(expected.Node, output.Node); + } + + [Fact] + public void Ignore_Protected_Property_That_Exists_In_Data() { + var doc = CreateElementsXml(); + var response = new RestResponse { Content = doc }; + var d = new XmlDeserializer { Namespace = "http://restsharp.org" }; + var p = d.Deserialize(response); + + Assert.Null(p.IgnoreProxy); + } + + [Fact] + public void Ignore_ReadOnly_Property_That_Exists_In_Data() { + var doc = CreateElementsXml(); + var response = new RestResponse { Content = doc }; + var d = new XmlDeserializer { Namespace = "http://restsharp.org" }; + var p = d.Deserialize(response); + + Assert.Null(p.ReadOnlyProxy); + } +} \ No newline at end of file diff --git a/test/RestSharp.Tests.Serializers.Xml/RestSharp.Tests.Serializers.Xml.csproj b/test/RestSharp.Tests.Serializers.Xml/RestSharp.Tests.Serializers.Xml.csproj new file mode 100644 index 000000000..10c42ccc4 --- /dev/null +++ b/test/RestSharp.Tests.Serializers.Xml/RestSharp.Tests.Serializers.Xml.csproj @@ -0,0 +1,27 @@ + + + disable + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/test/RestSharp.Tests.Serializers.Xml/SampleClasses/BearerToken.cs b/test/RestSharp.Tests.Serializers.Xml/SampleClasses/BearerToken.cs new file mode 100644 index 000000000..2e3faf202 --- /dev/null +++ b/test/RestSharp.Tests.Serializers.Xml/SampleClasses/BearerToken.cs @@ -0,0 +1,14 @@ +using RestSharp.Serializers; + +namespace RestSharp.Tests.Serializers.Xml.SampleClasses; + +public class BearerToken { + public string AccessToken { get; set; } + public string TokenType { get; set; } + public uint ExpiresIn { get; set; } + public string UserName { get; set; } + [DeserializeAs(Name = ".issued")] + public DateTimeOffset Issued { get; set; } + [DeserializeAs(Name = ".expires")] + public DateTimeOffset Expires { get; set; } +} \ No newline at end of file diff --git a/test/RestSharp.Tests.Serializers.Xml/SampleClasses/BooleanTest.cs b/test/RestSharp.Tests.Serializers.Xml/SampleClasses/BooleanTest.cs new file mode 100644 index 000000000..cecd53dae --- /dev/null +++ b/test/RestSharp.Tests.Serializers.Xml/SampleClasses/BooleanTest.cs @@ -0,0 +1,5 @@ +namespace RestSharp.Tests.Serializers.Xml.SampleClasses; + +public class BooleanTest { + public bool Value { get; set; } +} \ No newline at end of file diff --git a/test/RestSharp.Tests.Serializers.Xml/SampleClasses/ColorWithValue.cs b/test/RestSharp.Tests.Serializers.Xml/SampleClasses/ColorWithValue.cs new file mode 100644 index 000000000..5e873fe20 --- /dev/null +++ b/test/RestSharp.Tests.Serializers.Xml/SampleClasses/ColorWithValue.cs @@ -0,0 +1,9 @@ +using RestSharp.Serializers; + +namespace RestSharp.Tests.Serializers.Xml.SampleClasses; + +[DeserializeAs(Name = "Color")] +public class ColorWithValue { + public string Name { get; set; } + public int Value { get; set; } +} \ No newline at end of file diff --git a/test/RestSharp.Tests.Serializers.Xml/SampleClasses/DeserializeAsTest/misc.cs b/test/RestSharp.Tests.Serializers.Xml/SampleClasses/DeserializeAsTest/misc.cs new file mode 100644 index 000000000..b8a4b9dfd --- /dev/null +++ b/test/RestSharp.Tests.Serializers.Xml/SampleClasses/DeserializeAsTest/misc.cs @@ -0,0 +1,13 @@ +using RestSharp.Serializers; + +namespace RestSharp.Tests.Serializers.Xml.SampleClasses.DeserializeAsTest; + +public class NodeWithAttributeAndValue { + [DeserializeAs(Name = "attribute-value", Attribute = true)] + public string AttributeValue { get; set; } +} + +public class SingleNode { + [DeserializeAs(Name = "node-value")] + public string Node { get; set; } +} \ No newline at end of file diff --git a/test/RestSharp.Tests.Serializers.Xml/SampleClasses/EmployeeTracker.cs b/test/RestSharp.Tests.Serializers.Xml/SampleClasses/EmployeeTracker.cs new file mode 100644 index 000000000..a9dcb002e --- /dev/null +++ b/test/RestSharp.Tests.Serializers.Xml/SampleClasses/EmployeeTracker.cs @@ -0,0 +1,29 @@ +namespace RestSharp.Tests.Serializers.Xml.SampleClasses; + +public class EmployeeTracker { + /// + /// Key: Employee name. + /// Value: Messages sent to employee. + /// + public Dictionary> EmployeesMail { get; set; } + + /// + /// Key: Employee name. + /// Value: Hours worked this each week. + /// + public Dictionary>> EmployeesTime { get; set; } + + /// + /// Key: Employee name. + /// Value: Payments made to employee + /// + public Dictionary> EmployeesPay { get; set; } +} + +public class Payment { + public PaymentType Type { get; set; } + + public int Amount { get; set; } +} + +public enum PaymentType { Bonus, Monthly, BiWeekly } \ No newline at end of file diff --git a/test/RestSharp.Tests.Serializers.Xml/SampleClasses/EnumTest.cs b/test/RestSharp.Tests.Serializers.Xml/SampleClasses/EnumTest.cs new file mode 100644 index 000000000..37efb663b --- /dev/null +++ b/test/RestSharp.Tests.Serializers.Xml/SampleClasses/EnumTest.cs @@ -0,0 +1,35 @@ +namespace RestSharp.Tests.Serializers.Xml.SampleClasses; + +public enum ByteEnum : byte { EnumMin = 0, EnumMax = 255 } + +public enum SByteEnum : sbyte { EnumMin = -128, EnumMax = 127 } + +public enum ShortEnum : short { EnumMin = -32768, EnumMax = 32767 } + +public enum UShortEnum : ushort { EnumMin = 0, EnumMax = 65535 } + +public enum IntEnum { EnumMin = -2147483648, EnumMax = 2147483647 } + +public enum UIntEnum : uint { EnumMin = 0, EnumMax = 4294967295 } + +public enum LongEnum : long { EnumMin = -9223372036854775808, EnumMax = 9223372036854775807 } + +public enum ULongEnum : ulong { EnumMin = 0, EnumMax = 18446744073709551615 } + +public class JsonEnumTypesTestStructure { + public ByteEnum ByteEnumType { get; set; } + + public SByteEnum SByteEnumType { get; set; } + + public ShortEnum ShortEnumType { get; set; } + + public UShortEnum UShortEnumType { get; set; } + + public IntEnum IntEnumType { get; set; } + + public UIntEnum UIntEnumType { get; set; } + + public LongEnum LongEnumType { get; set; } + + public ULongEnum ULongEnumType { get; set; } +} \ No newline at end of file diff --git a/test/RestSharp.Tests.Serializers.Xml/SampleClasses/Goodreads.cs b/test/RestSharp.Tests.Serializers.Xml/SampleClasses/Goodreads.cs new file mode 100644 index 000000000..5a8785b2f --- /dev/null +++ b/test/RestSharp.Tests.Serializers.Xml/SampleClasses/Goodreads.cs @@ -0,0 +1,21 @@ +namespace RestSharp.Tests.Serializers.Xml.SampleClasses; + +public class GoodReadsReviewCollection { + public int Start { get; set; } + + public int End { get; set; } + + public int Total { get; set; } + + public List Reviews { get; set; } +} + +public class GoodReadsReview { + public string Id { get; set; } + + public GoodReadsBook Book { get; set; } +} + +public class GoodReadsBook { + public string Isbn { get; set; } +} \ No newline at end of file diff --git a/test/RestSharp.Tests.Serializers.Xml/SampleClasses/GoogleWeatherWithAttributes.cs b/test/RestSharp.Tests.Serializers.Xml/SampleClasses/GoogleWeatherWithAttributes.cs new file mode 100644 index 000000000..8117871bc --- /dev/null +++ b/test/RestSharp.Tests.Serializers.Xml/SampleClasses/GoogleWeatherWithAttributes.cs @@ -0,0 +1,67 @@ +using RestSharp.Serializers; + +namespace RestSharp.Tests.Serializers.Xml.SampleClasses; + +public class GoogleWeatherApi { + public string Version { get; set; } + + public GoogleWeather Weather { get; set; } +} + +public class GoogleWeather : List { + public string ModuleId { get; set; } + + public string TabId { get; set; } + + public string MobileRow { get; set; } + + public string MobileZipped { get; set; } + + public string Row { get; set; } + + public string Section { get; set; } + + [DeserializeAs(Name = "forecast_information")] + public ForecastInformation Forecast { get; set; } + + [DeserializeAs(Name = "current_conditions")] + public CurrentConditions Current { get; set; } +} + +public class GoogleDataElement { + public string Data { get; set; } +} + +public class ForecastInformation { + public GoogleDataElement City { get; set; } + + public GoogleDataElement PostalCode { get; set; } + + public GoogleDataElement ForecastDate { get; set; } + + public GoogleDataElement UnitSystem { get; set; } +} + +public class CurrentConditions { + public GoogleDataElement Condition { get; set; } + + public GoogleDataElement TempC { get; set; } + + public GoogleDataElement Humidity { get; set; } + + public GoogleDataElement Icon { get; set; } + + public GoogleDataElement WindCondition { get; set; } +} + +public class ForecastConditions { + public GoogleDataElement DayOfWeek { get; set; } + + public GoogleDataElement Condition { get; set; } + + public GoogleDataElement Low { get; set; } + + public GoogleDataElement High { get; set; } + + public GoogleDataElement Icon { get; set; } +} \ No newline at end of file diff --git a/test/RestSharp.Tests.Serializers.Xml/SampleClasses/HeaderAndRows.cs b/test/RestSharp.Tests.Serializers.Xml/SampleClasses/HeaderAndRows.cs new file mode 100644 index 000000000..d0a7369f8 --- /dev/null +++ b/test/RestSharp.Tests.Serializers.Xml/SampleClasses/HeaderAndRows.cs @@ -0,0 +1,17 @@ +using RestSharp.Serializers; + +namespace RestSharp.Tests.Serializers.Xml.SampleClasses; + +public class Header { + public string Title { get; set; } + public string Body { get; set; } + public string Date { get; set; } + + [DeserializeAs(Name = "rows")] + public List Othername { get; set; } +} + +public class Row { + public string Text1 { get; set; } + public string Text2 { get; set; } +} \ No newline at end of file diff --git a/test/RestSharp.Tests.Serializers.Xml/SampleClasses/JsonLists.cs b/test/RestSharp.Tests.Serializers.Xml/SampleClasses/JsonLists.cs new file mode 100644 index 000000000..f94fb130c --- /dev/null +++ b/test/RestSharp.Tests.Serializers.Xml/SampleClasses/JsonLists.cs @@ -0,0 +1,7 @@ +namespace RestSharp.Tests.Serializers.Xml.SampleClasses; + +public class JsonLists { + public List Names { get; set; } + + public List Numbers { get; set; } +} \ No newline at end of file diff --git a/test/RestSharp.Tests.Serializers.Xml/SampleClasses/Lastfm.cs b/test/RestSharp.Tests.Serializers.Xml/SampleClasses/Lastfm.cs new file mode 100644 index 000000000..ac5174c3b --- /dev/null +++ b/test/RestSharp.Tests.Serializers.Xml/SampleClasses/Lastfm.cs @@ -0,0 +1,50 @@ +// ReSharper disable InconsistentNaming +// ReSharper disable UnusedMember.Global +// ReSharper disable UnusedAutoPropertyAccessor.Global +// ReSharper disable ClassNeverInstantiated.Global +#pragma warning disable CS8981 +namespace RestSharp.Tests.Serializers.Xml.SampleClasses; + +public class Event : LastfmBase { + public string id { get; set; } + + public string title { get; set; } + + public EventArtistList artists { get; set; } + + public Venue venue { get; set; } + + public DateTime startDate { get; set; } + + public string description { get; set; } + + public int attendance { get; set; } + + public int reviews { get; set; } + + public string tag { get; set; } + + public string url { get; set; } + + public string headliner { get; set; } + + public int cancelled { get; set; } +} + +public class EventArtistList : List; + +public class artist { + public string Value { get; set; } +} + +public abstract class LastfmBase { + public string status { get; set; } + + public Error error { get; set; } +} + +public class Error { + public string Value { get; set; } + + public int code { get; set; } +} \ No newline at end of file diff --git a/test/RestSharp.Tests.Serializers.Xml/SampleClasses/ListSamples.cs b/test/RestSharp.Tests.Serializers.Xml/SampleClasses/ListSamples.cs new file mode 100644 index 000000000..d8b1491e9 --- /dev/null +++ b/test/RestSharp.Tests.Serializers.Xml/SampleClasses/ListSamples.cs @@ -0,0 +1,41 @@ +// ReSharper disable InconsistentNaming +#pragma warning disable CS8981 +namespace RestSharp.Tests.Serializers.Xml.SampleClasses; + +public class SimpleTypesListSample { + public List Names { get; set; } + + public List Numbers { get; set; } +} + +public class InlineListSample { + public int Count { get; set; } + + public List images { get; set; } + + public List Images { get; set; } +} + +public class NestedListSample { + public List images { get; set; } + + public List Images { get; set; } +} + +public class EmptyListSample { + public List images { get; set; } + + public List Images { get; set; } +} + +public class Image { + public string Src { get; set; } + + public string Value { get; set; } +} + +public class image { + public string Src { get; set; } + + public string Value { get; set; } +} \ No newline at end of file diff --git a/test/RestSharp.Tests.Serializers.Xml/SampleClasses/NestedElementTestClasses.cs b/test/RestSharp.Tests.Serializers.Xml/SampleClasses/NestedElementTestClasses.cs new file mode 100644 index 000000000..d6a512c44 --- /dev/null +++ b/test/RestSharp.Tests.Serializers.Xml/SampleClasses/NestedElementTestClasses.cs @@ -0,0 +1,25 @@ +namespace RestSharp.Tests.Serializers.Xml.SampleClasses; + +// Test classes for nested element bugs + +public class Item { + public int Id { get; set; } + public List SubItems { get; set; } +} + +public class ItemContainer { + public List Items { get; set; } = new(); +} + +public class ItemWithGroup { + public int Id { get; set; } + public ItemGroup Group { get; set; } +} + +public class ItemGroup { + public List Items { get; set; } +} + +public class ItemsResponse { + public List Items { get; set; } = new(); +} diff --git a/test/RestSharp.Tests.Serializers.Xml/SampleClasses/Oddball.cs b/test/RestSharp.Tests.Serializers.Xml/SampleClasses/Oddball.cs new file mode 100644 index 000000000..53eedf2e9 --- /dev/null +++ b/test/RestSharp.Tests.Serializers.Xml/SampleClasses/Oddball.cs @@ -0,0 +1,16 @@ +using RestSharp.Serializers; + +namespace RestSharp.Tests.Serializers.Xml.SampleClasses; + +[DeserializeAs(Name = "oddballRootName")] +public class Oddball { + public string Sid { get; set; } + + public string FriendlyName { get; set; } + + [DeserializeAs(Name = "oddballPropertyName")] + public string GoodPropertyName { get; set; } + + [DeserializeAs(Name = "oddballListName")] + public List ListWithGoodName { get; set; } +} \ No newline at end of file diff --git a/test/RestSharp.Tests.Serializers.Xml/SampleClasses/SOUser.cs b/test/RestSharp.Tests.Serializers.Xml/SampleClasses/SOUser.cs new file mode 100644 index 000000000..807452dae --- /dev/null +++ b/test/RestSharp.Tests.Serializers.Xml/SampleClasses/SOUser.cs @@ -0,0 +1,17 @@ +namespace RestSharp.Tests.Serializers.Xml.SampleClasses; + +public class SoUser { + public int Id { get; set; } + public int Reputation { get; set; } + public long CreationDate { get; set; } + public string DisplayName { get; set; } + public string EmailHash { get; set; } + public string Age { get; set; } + public long LastAccessDate { get; set; } + public string WebsiteUrl { get; set; } + public string Location { get; set; } + public string AboutMe { get; set; } + public int Views { get; set; } + public int UpVotes { get; set; } + public int DownVotes { get; set; } +} \ No newline at end of file diff --git a/test/RestSharp.Tests.Serializers.Xml/SampleClasses/Struct.cs b/test/RestSharp.Tests.Serializers.Xml/SampleClasses/Struct.cs new file mode 100644 index 000000000..7a64ab5b7 --- /dev/null +++ b/test/RestSharp.Tests.Serializers.Xml/SampleClasses/Struct.cs @@ -0,0 +1,7 @@ +namespace RestSharp.Tests.Serializers.Xml.SampleClasses; + +public struct SimpleStruct { + public string One { get; set; } + public string Two { get; set; } + public int Three { get; set; } +} \ No newline at end of file diff --git a/test/RestSharp.Tests.Serializers.Xml/SampleClasses/TwilioCallList.cs b/test/RestSharp.Tests.Serializers.Xml/SampleClasses/TwilioCallList.cs new file mode 100644 index 000000000..127a30836 --- /dev/null +++ b/test/RestSharp.Tests.Serializers.Xml/SampleClasses/TwilioCallList.cs @@ -0,0 +1,11 @@ +namespace RestSharp.Tests.Serializers.Xml.SampleClasses; + +public class TwilioCallList : List { + public int Page { get; set; } + + public int NumPages { get; set; } +} + +public class Call { + public string Sid { get; set; } +} \ No newline at end of file diff --git a/test/RestSharp.Tests.Serializers.Xml/SampleClasses/eventful.cs b/test/RestSharp.Tests.Serializers.Xml/SampleClasses/eventful.cs new file mode 100644 index 000000000..57ab73c52 --- /dev/null +++ b/test/RestSharp.Tests.Serializers.Xml/SampleClasses/eventful.cs @@ -0,0 +1,109 @@ +namespace RestSharp.Tests.Serializers.Xml.SampleClasses; + +public class VenueSearch { + public string total_items { get; set; } + + public string page_size { get; set; } + + public string page_count { get; set; } + + public string page_number { get; set; } + + public string page_items { get; set; } + + public string first_item { get; set; } + + public string last_item { get; set; } + + public string search_time { get; set; } + + public List venues { get; set; } +} + +public class PerformerSearch { + public string total_items { get; set; } + + public string page_size { get; set; } + + public string page_count { get; set; } + + public string page_number { get; set; } + + public string page_items { get; set; } + + public string first_item { get; set; } + + public string last_item { get; set; } + + public string search_time { get; set; } + + public List performers { get; set; } +} + +public class Performer { + public string id { get; set; } + + public string url { get; set; } + + public string name { get; set; } + + public string short_bio { get; set; } + + public DateTime? created { get; set; } + + public string creator { get; set; } + + public string demand_count { get; set; } + + public string demand_member_count { get; set; } + + public string event_count { get; set; } + + public ServiceImage image { get; set; } +} + +public class Venue { + public string id { get; set; } + + public string url { get; set; } + + public string name { get; set; } + + public string venue_name { get; set; } + + public string description { get; set; } + + public string venue_type { get; set; } + + public string address { get; set; } + + public string city_name { get; set; } + + public string region_name { get; set; } + + public string postal_code { get; set; } + + public string country_name { get; set; } + + public string longitude { get; set; } + + public string latitude { get; set; } + + public string event_count { get; set; } +} + +public class ServiceImage { + public ServiceImage1 thumb { get; set; } + + public ServiceImage1 small { get; set; } + + public ServiceImage1 medium { get; set; } +} + +public class ServiceImage1 { + public string url { get; set; } + + public string width { get; set; } + + public string height { get; set; } +} \ No newline at end of file diff --git a/test/RestSharp.Tests.Serializers.Xml/SampleClasses/foursq.cs b/test/RestSharp.Tests.Serializers.Xml/SampleClasses/foursq.cs new file mode 100644 index 000000000..82e8d7439 --- /dev/null +++ b/test/RestSharp.Tests.Serializers.Xml/SampleClasses/foursq.cs @@ -0,0 +1,9 @@ +namespace RestSharp.Tests.Serializers.Xml.SampleClasses; + +public class VenuesResponse { + public List Groups { get; set; } +} + +public class Group { + public string Name { get; set; } +} \ No newline at end of file diff --git a/test/RestSharp.Tests.Serializers.Xml/SampleClasses/googleweather.cs b/test/RestSharp.Tests.Serializers.Xml/SampleClasses/googleweather.cs new file mode 100644 index 000000000..2e6d711cc --- /dev/null +++ b/test/RestSharp.Tests.Serializers.Xml/SampleClasses/googleweather.cs @@ -0,0 +1,65 @@ +namespace RestSharp.Tests.Serializers.Xml.SampleClasses; + +public class xml_api_reply { + public string version { get; set; } + + public Weather weather { get; set; } +} + +public class Weather : List { + public string module_id { get; set; } + + public string tab_id { get; set; } + + public string mobile_row { get; set; } + + public string mobile_zipped { get; set; } + + public string row { get; set; } + + public string section { get; set; } + + public Forecast_information forecast_information { get; set; } + + public Current_conditions current_conditions { get; set; } + + //public T forecast_conditions { get; set; } +} + +public class DataElement { + public string data { get; set; } +} + +public class Forecast_information { + public DataElement city { get; set; } + + public DataElement postal_code { get; set; } + + public DataElement forecast_date { get; set; } + + public DataElement unit_system { get; set; } +} + +public class Current_conditions { + public DataElement condition { get; set; } + + public DataElement temp_c { get; set; } + + public DataElement humidity { get; set; } + + public DataElement icon { get; set; } + + public DataElement wind_condition { get; set; } +} + +public class forecast_conditions { + public DataElement day_of_week { get; set; } + + public DataElement condition { get; set; } + + public DataElement low { get; set; } + + public DataElement high { get; set; } + + public DataElement icon { get; set; } +} \ No newline at end of file diff --git a/test/RestSharp.Tests.Serializers.Xml/SampleClasses/misc.cs b/test/RestSharp.Tests.Serializers.Xml/SampleClasses/misc.cs new file mode 100644 index 000000000..75777b12c --- /dev/null +++ b/test/RestSharp.Tests.Serializers.Xml/SampleClasses/misc.cs @@ -0,0 +1,271 @@ +using RestSharp.Serializers; + +// ReSharper disable UnusedAutoPropertyAccessor.Global +// ReSharper disable ClassNeverInstantiated.Global +// ReSharper disable CollectionNeverUpdated.Global + +namespace RestSharp.Tests.Serializers.Xml.SampleClasses; + +public class PersonForXml { + public string Name { get; set; } + + public DateTime StartDate { get; set; } + + public int Age { get; set; } + + public decimal Percent { get; set; } + + public long BigNumber { get; set; } + + public bool IsCool { get; set; } + + public List Friends { get; set; } + + public Friend BestFriend { get; set; } + + protected string Ignore { get; set; } + + public string IgnoreProxy => Ignore; + + protected string ReadOnly => null; + + public string ReadOnlyProxy => ReadOnly; + + public FoeList Foes { get; set; } + + public Guid UniqueId { get; set; } + + public Guid EmptyGuid { get; set; } + + public Uri Url { get; set; } + + public Uri UrlPath { get; set; } + + public Order Order { get; set; } + + public Disposition Disposition { get; set; } + + public Band FavoriteBand { get; set; } + + public class Band { + public string Name { get; set; } + } +} + +public class ValueCollectionForXml { + public string Value { get; set; } + public List Values { get; set; } +} + +public class ValueForXml { + public DateTime Timestamp { get; set; } + public string Value { get; set; } +} + +public class IncomingInvoice { + public int ConceptId { get; set; } +} + +public class PersonForJson { + public string Name { get; set; } + + public DateTime StartDate { get; set; } + + public int Age { get; set; } + + public decimal Percent { get; set; } + + public long BigNumber { get; set; } + + public bool IsCool { get; set; } + + public List Friends { get; set; } + + public Friend BestFriend { get; set; } + + public Guid Guid { get; set; } + + public Guid EmptyGuid { get; set; } + + public Uri Url { get; set; } + + public Uri UrlPath { get; set; } + + protected string Ignore { get; set; } + + public string IgnoreProxy => Ignore; + + protected string ReadOnly => null; + + public string ReadOnlyProxy => ReadOnly; + + public Dictionary Foes { get; set; } + + public Order Order { get; set; } + + public Disposition Disposition { get; set; } + + public int PersonId { get; set; } +} + +public enum Order { First, Second, Third } + +public enum Disposition { Friendly, SoSo, SteerVeryClear } + +public class Friend { + public string Name { get; set; } + + public int Since { get; set; } +} + +public class Foe { + public string Nickname { get; set; } +} + +public class FoeList : List { + public string Team { get; set; } +} + +public class Birthdate { + public DateTime Value { get; set; } +} + +public class OrderedProperties { + [SerializeAs(Index = 2)] + public string Name { get; set; } + + [SerializeAs(Index = 3)] + public int Age { get; set; } + + [SerializeAs(Index = 1)] + public DateTime StartDate { get; set; } +} + +public class ObjectProperties { + public object ObjectProperty { get; set; } +} + +public class DatabaseCollection : List; + +public class Database { + public string Name { get; set; } + + public string InitialCatalog { get; set; } + + public string DataSource { get; set; } +} + +public class Generic { + public T Data { get; set; } +} + +public class GenericWithList { + public List Items { get; set; } +} + +public class GuidList { + public List Ids { get; set; } +} + +public class DateTimeTestStructure { + public DateTime DateTime { get; set; } + + public DateTime? NullableDateTimeWithNull { get; set; } + + public DateTime? NullableDateTimeWithValue { get; set; } + + public DateTimeOffset DateTimeOffset { get; set; } + + public DateTimeOffset? NullableDateTimeOffsetWithNull { get; set; } + + public DateTimeOffset? NullableDateTimeOffsetWithValue { get; set; } +} + +public class Iso8601DateTimeTestStructure { + public DateTime DateTimeLocal { get; set; } + + public DateTime DateTimeUtc { get; set; } + + public DateTime DateTimeWithOffset { get; set; } +} + +public class NewDateTimeTestStructure { + public DateTime DateTime { get; set; } + + public DateTime DateTimeNegative { get; set; } +} + +public class TimeSpanTestStructure { + public TimeSpan Tick { get; set; } + + public TimeSpan Millisecond { get; set; } + + public TimeSpan Second { get; set; } + + public TimeSpan Minute { get; set; } + + public TimeSpan Hour { get; set; } + + public TimeSpan? NullableWithoutValue { get; set; } + + public TimeSpan? NullableWithValue { get; set; } + + public TimeSpan? IsoSecond { get; set; } + + public TimeSpan? IsoMinute { get; set; } + + public TimeSpan? IsoHour { get; set; } + + public TimeSpan? IsoDay { get; set; } + + public TimeSpan? IsoMonth { get; set; } + + public TimeSpan? IsoYear { get; set; } +} + +public class JsonEnumsTestStructure { + public Disposition Upper { get; set; } + + public Disposition Lower { get; set; } + + public Disposition CamelCased { get; set; } + + public Disposition Underscores { get; set; } + + public Disposition LowerUnderscores { get; set; } + + public Disposition Dashes { get; set; } + + public Disposition LowerDashes { get; set; } + + public Disposition Integer { get; set; } +} + +public class DecimalNumber { + public decimal Value { get; set; } +} + +public class Note { + public const string ConstTitle = "What a note."; + public const string ConstMessage = "Content"; + + [SerializeAs(Attribute = true), DeserializeAs(Attribute = true)] + public int Id { get; set; } + + [SerializeAs(Content = true), DeserializeAs(Content = true)] + public string Message { get; set; } + + public string Title { get; set; } +} + +public class WrongNote { + [SerializeAs(Content = true), DeserializeAs(Content = true)] + public int Id { get; set; } + + [SerializeAs(Content = true), DeserializeAs(Content = true)] + public string Text { get; set; } +} + +public class DateTimeResponse { + public DateTime CreatedOn { get; set; } +} \ No newline at end of file diff --git a/test/RestSharp.Tests.Serializers.Xml/SampleClasses/nullables.cs b/test/RestSharp.Tests.Serializers.Xml/SampleClasses/nullables.cs new file mode 100644 index 000000000..5cfe46a80 --- /dev/null +++ b/test/RestSharp.Tests.Serializers.Xml/SampleClasses/nullables.cs @@ -0,0 +1,9 @@ +namespace RestSharp.Tests.Serializers.Xml.SampleClasses; + +public class NullableValues { + public int? Id { get; set; } + + public DateTime? StartDate { get; set; } + + public Guid? UniqueId { get; set; } +} \ No newline at end of file diff --git a/test/RestSharp.Tests.Serializers.Xml/SampleClasses/twitter.cs b/test/RestSharp.Tests.Serializers.Xml/SampleClasses/twitter.cs new file mode 100644 index 000000000..1afe25fc3 --- /dev/null +++ b/test/RestSharp.Tests.Serializers.Xml/SampleClasses/twitter.cs @@ -0,0 +1,118 @@ +using RestSharp.Serializers; + +// ReSharper disable InconsistentNaming +// ReSharper disable UnusedMember.Global +// ReSharper disable ClassNeverInstantiated.Global +#pragma warning disable CS8981 // The type name only contains lower-cased ascii characters. Such names may become reserved for the language. +#pragma warning disable CS8981 + +namespace RestSharp.Tests.Serializers.Xml.SampleClasses; + +#pragma warning disable CS8981 +public class status { + public bool truncated { get; set; } + + public string created_at { get; set; } + + public string source { get; set; } + + public bool favorited { get; set; } + + public string in_reply_to_user_id { get; set; } + + public string in_reply_to_status_id { get; set; } + + public string in_reply_to_screen_name { get; set; } + + // ignore contributors for now + public user user { get; set; } + + // ignore geo + public long id { get; set; } + + public string text { get; set; } +} + +public class user { + public string url { get; set; } + + public string description { get; set; } + + public string profile_text_color { get; set; } + + public int followers_count { get; set; } + + public int statuses_count { get; set; } + + public bool geo_enabled { get; set; } + + public string profile_background_image_url { get; set; } + + public bool notifications { get; set; } + + public string created_at { get; set; } + + public int friends_count { get; set; } + + public string profile_link_color { get; set; } + + public bool contributors_enabled { get; set; } + + public bool profile_background_tile { get; set; } + + public int favourites_count { get; set; } + + public string profile_background_color { get; set; } + + public string profile_image_url { get; set; } + + public string lang { get; set; } + + public bool verified { get; set; } + + public string profile_sidebar_fill_color { get; set; } + + public bool @protected { get; set; } + + public string screen_name { get; set; } + + public bool following { get; set; } + + public string location { get; set; } + + public string name { get; set; } + + public string time_zone { get; set; } + + public string profile_sidebar_border_color { get; set; } + + public long id { get; set; } + + public int utc_offset { get; set; } +} + +public class complexStatus { + public bool truncated { get; set; } + + public string created_at { get; set; } + + public string source { get; set; } + + public bool favorited { get; set; } + + public string in_reply_to_user_id { get; set; } + + public string in_reply_to_status_id { get; set; } + + public string in_reply_to_screen_name { get; set; } + + // ignore contributors for now + [DeserializeAs(Name = "user.following")] + public bool follow { get; set; } + + // ignore geo + public long id { get; set; } + + public string text { get; set; } +} +#pragma warning restore CS8981 \ No newline at end of file diff --git a/RestSharp.Tests/SampleData/Goodreads.xml b/test/RestSharp.Tests.Serializers.Xml/SampleData/Goodreads.xml similarity index 100% rename from RestSharp.Tests/SampleData/Goodreads.xml rename to test/RestSharp.Tests.Serializers.Xml/SampleData/Goodreads.xml diff --git a/test/RestSharp.Tests.Serializers.Xml/SampleData/GoodreadsFormatError.xml b/test/RestSharp.Tests.Serializers.Xml/SampleData/GoodreadsFormatError.xml new file mode 100644 index 000000000..c65f67bce --- /dev/null +++ b/test/RestSharp.Tests.Serializers.Xml/SampleData/GoodreadsFormatError.xml @@ -0,0 +1,17 @@ + + + + + + 0345475836 + + + + + 1198344567 + + 0802775802 + + + + \ No newline at end of file diff --git a/RestSharp.Tests/SampleData/GoogleWeather.xml b/test/RestSharp.Tests.Serializers.Xml/SampleData/GoogleWeather.xml similarity index 100% rename from RestSharp.Tests/SampleData/GoogleWeather.xml rename to test/RestSharp.Tests.Serializers.Xml/SampleData/GoogleWeather.xml diff --git a/RestSharp.Tests/SampleData/InlineListSample.xml b/test/RestSharp.Tests.Serializers.Xml/SampleData/InlineListSample.xml similarity index 100% rename from RestSharp.Tests/SampleData/InlineListSample.xml rename to test/RestSharp.Tests.Serializers.Xml/SampleData/InlineListSample.xml diff --git a/test/RestSharp.Tests.Serializers.Xml/SampleData/Lastfm.xml b/test/RestSharp.Tests.Serializers.Xml/SampleData/Lastfm.xml new file mode 100644 index 000000000..8611fbd97 --- /dev/null +++ b/test/RestSharp.Tests.Serializers.Xml/SampleData/Lastfm.xml @@ -0,0 +1,46 @@ + + + 328799 + Philip Glass + + Philip Glass + Orchestra and Chorus of Erfurt Theatre + Philip Glass + + + 8777860 + Barbican Centre + + London + United Kingdom + Silk Street + EC2Y 8DS + + 51.520099 + -0.093609 + + + https://www.last.fm/venue/8777860+Barbican+Centre + https://www.barbican.org.uk + + https://userserve-ak.last.fm/serve/34/418510.jpg + https://userserve-ak.last.fm/serve/64/418510.jpg + https://userserve-ak.last.fm/serve/126/418510.jpg + https://userserve-ak.last.fm/serve/252/418510.jpg + https://userserve-ak.last.fm/serve/500/418510/Barbican+Centre.jpg + + Thu, 12 Jun 2008 19:30:00 + + https://userserve-ak.last.fm/serve/34/39466081.png + https://userserve-ak.last.fm/serve/64/39466081.png + https://userserve-ak.last.fm/serve/126/39466081.png + https://userserve-ak.last.fm/serve/252/39466081.png + 48 + 0 + lastfm:event=328799 + https://www.last.fm/event/328799+Philip+Glass+at+Barbican+Centre+on+12+June+2008 + + + 0 + + diff --git a/RestSharp.Tests/SampleData/ListWithAttributes.xml b/test/RestSharp.Tests.Serializers.Xml/SampleData/ListWithAttributes.xml similarity index 100% rename from RestSharp.Tests/SampleData/ListWithAttributes.xml rename to test/RestSharp.Tests.Serializers.Xml/SampleData/ListWithAttributes.xml diff --git a/RestSharp.Tests/SampleData/NestedListSample.xml b/test/RestSharp.Tests.Serializers.Xml/SampleData/NestedListSample.xml similarity index 100% rename from RestSharp.Tests/SampleData/NestedListSample.xml rename to test/RestSharp.Tests.Serializers.Xml/SampleData/NestedListSample.xml diff --git a/RestSharp.Tests/SampleData/boolean_from_number.xml b/test/RestSharp.Tests.Serializers.Xml/SampleData/boolean_from_number.xml similarity index 100% rename from RestSharp.Tests/SampleData/boolean_from_number.xml rename to test/RestSharp.Tests.Serializers.Xml/SampleData/boolean_from_number.xml diff --git a/RestSharp.Tests/SampleData/boolean_from_string.xml b/test/RestSharp.Tests.Serializers.Xml/SampleData/boolean_from_string.xml similarity index 100% rename from RestSharp.Tests/SampleData/boolean_from_string.xml rename to test/RestSharp.Tests.Serializers.Xml/SampleData/boolean_from_string.xml diff --git a/RestSharp.Tests/SampleData/deserialize_as_list.xml b/test/RestSharp.Tests.Serializers.Xml/SampleData/deserialize_as_list.xml similarity index 100% rename from RestSharp.Tests/SampleData/deserialize_as_list.xml rename to test/RestSharp.Tests.Serializers.Xml/SampleData/deserialize_as_list.xml diff --git a/RestSharp.Tests/SampleData/directlists.xml b/test/RestSharp.Tests.Serializers.Xml/SampleData/directlists.xml similarity index 100% rename from RestSharp.Tests/SampleData/directlists.xml rename to test/RestSharp.Tests.Serializers.Xml/SampleData/directlists.xml diff --git a/RestSharp.Tests/SampleData/eventful.xml b/test/RestSharp.Tests.Serializers.Xml/SampleData/eventful.xml similarity index 87% rename from RestSharp.Tests/SampleData/eventful.xml rename to test/RestSharp.Tests.Serializers.Xml/SampleData/eventful.xml index bb8284618..330922ca9 100644 --- a/RestSharp.Tests/SampleData/eventful.xml +++ b/test/RestSharp.Tests.Serializers.Xml/SampleData/eventful.xml @@ -10,7 +10,7 @@ 0.262 - http://eventful.com/venues/tivoli-/V0-001-002011236-6 + https://eventful.com/venues/tivoli-/V0-001-002011236-6 Tivoli Tivoli @@ -36,7 +36,7 @@ - http://eventful.com/brisbane/venues/tivoli-/V0-001-002169294-8 + https://eventful.com/brisbane/venues/tivoli-/V0-001-002169294-8 Tivoli Tivoli <br> <br>(No phone for this venue yet.)<br> <br>(No website for this venue yet.)<br> <br> @@ -62,7 +62,7 @@ - http://eventful.com/brisbane/venues/the-tivoli-/V0-001-000266914-3 + https://eventful.com/brisbane/venues/the-tivoli-/V0-001-000266914-3 The Tivoli The Tivoli Built in 1917 and restored in Art Deco style, this elegant, fully licensed theatre has state-of-the-art technical features, top-of-the-range facilities, in-house catering by our 5 star chef and dedicated staff available to meet all your needs. @@ -86,22 +86,22 @@ 7 1 - http://images.evdb.com/images/small/I0-001/001/414/278-2.jpeg + https://images.evdb.com/images/small/I0-001/001/414/278-2.jpeg 48 48 - http://images.evdb.com/images/thumb/I0-001/001/414/278-2.jpeg + https://images.evdb.com/images/thumb/I0-001/001/414/278-2.jpeg 48 48 - http://images.evdb.com/images/small/I0-001/001/414/278-2.jpeg + https://images.evdb.com/images/small/I0-001/001/414/278-2.jpeg 48 48 - http://images.evdb.com/images/medium/I0-001/001/414/278-2.jpeg + https://images.evdb.com/images/medium/I0-001/001/414/278-2.jpeg 128 128 diff --git a/test/RestSharp.Tests.Serializers.Xml/SampleData/header_and_rows.xml b/test/RestSharp.Tests.Serializers.Xml/SampleData/header_and_rows.xml new file mode 100644 index 000000000..61c983106 --- /dev/null +++ b/test/RestSharp.Tests.Serializers.Xml/SampleData/header_and_rows.xml @@ -0,0 +1,20 @@ + + + +
+ text title + text body + 2014-12-12 +
+ + + first row text 1 sample + first row text 2 sample + + + second row text 1 sample + second row text 2 sample + + + + \ No newline at end of file diff --git a/RestSharp.Tests/SampleData/restsharp.nuspec b/test/RestSharp.Tests.Serializers.Xml/SampleData/restsharp.nuspec similarity index 100% rename from RestSharp.Tests/SampleData/restsharp.nuspec rename to test/RestSharp.Tests.Serializers.Xml/SampleData/restsharp.nuspec diff --git a/RestSharp.Tests/SampleData/xmllists.xml b/test/RestSharp.Tests.Serializers.Xml/SampleData/xmllists.xml similarity index 100% rename from RestSharp.Tests/SampleData/xmllists.xml rename to test/RestSharp.Tests.Serializers.Xml/SampleData/xmllists.xml diff --git a/test/RestSharp.Tests.Serializers.Xml/XmlAttributeDeserializerTests.cs b/test/RestSharp.Tests.Serializers.Xml/XmlAttributeDeserializerTests.cs new file mode 100644 index 000000000..74dcf041a --- /dev/null +++ b/test/RestSharp.Tests.Serializers.Xml/XmlAttributeDeserializerTests.cs @@ -0,0 +1,876 @@ +using System.Globalization; +using System.Xml.Linq; +using RestSharp.Serializers.Xml; +using RestSharp.Tests.Serializers.Xml.SampleClasses; + +namespace RestSharp.Tests.Serializers.Xml; + +public class XmlAttributeDeserializerTests { + const string GuidString = "AC1FC4BC-087A-4242-B8EE-C53EBE9887A5"; + +#if NET + readonly string _sampleDataPath = Path.Combine(AppDomain.CurrentDomain.BaseDirectory, "SampleData"); +#else + readonly string _sampleDataPath = Path.Combine(Directory.GetCurrentDirectory(), "SampleData"); +#endif + + string PathFor(string sampleFile) => Path.Combine(_sampleDataPath, sampleFile); + + [Fact] + public void Can_Deserialize_Lists_of_Simple_Types() { + var xmlPath = PathFor("xmllists.xml"); + var doc = XDocument.Load(xmlPath); + var xml = new XmlAttributeDeserializer(); + + var output = xml.Deserialize(new() { Content = doc.ToString() })!; + + Assert.NotEmpty(output.Numbers); + Assert.NotEqual(0, output.Names[0].Length); + Assert.NotEqual(0, output.Numbers.Sum()); + } + + [Fact] + public void Can_Deserialize_To_List_Inheritor_From_Custom_Root_With_Attributes() { + var xmlPath = PathFor("ListWithAttributes.xml"); + var doc = XDocument.Load(xmlPath); + var xml = new XmlAttributeDeserializer { RootElement = "Calls" }; + var output = xml.Deserialize(new() { Content = doc.ToString() })!; + + Assert.Equal(3, output.NumPages); + Assert.Equal(2, output.Count); + } + + [Fact] + public void Can_Deserialize_To_Standalone_List_Without_Matching_Class_Case() { + var xmlPath = PathFor("InlineListSample.xml"); + var doc = XDocument.Load(xmlPath); + var xml = new XmlAttributeDeserializer(); + var output = xml.Deserialize>(new() { Content = doc.ToString() })!; + + Assert.Equal(4, output.Count); + } + + [Fact] + public void Can_Deserialize_To_Standalone_List_With_Matching_Class_Case() { + var xmlPath = PathFor("InlineListSample.xml"); + var doc = XDocument.Load(xmlPath); + var xml = new XmlAttributeDeserializer(); + var output = xml.Deserialize>(new() { Content = doc.ToString() })!; + + Assert.Equal(4, output.Count); + } + + [Fact] + public void Can_Deserialize_Directly_To_Lists_Off_Root_Element() { + var xmlPath = PathFor("directlists.xml"); + var doc = XDocument.Load(xmlPath); + var xml = new XmlAttributeDeserializer(); + var output = xml.Deserialize>(new() { Content = doc.ToString() })!; + + Assert.Equal(2, output.Count); + } + + [Fact] + public void Can_Deserialize_Parentless_aka_Inline_List_Items_Without_Matching_Class_Name() { + var xmlPath = PathFor("InlineListSample.xml"); + var doc = XDocument.Load(xmlPath); + var xml = new XmlAttributeDeserializer(); + var output = xml.Deserialize(new() { Content = doc.ToString() })!; + + Assert.Equal(4, output.Images.Count); + } + + [Fact] + public void Can_Deserialize_Parentless_aka_Inline_List_Items_With_Matching_Class_Name() { + var xmlpath = PathFor("InlineListSample.xml"); + var doc = XDocument.Load(xmlpath); + var xml = new XmlAttributeDeserializer(); + var output = xml.Deserialize(new() { Content = doc.ToString() })!; + + Assert.Equal(4, output.images.Count); + } + + [Fact] + public void Can_Deserialize_Parentless_aka_Inline_List_Items_With_Matching_Class_Name_With_Additional_Property() { + var xmlpath = PathFor("InlineListSample.xml"); + var doc = XDocument.Load(xmlpath); + var xml = new XmlAttributeDeserializer(); + var output = xml.Deserialize(new() { Content = doc.ToString() })!; + + Assert.Equal(4, output.Count); + } + + [Fact] + public void Can_Deserialize_Nested_List_Items_Without_Matching_Class_Name() { + var xmlpath = PathFor("NestedListSample.xml"); + var doc = XDocument.Load(xmlpath); + var xml = new XmlAttributeDeserializer(); + var output = xml.Deserialize(new() { Content = doc.ToString() })!; + + Assert.Equal(4, output.Images.Count); + } + + [Fact] + public void Can_Deserialize_Nested_List_Items_With_Matching_Class_Name() { + var xmlpath = PathFor("NestedListSample.xml"); + var doc = XDocument.Load(xmlpath); + var xml = new XmlAttributeDeserializer(); + var output = xml.Deserialize(new() { Content = doc.ToString() })!; + + Assert.Equal(4, output.images.Count); + } + + [Fact] + public void Can_Deserialize_Nested_List_Without_Elements_To_Empty_List() { + var doc = CreateXmlWithEmptyNestedList(); + var xml = new XmlAttributeDeserializer(); + var output = xml.Deserialize(new() { Content = doc })!; + + Assert.NotNull(output.Images); + Assert.Empty(output.Images); + } + + [Fact] + public void Can_Deserialize_Inline_List_Without_Elements_To_Empty_List() { + var doc = CreateXmlWithEmptyInlineList(); + var xml = new XmlAttributeDeserializer(); + var output = xml.Deserialize(new() { Content = doc })!; + + Assert.NotNull(output.Images); + Assert.Empty(output.Images); + } + + [Fact] + public void Can_Deserialize_Empty_Elements_to_Nullable_Values() { + var doc = CreateXmlWithNullValues(); + var xml = new XmlAttributeDeserializer(); + var output = xml.Deserialize(new() { Content = doc })!; + + Assert.Null(output.Id); + Assert.Null(output.StartDate); + Assert.Null(output.UniqueId); + } + + [Fact] + public void Can_Deserialize_Elements_to_Nullable_Values() { + var culture = CultureInfo.InvariantCulture; + var doc = CreateXmlWithoutEmptyValues(culture); + + var xml = new XmlAttributeDeserializer { Culture = culture }; + var output = xml.Deserialize(new() { Content = doc })!; + + Assert.NotNull(output.Id); + Assert.NotNull(output.StartDate); + Assert.NotNull(output.UniqueId); + Assert.Equal(123, output.Id); + Assert.Equal(new DateTime(2010, 2, 21, 9, 35, 00), output.StartDate); + Assert.Equal(new Guid(GuidString), output.UniqueId); + } + + [Fact] + public void Can_Deserialize_TimeSpan() { + var culture = CultureInfo.InvariantCulture; + var doc = new XDocument(culture); + + TimeSpan? nullTimespan = null; + TimeSpan? nullValueTimeSpan = new TimeSpan(21, 30, 7); + + var root = new XElement("Person"); + + root.Add(new XElement("Tick", new TimeSpan(468006))); + root.Add(new XElement("Millisecond", new TimeSpan(0, 0, 0, 0, 125))); + root.Add(new XElement("Second", new TimeSpan(0, 0, 8))); + root.Add(new XElement("Minute", new TimeSpan(0, 55, 2))); + root.Add(new XElement("Hour", new TimeSpan(21, 30, 7))); + root.Add(new XElement("NullableWithoutValue", nullTimespan)); + root.Add(new XElement("NullableWithValue", nullValueTimeSpan)); + + doc.Add(root); + + var response = new RestResponse { Content = doc.ToString() }; + var d = new XmlAttributeDeserializer { Culture = culture }; + var payload = d.Deserialize(response)!; + + Assert.Equal(new(468006), payload.Tick); + Assert.Equal(new(0, 0, 0, 0, 125), payload.Millisecond); + Assert.Equal(new(0, 0, 8), payload.Second); + Assert.Equal(new(0, 55, 2), payload.Minute); + Assert.Equal(new(21, 30, 7), payload.Hour); + Assert.Null(payload.NullableWithoutValue); + Assert.NotNull(payload.NullableWithValue); + Assert.Equal(new(21, 30, 7), payload.NullableWithValue.Value); + } + + [Fact] + public void Can_Deserialize_Custom_Formatted_Date() { + const string format = "dd yyyy MMM, hh:mm ss tt zzz"; + + var culture = CultureInfo.InvariantCulture; + var date = new DateTime(2010, 2, 8, 11, 11, 11); + var doc = new XDocument(); + var root = new XElement("Person"); + + root.Add(new XElement("StartDate", date.ToString(format, culture))); + + doc.Add(root); + + var xml = new XmlAttributeDeserializer { + DateFormat = format, + Culture = culture + }; + var response = new RestResponse { Content = doc.ToString() }; + var output = xml.Deserialize(response)!; + + Assert.Equal(date, output.StartDate); + } + + [Fact] + public void Can_Deserialize_Nested_Class() { + var doc = CreateElementsXml(); + var response = new RestResponse { Content = doc }; + var d = new XmlAttributeDeserializer(); + var p = d.Deserialize(response); + + Assert.NotNull(p.FavoriteBand); + Assert.Equal("Goldfinger", p.FavoriteBand.Name); + } + + [Fact] + public void Can_Deserialize_Elements_On_Default_Root() { + var doc = CreateElementsXml(); + var response = new RestResponse { Content = doc }; + var d = new XmlAttributeDeserializer(); + var p = d.Deserialize(response); + + Assert.Equal("John Sheehan", p.Name); + Assert.Equal(new(2009, 9, 25, 0, 6, 1), p.StartDate); + Assert.Equal(28, p.Age); + Assert.Equal(long.MaxValue, p.BigNumber); + Assert.Equal(99.9999m, p.Percent); + Assert.False(p.IsCool); + Assert.Equal(new(GuidString), p.UniqueId); + Assert.Equal(Guid.Empty, p.EmptyGuid); + Assert.Equal(new("http://example.com", UriKind.RelativeOrAbsolute), p.Url); + Assert.Equal(new("/foo/bar", UriKind.RelativeOrAbsolute), p.UrlPath); + Assert.Equal(Order.Third, p.Order); + Assert.Equal(Disposition.SoSo, p.Disposition); + Assert.NotNull(p.Friends); + Assert.Equal(10, p.Friends.Count); + Assert.NotNull(p.BestFriend); + Assert.Equal("The Fonz", p.BestFriend.Name); + Assert.Equal(1952, p.BestFriend.Since); + } + + [Fact] + public void Can_Deserialize_Attributes_On_Default_Root() { + var doc = CreateAttributesXml(); + var response = new RestResponse { Content = doc }; + var d = new XmlAttributeDeserializer(); + var p = d.Deserialize(response); + + Assert.Equal("John Sheehan", p.Name); + Assert.Equal(new (2009, 9, 25, 0, 6, 1), p.StartDate); + Assert.Equal(28, p.Age); + Assert.Equal(long.MaxValue, p.BigNumber); + Assert.Equal(99.9999m, p.Percent); + Assert.False(p.IsCool); + Assert.Equal(new (GuidString), p.UniqueId); + Assert.Equal(new ("http://example.com", UriKind.RelativeOrAbsolute), p.Url); + Assert.Equal(new ("/foo/bar", UriKind.RelativeOrAbsolute), p.UrlPath); + Assert.NotNull(p.BestFriend); + Assert.Equal("The Fonz", p.BestFriend.Name); + Assert.Equal(1952, p.BestFriend.Since); + } + + [Fact] + public void Ignore_Protected_Property_That_Exists_In_Data() { + var doc = CreateElementsXml(); + var response = new RestResponse { Content = doc }; + var d = new XmlAttributeDeserializer(); + var p = d.Deserialize(response); + + Assert.Null(p.IgnoreProxy); + } + + [Fact] + public void Ignore_ReadOnly_Property_That_Exists_In_Data() { + var doc = CreateElementsXml(); + var response = new RestResponse { Content = doc }; + var d = new XmlAttributeDeserializer(); + var p = d.Deserialize(response); + + Assert.Null(p.ReadOnlyProxy); + } + + [Fact] + public void Can_Deserialize_Names_With_Underscores_On_Default_Root() { + var doc = CreateUnderscoresXml(); + var response = new RestResponse { Content = doc }; + var d = new XmlAttributeDeserializer(); + var p = d.Deserialize(response); + + Assert.Equal("John Sheehan", p.Name); + Assert.Equal(new (2009, 9, 25, 0, 6, 1), p.StartDate); + Assert.Equal(28, p.Age); + Assert.Equal(long.MaxValue, p.BigNumber); + Assert.Equal(99.9999m, p.Percent); + Assert.False(p.IsCool); + Assert.Equal(new (GuidString), p.UniqueId); + Assert.Equal(new ("http://example.com", UriKind.RelativeOrAbsolute), p.Url); + Assert.Equal(new ("/foo/bar", UriKind.RelativeOrAbsolute), p.UrlPath); + Assert.NotNull(p.Friends); + Assert.Equal(10, p.Friends.Count); + Assert.NotNull(p.BestFriend); + Assert.Equal("The Fonz", p.BestFriend.Name); + Assert.Equal(1952, p.BestFriend.Since); + Assert.NotNull(p.Foes); + Assert.Equal(5, p.Foes.Count); + Assert.Equal("Yankees", p.Foes.Team); + } + + [Fact] + public void Can_Deserialize_Names_With_Dashes_On_Default_Root() { + var doc = CreateDashesXml(); + var response = new RestResponse { Content = doc }; + var d = new XmlAttributeDeserializer(); + var p = d.Deserialize(response); + + Assert.Equal("John Sheehan", p.Name); + Assert.Equal(new (2009, 9, 25, 0, 6, 1), p.StartDate); + Assert.Equal(28, p.Age); + Assert.Equal(long.MaxValue, p.BigNumber); + Assert.Equal(99.9999m, p.Percent); + Assert.False(p.IsCool); + Assert.Equal(new (GuidString), p.UniqueId); + Assert.Equal(new ("http://example.com", UriKind.RelativeOrAbsolute), p.Url); + Assert.Equal(new ("/foo/bar", UriKind.RelativeOrAbsolute), p.UrlPath); + Assert.NotNull(p.Friends); + Assert.Equal(10, p.Friends.Count); + Assert.NotNull(p.BestFriend); + Assert.Equal("The Fonz", p.BestFriend.Name); + Assert.Equal(1952, p.BestFriend.Since); + Assert.NotNull(p.Foes); + Assert.Equal(5, p.Foes.Count); + Assert.Equal("Yankees", p.Foes.Team); + } + + [Fact] + public void Can_Deserialize_Names_With_Underscores_Without_Matching_Case_On_Default_Root() { + var doc = CreateLowercaseUnderscoresXml(); + var response = new RestResponse { Content = doc }; + var d = new XmlAttributeDeserializer(); + var p = d.Deserialize(response); + + Assert.Equal("John Sheehan", p.Name); + Assert.Equal(new (2009, 9, 25, 0, 6, 1), p.StartDate); + Assert.Equal(28, p.Age); + Assert.Equal(long.MaxValue, p.BigNumber); + Assert.Equal(99.9999m, p.Percent); + Assert.False(p.IsCool); + Assert.Equal(new (GuidString), p.UniqueId); + Assert.Equal(new ("http://example.com", UriKind.RelativeOrAbsolute), p.Url); + Assert.Equal(new ("/foo/bar", UriKind.RelativeOrAbsolute), p.UrlPath); + Assert.NotNull(p.Friends); + Assert.Equal(10, p.Friends.Count); + Assert.NotNull(p.BestFriend); + Assert.Equal("The Fonz", p.BestFriend.Name); + Assert.Equal(1952, p.BestFriend.Since); + Assert.NotNull(p.Foes); + Assert.Equal(5, p.Foes.Count); + Assert.Equal("Yankees", p.Foes.Team); + } + + [Fact] + public void Can_Deserialize_Lower_Cased_Root_Elements_With_Dashes() { + var doc = CreateDashesXml(); + var response = new RestResponse { Content = doc }; + var d = new XmlAttributeDeserializer(); + var p = d.Deserialize(response); + + Assert.Equal("John Sheehan", p.Name); + Assert.Equal(new (2009, 9, 25, 0, 6, 1), p.StartDate); + Assert.Equal(28, p.Age); + Assert.Equal(long.MaxValue, p.BigNumber); + Assert.Equal(99.9999m, p.Percent); + Assert.False(p.IsCool); + Assert.Equal(new (GuidString), p.UniqueId); + Assert.Equal(new ("http://example.com", UriKind.RelativeOrAbsolute), p.Url); + Assert.Equal(new ("/foo/bar", UriKind.RelativeOrAbsolute), p.UrlPath); + Assert.NotNull(p.Friends); + Assert.Equal(10, p.Friends.Count); + Assert.NotNull(p.BestFriend); + Assert.Equal("The Fonz", p.BestFriend.Name); + Assert.Equal(1952, p.BestFriend.Since); + Assert.NotNull(p.Foes); + Assert.Equal(5, p.Foes.Count); + Assert.Equal("Yankees", p.Foes.Team); + } + + [Fact] + public void Can_Deserialize_Root_Elements_Without_Matching_Case_And_Dashes() { + var doc = CreateLowerCasedRootElementWithDashesXml(); + var response = new RestResponse { Content = doc }; + var d = new XmlAttributeDeserializer(); + var p = d.Deserialize>(response); + + Assert.NotNull(p); + Assert.Single(p); + Assert.Equal(45, p[0].ConceptId); + } + + [Fact] + public void Can_Deserialize_Eventful_Xml() { + var xmlFilePath = PathFor("eventful.xml"); + var doc = XDocument.Load(xmlFilePath); + var response = new RestResponse { Content = doc.ToString() }; + var d = new XmlAttributeDeserializer(); + var output = d.Deserialize(response)!; + + Assert.Equal(3, output.venues.Count); + Assert.Equal("Tivoli", output.venues[0].name); + Assert.Equal("https://eventful.com/brisbane/venues/tivoli-/V0-001-002169294-8", output.venues[1].url); + Assert.Equal("V0-001-000266914-3", output.venues[2].id); + } + + [Fact] + public void Can_Deserialize_Lastfm_Xml() { + var xmlFilePath = PathFor("Lastfm.xml"); + var doc = XDocument.Load(xmlFilePath); + var response = new RestResponse { Content = doc.ToString() }; + var d = new XmlAttributeDeserializer(); + var output = d.Deserialize(response)!; + + Assert.Equal("https://www.last.fm/event/328799+Philip+Glass+at+Barbican+Centre+on+12+June+2008", output.url); + Assert.Equal("https://www.last.fm/venue/8777860+Barbican+Centre", output.venue.url); + } + + [Fact] + public void Can_Deserialize_Google_Weather_Xml() { + var xmlFilePath = PathFor("GoogleWeather.xml"); + var doc = XDocument.Load(xmlFilePath); + var response = new RestResponse { Content = doc.ToString() }; + var d = new XmlAttributeDeserializer(); + var output = d.Deserialize(response)!; + + Assert.Equal(4, output.weather.Count); + Assert.Equal("Sunny", output.weather[0].condition.data); + } + + [Fact] + public void Can_Deserialize_Google_Weather_Xml_WithDeserializeAs() { + var xmlFilePath = PathFor("GoogleWeather.xml"); + var doc = XDocument.Load(xmlFilePath); + var response = new RestResponse { Content = doc.ToString() }; + var d = new XmlAttributeDeserializer(); + var output = d.Deserialize(response)!; + + Assert.Equal(4, output.Weather.Count); + Assert.Equal("Sunny", output.Weather[0].Condition.Data); + } + + [Fact] + public void Can_Deserialize_Boolean_From_Number() { + var xmlFilePath = PathFor("boolean_from_number.xml"); + var doc = XDocument.Load(xmlFilePath); + var response = new RestResponse { Content = doc.ToString() }; + var d = new XmlAttributeDeserializer(); + var output = d.Deserialize(response)!; + + Assert.True(output.Value); + } + + [Fact] + public void Can_Deserialize_Boolean_From_String() { + var xmlFilePath = PathFor("boolean_from_string.xml"); + var doc = XDocument.Load(xmlFilePath); + var response = new RestResponse { Content = doc.ToString() }; + var d = new XmlAttributeDeserializer(); + var output = d.Deserialize(response)!; + + Assert.True(output.Value); + } + + [Fact] + public void Can_Deserialize_Empty_Elements_With_Attributes_to_Nullable_Values() { + var doc = CreateXmlWithAttributesAndNullValues(); + var xml = new XmlAttributeDeserializer(); + var output = xml.Deserialize(new() { Content = doc })!; + + Assert.Null(output.Id); + Assert.Null(output.StartDate); + Assert.Null(output.UniqueId); + } + + [Fact] + public void Can_Deserialize_Mixture_Of_Empty_Elements_With_Attributes_And_Populated_Elements() { + var doc = CreateXmlWithAttributesAndNullValuesAndPopulatedValues(); + var xml = new XmlAttributeDeserializer(); + var output = xml.Deserialize(new RestResponse { Content = doc })!; + + Assert.Null(output.Id); + Assert.Null(output.StartDate); + Assert.Equal(new Guid(GuidString), output.UniqueId); + } + + [Fact] + public void Can_Deserialize_DateTimeOffset() { + var culture = CultureInfo.InvariantCulture; + var doc = new XDocument(culture); + + var dateTimeOffset = new DateTimeOffset(2013, 02, 08, 9, 18, 22, TimeSpan.FromHours(10)); + + DateTimeOffset? nullableDateTimeOffsetWithValue = + new DateTimeOffset(2013, 02, 08, 9, 18, 23, TimeSpan.FromHours(10)); + + var root = new XElement("Dates"); + + root.Add(new XElement("DateTimeOffset", dateTimeOffset)); + root.Add(new XElement("NullableDateTimeOffsetWithNull", string.Empty)); + root.Add(new XElement("NullableDateTimeOffsetWithValue", nullableDateTimeOffsetWithValue)); + + doc.Add(root); + + //var xml = new XmlAttributeDeserializer { Culture = culture }; + var response = new RestResponse { Content = doc.ToString() }; + var d = new XmlAttributeDeserializer { Culture = culture }; + var payload = d.Deserialize(response)!; + + Assert.Equal(dateTimeOffset, payload.DateTimeOffset); + Assert.Null(payload.NullableDateTimeOffsetWithNull); + Assert.True(payload.NullableDateTimeOffsetWithValue.HasValue); + Assert.Equal(nullableDateTimeOffsetWithValue, payload.NullableDateTimeOffsetWithValue); + } + + static string CreateUnderscoresXml() { + var doc = new XDocument(); + var root = new XElement("Person"); + + root.Add(new XElement("Name", "John Sheehan")); + root.Add(new XElement("Start_Date", new DateTime(2009, 9, 25, 0, 6, 1))); + root.Add(new XAttribute("Age", 28)); + root.Add(new XElement("Percent", 99.9999m)); + root.Add(new XElement("Big_Number", long.MaxValue)); + root.Add(new XAttribute("Is_Cool", false)); + root.Add(new XElement("Ignore", "dummy")); + root.Add(new XAttribute("Read_Only", "dummy")); + root.Add(new XElement("Unique_Id", new Guid(GuidString))); + root.Add(new XElement("Url", "http://example.com")); + root.Add(new XElement("Url_Path", "/foo/bar")); + + root.Add( + new XElement( + "Best_Friend", + new XElement("Name", "The Fonz"), + new XAttribute("Since", 1952) + ) + ); + + var friends = new XElement("Friends"); + + for (var i = 0; i < 10; i++) { + friends.Add( + new XElement( + "Friend", + new XElement("Name", "Friend" + i), + new XAttribute("Since", DateTime.Now.Year - i) + ) + ); + } + + root.Add(friends); + + var foes = new XElement("Foes"); + + foes.Add(new XAttribute("Team", "Yankees")); + + for (var i = 0; i < 5; i++) foes.Add(new XElement("Foe", new XElement("Nickname", "Foe" + i))); + + root.Add(foes); + doc.Add(root); + + return doc.ToString(); + } + + static string CreateLowercaseUnderscoresXml() { + var doc = new XDocument(); + var root = new XElement("Person"); + + root.Add(new XElement("Name", "John Sheehan")); + root.Add(new XElement("start_date", new DateTime(2009, 9, 25, 0, 6, 1))); + root.Add(new XAttribute("Age", 28)); + root.Add(new XElement("Percent", 99.9999m)); + root.Add(new XElement("big_number", long.MaxValue)); + root.Add(new XAttribute("is_cool", false)); + root.Add(new XElement("Ignore", "dummy")); + root.Add(new XAttribute("read_only", "dummy")); + root.Add(new XElement("unique_id", new Guid(GuidString))); + root.Add(new XElement("Url", "http://example.com")); + root.Add(new XElement("url_path", "/foo/bar")); + + root.Add( + new XElement( + "best_friend", + new XElement("name", "The Fonz"), + new XAttribute("Since", 1952) + ) + ); + + var friends = new XElement("Friends"); + + for (var i = 0; i < 10; i++) { + friends.Add( + new XElement( + "Friend", + new XElement("Name", "Friend" + i), + new XAttribute("Since", DateTime.Now.Year - i) + ) + ); + } + + root.Add(friends); + + var foes = new XElement("Foes"); + + foes.Add(new XAttribute("Team", "Yankees")); + + for (var i = 0; i < 5; i++) foes.Add(new XElement("Foe", new XElement("Nickname", "Foe" + i))); + + root.Add(foes); + doc.Add(root); + + return doc.ToString(); + } + + static string CreateDashesXml() { + var doc = new XDocument(); + var root = new XElement("Person"); + + root.Add(new XElement("Name", "John Sheehan")); + root.Add(new XElement("Start_Date", new DateTime(2009, 9, 25, 0, 6, 1))); + root.Add(new XAttribute("Age", 28)); + root.Add(new XElement("Percent", 99.9999m)); + root.Add(new XElement("Big-Number", long.MaxValue)); + root.Add(new XAttribute("Is-Cool", false)); + root.Add(new XElement("Ignore", "dummy")); + root.Add(new XAttribute("Read-Only", "dummy")); + root.Add(new XElement("Unique-Id", new Guid(GuidString))); + root.Add(new XElement("Url", "http://example.com")); + root.Add(new XElement("Url-Path", "/foo/bar")); + + root.Add( + new XElement( + "Best-Friend", + new XElement("Name", "The Fonz"), + new XAttribute("Since", 1952) + ) + ); + + var friends = new XElement("Friends"); + + for (var i = 0; i < 10; i++) { + friends.Add( + new XElement( + "Friend", + new XElement("Name", "Friend" + i), + new XAttribute("Since", DateTime.Now.Year - i) + ) + ); + } + + root.Add(friends); + + var foes = new XElement("Foes"); + + foes.Add(new XAttribute("Team", "Yankees")); + + for (var i = 0; i < 5; i++) foes.Add(new XElement("Foe", new XElement("Nickname", "Foe" + i))); + + root.Add(foes); + doc.Add(root); + + return doc.ToString(); + } + + static string CreateLowerCasedRootElementWithDashesXml() { + var doc = new XDocument(); + + var root = new XElement( + "incoming-invoices", + new XElement( + "incoming-invoice", + new XElement("concept-id", 45) + ) + ); + + doc.Add(root); + + return doc.ToString(); + } + + static string CreateElementsXml() { + var doc = new XDocument(); + var root = new XElement("Person"); + + root.Add(new XElement("Name", "John Sheehan")); + root.Add(new XElement("StartDate", new DateTime(2009, 9, 25, 0, 6, 1))); + root.Add(new XElement("Age", 28)); + root.Add(new XElement("Percent", 99.9999m)); + root.Add(new XElement("BigNumber", long.MaxValue)); + root.Add(new XElement("IsCool", false)); + root.Add(new XElement("Ignore", "dummy")); + root.Add(new XElement("ReadOnly", "dummy")); + root.Add(new XElement("UniqueId", new Guid(GuidString))); + root.Add(new XElement("EmptyGuid", "")); + root.Add(new XElement("Url", "http://example.com")); + root.Add(new XElement("UrlPath", "/foo/bar")); + root.Add(new XElement("Order", "third")); + root.Add(new XElement("Disposition", "so-so")); + + root.Add( + new XElement( + "BestFriend", + new XElement("Name", "The Fonz"), + new XElement("Since", 1952) + ) + ); + + var friends = new XElement("Friends"); + + for (var i = 0; i < 10; i++) { + friends.Add( + new XElement( + "Friend", + new XElement("Name", "Friend" + i), + new XElement("Since", DateTime.Now.Year - i) + ) + ); + } + + root.Add(friends); + + root.Add( + new XElement( + "FavoriteBand", + new XElement("Name", "Goldfinger") + ) + ); + + doc.Add(root); + + return doc.ToString(); + } + + static string CreateAttributesXml() { + var doc = new XDocument(); + var root = new XElement("Person"); + + root.Add(new XAttribute("Name", "John Sheehan")); + root.Add(new XAttribute("StartDate", new DateTime(2009, 9, 25, 0, 6, 1))); + root.Add(new XAttribute("Age", 28)); + root.Add(new XAttribute("Percent", 99.9999m)); + root.Add(new XAttribute("BigNumber", long.MaxValue)); + root.Add(new XAttribute("IsCool", false)); + root.Add(new XAttribute("Ignore", "dummy")); + root.Add(new XAttribute("ReadOnly", "dummy")); + root.Add(new XAttribute("UniqueId", new Guid(GuidString))); + root.Add(new XAttribute("Url", "http://example.com")); + root.Add(new XAttribute("UrlPath", "/foo/bar")); + + root.Add( + new XElement( + "BestFriend", + new XAttribute("Name", "The Fonz"), + new XAttribute("Since", 1952) + ) + ); + + doc.Add(root); + + return doc.ToString(); + } + + static string CreateXmlWithNullValues() { + var doc = new XDocument(); + var root = new XElement("NullableValues"); + + root.Add( + new XElement("Id", null), + new XElement("StartDate", null), + new XElement("UniqueId", null) + ); + + doc.Add(root); + + return doc.ToString(); + } + + static string CreateXmlWithoutEmptyValues(CultureInfo culture) { + var doc = new XDocument(); + var root = new XElement("NullableValues"); + + root.Add( + new XElement("Id", 123), + new XElement("StartDate", new DateTime(2010, 2, 21, 9, 35, 00).ToString(culture)), + new XElement("UniqueId", new Guid(GuidString)) + ); + + doc.Add(root); + + return doc.ToString(); + } + + static string CreateXmlWithEmptyNestedList() { + var doc = new XDocument(); + var root = new XElement("EmptyListSample"); + + root.Add(new XElement("Images")); + doc.Add(root); + + return doc.ToString(); + } + + static string CreateXmlWithEmptyInlineList() { + var doc = new XDocument(); + var root = new XElement("EmptyListSample"); + + doc.Add(root); + + return doc.ToString(); + } + + static string CreateXmlWithAttributesAndNullValues() { + var doc = new XDocument(); + var root = new XElement("NullableValues"); + var idElement = new XElement("Id", null); + + idElement.SetAttributeValue("SomeAttribute", "SomeAttribute_Value"); + + root.Add( + idElement, + new XElement("StartDate", null), + new XElement("UniqueId", null) + ); + + doc.Add(root); + + return doc.ToString(); + } + + static string CreateXmlWithAttributesAndNullValuesAndPopulatedValues() { + var doc = new XDocument(); + var root = new XElement("NullableValues"); + var idElement = new XElement("Id", null); + + idElement.SetAttributeValue("SomeAttribute", "SomeAttribute_Value"); + + root.Add( + idElement, + new XElement("StartDate", null), + new XElement("UniqueId", new Guid(GuidString)) + ); + + doc.Add(root); + + return doc.ToString(); + } +} \ No newline at end of file diff --git a/test/RestSharp.Tests.Serializers.Xml/XmlDeserializerTests.cs b/test/RestSharp.Tests.Serializers.Xml/XmlDeserializerTests.cs new file mode 100644 index 000000000..1c3454356 --- /dev/null +++ b/test/RestSharp.Tests.Serializers.Xml/XmlDeserializerTests.cs @@ -0,0 +1,1243 @@ +using System.Globalization; +using System.Xml.Linq; +using RestSharp.Serializers.Xml; +using RestSharp.Tests.Serializers.Xml.SampleClasses; +using RestSharp.Tests.Serializers.Xml.SampleClasses.DeserializeAsTest; + +namespace RestSharp.Tests.Serializers.Xml; + +public class XmlDeserializerTests { + const string GuidString = "AC1FC4BC-087A-4242-B8EE-C53EBE9887A5"; + +#if NET + readonly string _sampleDataPath = Path.Combine(AppDomain.CurrentDomain.BaseDirectory, "SampleData"); +#else + readonly string _sampleDataPath = Path.Combine(Directory.GetCurrentDirectory(), "SampleData"); +#endif + + string PathFor(string sampleFile) => Path.Combine(_sampleDataPath, sampleFile); + + static string CreateUnderscoresXml() { + var doc = new XDocument(); + var root = new XElement("Person"); + + root.Add(new XElement("Name", "John Sheehan")); + root.Add(new XElement("Start_Date", new DateTime(2009, 9, 25, 0, 6, 1))); + root.Add(new XAttribute("Age", 28)); + root.Add(new XElement("Percent", 99.9999m)); + root.Add(new XElement("Big_Number", long.MaxValue)); + root.Add(new XAttribute("Is_Cool", false)); + root.Add(new XElement("Ignore", "dummy")); + root.Add(new XAttribute("Read_Only", "dummy")); + root.Add(new XElement("Unique_Id", new Guid(GuidString))); + root.Add(new XElement("Url", "https://example.com")); + root.Add(new XElement("Url_Path", "/foo/bar")); + + root.Add( + new XElement( + "Best_Friend", + new XElement("Name", "The Fonz"), + new XAttribute("Since", 1952) + ) + ); + + var friends = new XElement("Friends"); + + for (var i = 0; i < 10; i++) { + friends.Add( + new XElement( + "Friend", + new XElement("Name", $"Friend{i}"), + new XAttribute("Since", DateTime.Now.Year - i) + ) + ); + } + + root.Add(friends); + + var foes = new XElement("Foes"); + + foes.Add(new XAttribute("Team", "Yankees")); + + for (var i = 0; i < 5; i++) foes.Add(new XElement("Foe", new XElement("Nickname", $"Foe{i}"))); + + root.Add(foes); + doc.Add(root); + + return doc.ToString(); + } + + static string CreateLowercaseUnderscoresXml() { + var doc = new XDocument(); + var root = new XElement("Person"); + + root.Add(new XElement("Name", "John Sheehan")); + root.Add(new XElement("start_date", new DateTime(2009, 9, 25, 0, 6, 1))); + root.Add(new XAttribute("Age", 28)); + root.Add(new XElement("Percent", 99.9999m)); + root.Add(new XElement("big_number", long.MaxValue)); + root.Add(new XAttribute("is_cool", false)); + root.Add(new XElement("Ignore", "dummy")); + root.Add(new XAttribute("read_only", "dummy")); + root.Add(new XElement("unique_id", new Guid(GuidString))); + root.Add(new XElement("Url", "https://example.com")); + root.Add(new XElement("url_path", "/foo/bar")); + + root.Add( + new XElement( + "best_friend", + new XElement("name", "The Fonz"), + new XAttribute("Since", 1952) + ) + ); + + var friends = new XElement("Friends"); + + for (var i = 0; i < 10; i++) { + friends.Add( + new XElement( + "Friend", + new XElement("Name", $"Friend{i}"), + new XAttribute("Since", DateTime.Now.Year - i) + ) + ); + } + + root.Add(friends); + + var foes = new XElement("Foes"); + + foes.Add(new XAttribute("Team", "Yankees")); + + for (var i = 0; i < 5; i++) foes.Add(new XElement("Foe", new XElement("Nickname", $"Foe{i}"))); + + root.Add(foes); + doc.Add(root); + + return doc.ToString(); + } + + static string CreateDashesXml() { + var doc = new XDocument(); + var root = new XElement("Person"); + + root.Add(new XElement("Name", "John Sheehan")); + root.Add(new XElement("Start_Date", new DateTime(2009, 9, 25, 0, 6, 1))); + root.Add(new XAttribute("Age", 28)); + root.Add(new XElement("Percent", 99.9999m)); + root.Add(new XElement("Big-Number", long.MaxValue)); + root.Add(new XAttribute("Is-Cool", false)); + root.Add(new XElement("Ignore", "dummy")); + root.Add(new XAttribute("Read-Only", "dummy")); + root.Add(new XElement("Unique-Id", new Guid(GuidString))); + root.Add(new XElement("Url", "https://example.com")); + root.Add(new XElement("Url-Path", "/foo/bar")); + + root.Add( + new XElement( + "Best-Friend", + new XElement("Name", "The Fonz"), + new XAttribute("Since", 1952) + ) + ); + + var friends = new XElement("Friends"); + + for (var i = 0; i < 10; i++) { + friends.Add( + new XElement( + "Friend", + new XElement("Name", $"Friend{i}"), + new XAttribute("Since", DateTime.Now.Year - i) + ) + ); + } + + root.Add(friends); + + var foes = new XElement("Foes"); + + foes.Add(new XAttribute("Team", "Yankees")); + + for (var i = 0; i < 5; i++) foes.Add(new XElement("Foe", new XElement("Nickname", $"Foe{i}"))); + + root.Add(foes); + doc.Add(root); + + return doc.ToString(); + } + + static string CreateLowerCasedRootElementWithDashesXml() { + var doc = new XDocument(); + + var root = new XElement( + "incoming-invoices", + new XElement("incoming-invoice", new XElement("concept-id", 45)) + ); + + doc.Add(root); + + return doc.ToString(); + } + + static string CreateElementsXml() { + var doc = new XDocument(); + var root = new XElement("Person"); + + root.Add(new XElement("Name", "John Sheehan")); + root.Add(new XElement("StartDate", new DateTime(2009, 9, 25, 0, 6, 1))); + root.Add(new XElement("Age", 28)); + root.Add(new XElement("Percent", 99.9999m)); + root.Add(new XElement("BigNumber", long.MaxValue)); + root.Add(new XElement("IsCool", false)); + root.Add(new XElement("Ignore", "dummy")); + root.Add(new XElement("ReadOnly", "dummy")); + root.Add(new XElement("UniqueId", new Guid(GuidString))); + root.Add(new XElement("EmptyGuid", "")); + root.Add(new XElement("Url", "https://example.com")); + root.Add(new XElement("UrlPath", "/foo/bar")); + root.Add(new XElement("Order", "third")); + root.Add(new XElement("Disposition", "so-so")); + + root.Add( + new XElement( + "BestFriend", + new XElement("Name", "The Fonz"), + new XElement("Since", 1952) + ) + ); + + var friends = new XElement("Friends"); + + for (var i = 0; i < 10; i++) { + friends.Add( + new XElement( + "Friend", + new XElement("Name", $"Friend{i}"), + new XElement("Since", DateTime.Now.Year - i) + ) + ); + } + + root.Add(friends); + doc.Add(root); + + return doc.ToString(); + } + + static string CreateAttributesXml() { + var doc = new XDocument(); + var root = new XElement("Person"); + + root.Add(new XAttribute("Name", "John Sheehan")); + root.Add(new XAttribute("StartDate", new DateTime(2009, 9, 25, 0, 6, 1))); + root.Add(new XAttribute("Age", 28)); + root.Add(new XAttribute("Percent", 99.9999m)); + root.Add(new XAttribute("BigNumber", long.MaxValue)); + root.Add(new XAttribute("IsCool", false)); + root.Add(new XAttribute("Ignore", "dummy")); + root.Add(new XAttribute("ReadOnly", "dummy")); + root.Add(new XAttribute("UniqueId", new Guid(GuidString))); + root.Add(new XAttribute("Url", "https://example.com")); + root.Add(new XAttribute("UrlPath", "/foo/bar")); + + root.Add( + new XElement( + "BestFriend", + new XAttribute("Name", "The Fonz"), + new XAttribute("Since", 1952) + ) + ); + + doc.Add(root); + + return doc.ToString(); + } + + static string CreateNoteXml() { + var doc = new XDocument(); + var root = new XElement("Note"); + + root.SetAttributeValue("Id", 1); + root.Value = Note.ConstMessage; + root.Add(new XElement("Title", Note.ConstTitle)); + + doc.Add(root); + + return doc.ToString(); + } + + static string CreateXmlWithNullValues() { + var doc = new XDocument(); + var root = new XElement("NullableValues"); + + root.Add( + new XElement("Id", null!), + new XElement("StartDate", null!), + new XElement("UniqueId", null!) + ); + + doc.Add(root); + + return doc.ToString(); + } + + static string CreateXmlWithoutEmptyValues(CultureInfo culture) { + var doc = new XDocument(); + var root = new XElement("NullableValues"); + + root.Add( + new XElement("Id", 123), + new XElement("StartDate", new DateTime(2010, 2, 21, 9, 35, 00).ToString(culture)), + new XElement("UniqueId", new Guid(GuidString)) + ); + + doc.Add(root); + + return doc.ToString(); + } + + static string CreateXmlWithEmptyNestedList() { + var doc = new XDocument(); + var root = new XElement("EmptyListSample"); + + root.Add(new XElement("Images")); + doc.Add(root); + + return doc.ToString(); + } + + static string CreateXmlWithEmptyInlineList() { + var doc = new XDocument(); + var root = new XElement("EmptyListSample"); + + doc.Add(root); + + return doc.ToString(); + } + + static string CreateXmlWithAttributesAndNullValues() { + var doc = new XDocument(); + var root = new XElement("NullableValues"); + var idElement = new XElement("Id", null!); + + idElement.SetAttributeValue("SomeAttribute", "SomeAttribute_Value"); + + root.Add( + idElement, + new XElement("StartDate", null!), + new XElement("UniqueId", null!) + ); + + doc.Add(root); + + return doc.ToString(); + } + + static string CreateXmlWithAttributesAndNullValuesAndPopulatedValues() { + var doc = new XDocument(); + var root = new XElement("NullableValues"); + var idElement = new XElement("Id", null!); + + idElement.SetAttributeValue("SomeAttribute", "SomeAttribute_Value"); + + root.Add( + idElement, + new XElement("StartDate", null!), + new XElement("UniqueId", new Guid(GuidString)) + ); + + doc.Add(root); + + return doc.ToString(); + } + + [Fact] + public void Able_to_use_alternative_name_for_arrays() { + var xmlFilePath = PathFor("header_and_rows.xml"); + var doc = XDocument.Load(xmlFilePath); + var xml = new XmlDeserializer(); + var output = xml.Deserialize
(new() { Content = doc.ToString() })!; + + Assert.NotNull(output); + Assert.Equal("text title", output.Title); + Assert.Contains(output.Othername, x => x.Text1 == "first row text 1 sample"); + } + + [Fact] + public void Can_deal_with_value_attribute() { + const string content = "Green255"; + var xml = new XmlDeserializer(); + var output = xml.Deserialize(new() { Content = content })!; + + Assert.NotNull(output); + Assert.Equal("Green", output.Name); + Assert.Equal(255, output.Value); + } + + [Fact] + public void Can_Deserialize_Attribute_Using_Exact_Name_Defined_In_DeserializeAs_Attribute() { + const string content = """"""; + + var expected = new NodeWithAttributeAndValue { + AttributeValue = "711" + }; + + var xml = new XmlDeserializer(); + var output = xml.Deserialize(new() { Content = content })!; + + Assert.Equal(expected.AttributeValue, output.AttributeValue); + } + + [Fact] + public void Can_Deserialize_AttributeNamedValue() { + var doc = new XDocument(); + var root = new XElement("ValueCollection"); + + var xmlCollection = new XElement("Values"); + + var first = new XElement("Value"); + first.Add(new XAttribute("Timestamp", new DateTime(1969, 7, 20, 20, 18, 00, DateTimeKind.Utc))); + first.Add(new XAttribute("Value", "Eagle landed")); + + xmlCollection.Add(first); + + var second = new XElement("Value"); + second.Add(new XAttribute("Timestamp", new DateTime(1969, 7, 21, 2, 56, 15, DateTimeKind.Utc))); + second.Add(new XAttribute("Value", "First step")); + xmlCollection.Add(second); + + root.Add(xmlCollection); + doc.Add(root); + + var response = new RestResponse { Content = doc.ToString() }; + var d = new XmlDeserializer(); + var valueCollection = d.Deserialize(response)!; + + Assert.Equal(2, valueCollection.Values.Count); + Assert.Equal("Eagle landed", valueCollection.Values.First().Value); + } + + [Fact] + public void Can_Deserialize_Attributes_On_Default_Root() { + var doc = CreateAttributesXml(); + var response = new RestResponse { Content = doc }; + var d = new XmlDeserializer(); + var p = d.Deserialize(response)!; + + Assert.Equal("John Sheehan", p.Name); + Assert.Equal(new DateTime(2009, 9, 25, 0, 6, 1), p.StartDate); + Assert.Equal(28, p.Age); + Assert.Equal(long.MaxValue, p.BigNumber); + Assert.Equal(99.9999m, p.Percent); + Assert.False(p.IsCool); + Assert.Equal(new Guid(GuidString), p.UniqueId); + Assert.Equal(new Uri("https://example.com", UriKind.RelativeOrAbsolute), p.Url); + Assert.Equal(new Uri("/foo/bar", UriKind.RelativeOrAbsolute), p.UrlPath); + Assert.NotNull(p.BestFriend); + Assert.Equal("The Fonz", p.BestFriend.Name); + Assert.Equal(1952, p.BestFriend.Since); + } + + [Fact] + public void Can_Deserialize_Boolean_From_Number() { + var xmlFilePath = PathFor("boolean_from_number.xml"); + var doc = XDocument.Load(xmlFilePath); + var response = new RestResponse { Content = doc.ToString() }; + var d = new XmlDeserializer(); + var output = d.Deserialize(response)!; + + Assert.True(output.Value); + } + + [Fact] + public void Can_Deserialize_Boolean_From_String() { + var xmlFilePath = PathFor("boolean_from_string.xml"); + var doc = XDocument.Load(xmlFilePath); + var response = new RestResponse { Content = doc.ToString() }; + var d = new XmlDeserializer(); + var output = d.Deserialize(response)!; + + Assert.True(output.Value); + } + + [Fact] + public void Can_Deserialize_Custom_Formatted_Date() { + const string format = "dd yyyy MMM, hh:mm ss tt zzz"; + + var culture = CultureInfo.InvariantCulture; + var date = new DateTime(2010, 2, 8, 11, 11, 11); + var doc = new XDocument(); + var root = new XElement("Person"); + + root.Add(new XElement("StartDate", date.ToString(format, culture))); + doc.Add(root); + + var xml = new XmlDeserializer { + DateFormat = format, + Culture = culture + }; + var response = new RestResponse { Content = doc.ToString() }; + var output = xml.Deserialize(response)!; + + Assert.Equal(date, output.StartDate); + } + + [Fact] + public void Can_Deserialize_DateTimeOffset() { + var culture = CultureInfo.InvariantCulture; + var doc = new XDocument(culture); + var dateTimeOffset = new DateTimeOffset(2013, 02, 08, 9, 18, 22, TimeSpan.FromHours(10)); + + DateTimeOffset? nullableDateTimeOffsetWithValue = + new DateTimeOffset(2013, 02, 08, 9, 18, 23, TimeSpan.FromHours(10)); + var root = new XElement("Dates"); + + root.Add(new XElement("DateTimeOffset", dateTimeOffset)); + root.Add(new XElement("NullableDateTimeOffsetWithNull", string.Empty)); + root.Add(new XElement("NullableDateTimeOffsetWithValue", nullableDateTimeOffsetWithValue)); + + doc.Add(root); + + //var xml = new XmlDeserializer { Culture = culture, }; + var response = new RestResponse { Content = doc.ToString() }; + var d = new XmlDeserializer { Culture = culture }; + var payload = d.Deserialize(response)!; + + Assert.Equal(dateTimeOffset, payload.DateTimeOffset); + Assert.Null(payload.NullableDateTimeOffsetWithNull); + Assert.True(payload.NullableDateTimeOffsetWithValue.HasValue); + Assert.Equal(nullableDateTimeOffsetWithValue, payload.NullableDateTimeOffsetWithValue); + } + + [Fact] + public void Can_Deserialize_Directly_To_Lists_Off_Root_Element() { + var xmlFilePath = PathFor("directlists.xml"); + var doc = XDocument.Load(xmlFilePath); + var xml = new XmlDeserializer(); + var output = xml.Deserialize>(new() { Content = doc.ToString() })!; + + Assert.Equal(2, output.Count); + } + + [Fact] + public void Can_Deserialize_ElementNamedValue() { + var doc = new XDocument(); + var root = new XElement("ValueCollection"); + + const string valueName = "First moon landing events"; + root.Add(new XElement("Value", valueName)); + + var xmlCollection = new XElement("Values"); + + var first = new XElement("Value"); + first.Add(new XAttribute("Timestamp", new DateTime(1969, 7, 20, 20, 18, 00, DateTimeKind.Utc))); + xmlCollection.Add(first); + + var second = new XElement("Value"); + second.Add(new XAttribute("Timestamp", new DateTime(1969, 7, 21, 2, 56, 15, DateTimeKind.Utc))); + xmlCollection.Add(second); + + root.Add(xmlCollection); + doc.Add(root); + + var response = new RestResponse { Content = doc.ToString() }; + var d = new XmlDeserializer(); + var valueCollection = d.Deserialize(response)!; + + Assert.Equal(valueName, valueCollection.Value); + Assert.Equal(2, valueCollection.Values.Count); + + Assert.Equal( + new DateTime(1969, 7, 20, 20, 18, 00, DateTimeKind.Utc), + valueCollection.Values.First().Timestamp.ToUniversalTime() + ); + } + + [Fact] + public void Can_Deserialize_Elements_On_Default_Root() { + var doc = CreateElementsXml(); + var response = new RestResponse { Content = doc }; + var d = new XmlDeserializer(); + var p = d.Deserialize(response)!; + + Assert.Equal("John Sheehan", p.Name); + Assert.Equal(new DateTime(2009, 9, 25, 0, 6, 1), p.StartDate); + Assert.Equal(28, p.Age); + Assert.Equal(long.MaxValue, p.BigNumber); + Assert.Equal(99.9999m, p.Percent); + Assert.False(p.IsCool); + Assert.Equal(new Guid(GuidString), p.UniqueId); + Assert.Equal(Guid.Empty, p.EmptyGuid); + Assert.Equal(new Uri("https://example.com", UriKind.RelativeOrAbsolute), p.Url); + Assert.Equal(new Uri("/foo/bar", UriKind.RelativeOrAbsolute), p.UrlPath); + Assert.Equal(Order.Third, p.Order); + Assert.Equal(Disposition.SoSo, p.Disposition); + Assert.NotNull(p.Friends); + Assert.Equal(10, p.Friends.Count); + Assert.NotNull(p.BestFriend); + Assert.Equal("The Fonz", p.BestFriend.Name); + Assert.Equal(1952, p.BestFriend.Since); + } + + [Fact] + public void Can_Deserialize_Elements_to_Nullable_Values() { + var culture = CultureInfo.InvariantCulture; + var doc = CreateXmlWithoutEmptyValues(culture); + + var xml = new XmlDeserializer { + Culture = culture + }; + var output = xml.Deserialize(new() { Content = doc })!; + + Assert.NotNull(output.Id); + Assert.NotNull(output.StartDate); + Assert.NotNull(output.UniqueId); + Assert.Equal(123, output.Id); + Assert.Equal(new DateTime(2010, 2, 21, 9, 35, 00), output.StartDate); + Assert.Equal(new Guid(GuidString), output.UniqueId); + } + + [Fact] + public void Can_Deserialize_Empty_Elements_to_Nullable_Values() { + var doc = CreateXmlWithNullValues(); + var xml = new XmlDeserializer(); + var output = xml.Deserialize(new() { Content = doc })!; + + Assert.Null(output.Id); + Assert.Null(output.StartDate); + Assert.Null(output.UniqueId); + } + + [Fact] + public void Can_Deserialize_Empty_Elements_With_Attributes_to_Nullable_Values() { + var doc = CreateXmlWithAttributesAndNullValues(); + var xml = new XmlDeserializer(); + var output = xml.Deserialize(new() { Content = doc })!; + + Assert.Null(output.Id); + Assert.Null(output.StartDate); + Assert.Null(output.UniqueId); + } + + [Fact] + public void Can_Deserialize_Eventful_Xml() { + var xmlFilePath = PathFor("eventful.xml"); + var doc = XDocument.Load(xmlFilePath); + var response = new RestResponse { Content = doc.ToString() }; + var d = new XmlDeserializer(); + var output = d.Deserialize(response)!; + + Assert.Equal(3, output.venues.Count); + Assert.Equal("Tivoli", output.venues[0].name); + Assert.Equal("https://eventful.com/brisbane/venues/tivoli-/V0-001-002169294-8", output.venues[1].url); + Assert.Equal("V0-001-000266914-3", output.venues[2].id); + } + + [Fact] + public void Can_Deserialize_Goodreads_Xml() { + var xmlFilePath = PathFor("Goodreads.xml"); + var doc = XDocument.Load(xmlFilePath); + var response = new RestResponse { Content = doc.ToString() }; + var d = new XmlDeserializer(); + var output = d.Deserialize(response)!; + + Assert.Equal(2, output.Reviews.Count); + Assert.Equal("1208943892", output.Reviews[0].Id); // This fails without fixing the XmlDeserializer + Assert.Equal("1198344567", output.Reviews[1].Id); + } + + [Fact] + public void Can_throw_format_exception_xml() { + var xmlPath = PathFor("GoodreadsFormatError.xml"); + var doc = XDocument.Load(xmlPath); + var response = new RestResponse { Content = doc.ToString() }; + var d = new XmlDeserializer(); + + Assert.Throws(() => d.Deserialize(response) + ); + } + + [Fact] + public void Can_Deserialize_Google_Weather_Xml() { + var xmlPath = PathFor("GoogleWeather.xml"); + var doc = XDocument.Load(xmlPath); + var response = new RestResponse { Content = doc.ToString() }; + var d = new XmlDeserializer(); + var output = d.Deserialize(response)!; + + Assert.Equal(4, output.weather.Count); + Assert.Equal("Sunny", output.weather[0].condition.data); + } + + [Fact] + public void Can_Deserialize_Inline_List_Without_Elements_To_Empty_List() { + var doc = CreateXmlWithEmptyInlineList(); + var xml = new XmlDeserializer(); + var output = xml.Deserialize(new() { Content = doc })!; + + Assert.NotNull(output.Images); + Assert.Empty(output.Images); + } + + [Fact] + public void Can_Deserialize_Into_Struct() { + const string content = "oneOneOnetwoTwoTwo3"; + + var xml = new XmlDeserializer(); + var output = xml.Deserialize(new() { Content = content }); + + Assert.Equal("oneOneOne", output.One); + Assert.Equal("twoTwoTwo", output.Two); + Assert.Equal(3, output.Three); + } + + [Fact] + public void Can_Deserialize_Lastfm_Xml() { + var xmlPath = PathFor("Lastfm.xml"); + var doc = XDocument.Load(xmlPath); + var response = new RestResponse { Content = doc.ToString() }; + var d = new XmlDeserializer(); + var output = d.Deserialize(response)!; + + Assert.Equal( + "https://www.last.fm/event/328799+Philip+Glass+at+Barbican+Centre+on+12+June+2008", + output.url + ); + Assert.Equal("https://www.last.fm/venue/8777860+Barbican+Centre", output.venue.url); + } + + [Fact] + public void Can_Deserialize_Lists_of_Simple_Types() { + var xmlPath = PathFor("xmllists.xml"); + var doc = XDocument.Load(xmlPath); + var xml = new XmlDeserializer(); + + var output = xml.Deserialize(new() { Content = doc.ToString() })!; + + Assert.NotEqual(0, output.Names[0].Length); + Assert.NotEqual(0, output.Numbers.Sum()); + } + + [Fact] + public void Can_Deserialize_Lower_Cased_Root_Elements_With_Dashes() { + var doc = CreateDashesXml(); + var response = new RestResponse { Content = doc }; + var d = new XmlDeserializer(); + var p = d.Deserialize(response)!; + + Assert.Equal("John Sheehan", p.Name); + Assert.Equal(new(2009, 9, 25, 0, 6, 1), p.StartDate); + Assert.Equal(28, p.Age); + Assert.Equal(long.MaxValue, p.BigNumber); + Assert.Equal(99.9999m, p.Percent); + Assert.False(p.IsCool); + Assert.Equal(new(GuidString), p.UniqueId); + Assert.Equal(new("https://example.com", UriKind.RelativeOrAbsolute), p.Url); + Assert.Equal(new("/foo/bar", UriKind.RelativeOrAbsolute), p.UrlPath); + Assert.NotNull(p.Friends); + Assert.Equal(10, p.Friends.Count); + Assert.NotNull(p.BestFriend); + Assert.Equal("The Fonz", p.BestFriend.Name); + Assert.Equal(1952, p.BestFriend.Since); + Assert.NotNull(p.Foes); + Assert.Equal(5, p.Foes.Count); + Assert.Equal("Yankees", p.Foes.Team); + } + + [Fact] + public void Can_Deserialize_Mixture_Of_Empty_Elements_With_Attributes_And_Populated_Elements() { + var doc = CreateXmlWithAttributesAndNullValuesAndPopulatedValues(); + var xml = new XmlDeserializer(); + var output = xml.Deserialize(new() { Content = doc })!; + + Assert.Null(output.Id); + Assert.Null(output.StartDate); + Assert.Equal(new Guid(GuidString), output.UniqueId); + } + + [Fact] + public void Can_Deserialize_Names_With_Dashes_On_Default_Root() { + var doc = CreateDashesXml(); + var response = new RestResponse { Content = doc }; + var d = new XmlDeserializer(); + var p = d.Deserialize(response)!; + + Assert.Equal("John Sheehan", p.Name); + Assert.Equal(new(2009, 9, 25, 0, 6, 1), p.StartDate); + Assert.Equal(28, p.Age); + Assert.Equal(long.MaxValue, p.BigNumber); + Assert.Equal(99.9999m, p.Percent); + Assert.False(p.IsCool); + Assert.Equal(new(GuidString), p.UniqueId); + Assert.Equal(new("https://example.com", UriKind.RelativeOrAbsolute), p.Url); + Assert.Equal(new("/foo/bar", UriKind.RelativeOrAbsolute), p.UrlPath); + Assert.NotNull(p.Friends); + Assert.Equal(10, p.Friends.Count); + Assert.NotNull(p.BestFriend); + Assert.Equal("The Fonz", p.BestFriend.Name); + Assert.Equal(1952, p.BestFriend.Since); + Assert.NotNull(p.Foes); + Assert.Equal(5, p.Foes.Count); + Assert.Equal("Yankees", p.Foes.Team); + } + + [Fact] + public void Can_Deserialize_Names_With_Underscores_On_Default_Root() { + var doc = CreateUnderscoresXml(); + var response = new RestResponse { Content = doc }; + var d = new XmlDeserializer(); + var p = d.Deserialize(response)!; + + Assert.Equal("John Sheehan", p.Name); + Assert.Equal(new(2009, 9, 25, 0, 6, 1), p.StartDate); + Assert.Equal(28, p.Age); + Assert.Equal(long.MaxValue, p.BigNumber); + Assert.Equal(99.9999m, p.Percent); + Assert.False(p.IsCool); + Assert.Equal(new(GuidString), p.UniqueId); + Assert.Equal(new("https://example.com", UriKind.RelativeOrAbsolute), p.Url); + Assert.Equal(new("/foo/bar", UriKind.RelativeOrAbsolute), p.UrlPath); + Assert.NotNull(p.Friends); + Assert.Equal(10, p.Friends.Count); + Assert.NotNull(p.BestFriend); + Assert.Equal("The Fonz", p.BestFriend.Name); + Assert.Equal(1952, p.BestFriend.Since); + Assert.NotNull(p.Foes); + Assert.Equal(5, p.Foes.Count); + Assert.Equal("Yankees", p.Foes.Team); + } + + [Fact] + public void Can_Deserialize_Names_With_Underscores_Without_Matching_Case_On_Default_Root() { + var doc = CreateLowercaseUnderscoresXml(); + var response = new RestResponse { Content = doc }; + var d = new XmlDeserializer(); + var p = d.Deserialize(response)!; + + Assert.Equal("John Sheehan", p.Name); + Assert.Equal(new(2009, 9, 25, 0, 6, 1), p.StartDate); + Assert.Equal(28, p.Age); + Assert.Equal(long.MaxValue, p.BigNumber); + Assert.Equal(99.9999m, p.Percent); + Assert.False(p.IsCool); + Assert.Equal(new(GuidString), p.UniqueId); + Assert.Equal(new("https://example.com", UriKind.RelativeOrAbsolute), p.Url); + Assert.Equal(new("/foo/bar", UriKind.RelativeOrAbsolute), p.UrlPath); + Assert.NotNull(p.Friends); + Assert.Equal(10, p.Friends.Count); + Assert.NotNull(p.BestFriend); + Assert.Equal("The Fonz", p.BestFriend.Name); + Assert.Equal(1952, p.BestFriend.Since); + Assert.NotNull(p.Foes); + Assert.Equal(5, p.Foes.Count); + Assert.Equal("Yankees", p.Foes.Team); + } + + [Fact] + public void Can_Deserialize_Nested_List_Items_With_Matching_Class_Name() { + var xmlFilePath = PathFor("NestedListSample.xml"); + var doc = XDocument.Load(xmlFilePath); + var xml = new XmlDeserializer(); + var output = xml.Deserialize(new() { Content = doc.ToString() })!; + + Assert.Equal(4, output.images.Count); + } + + [Fact] + public void Can_Deserialize_Nested_List_Items_Without_Matching_Class_Name() { + var xmlFilePath = PathFor("NestedListSample.xml"); + var doc = XDocument.Load(xmlFilePath); + var xml = new XmlDeserializer(); + var output = xml.Deserialize(new() { Content = doc.ToString() })!; + + Assert.Equal(4, output.Images.Count); + } + + [Fact] + public void Can_Deserialize_Nested_List_Without_Elements_To_Empty_List() { + var doc = CreateXmlWithEmptyNestedList(); + var xml = new XmlDeserializer(); + var output = xml.Deserialize(new() { Content = doc })!; + + Assert.NotNull(output.Images); + Assert.Empty(output.Images); + } + + [Fact] + public void Can_Deserialize_Node_That_Has_Attribute_And_Content() { + var doc = CreateNoteXml(); + + var response = new RestResponse { Content = doc }; + var d = new XmlDeserializer(); + + var note = d.Deserialize(response)!; + + Assert.Equal(1, note.Id); + Assert.Equal(Note.ConstTitle, note.Title); + Assert.Equal(Note.ConstMessage, note.Message); + } + + [Fact] + public void Can_Deserialize_Node_Using_Exact_Name_Defined_In_DeserializeAs_Attribute() { + const string content = "711"; + + var expected = new SingleNode { Node = "711" }; + + var xml = new XmlDeserializer(); + var output = xml.Deserialize(new() { Content = content })!; + + Assert.NotNull(output); + Assert.Equal(expected.Node, output.Node); + } + + [Fact] + public void Can_Deserialize_Parentless_aka_Inline_List_Items_With_Matching_Class_Name() { + var xmlFilePath = PathFor("InlineListSample.xml"); + var doc = XDocument.Load(xmlFilePath); + var xml = new XmlDeserializer(); + var output = xml.Deserialize(new() { Content = doc.ToString() })!; + + Assert.Equal(4, output.images.Count); + } + + [Fact] + public void Can_Deserialize_Parentless_aka_Inline_List_Items_With_Matching_Class_Name_With_Additional_Property() { + var xmlFilePath = PathFor("InlineListSample.xml"); + var doc = XDocument.Load(xmlFilePath); + var xml = new XmlDeserializer(); + var output = xml.Deserialize(new() { Content = doc.ToString() })!; + + Assert.Equal(4, output.Count); + } + + [Fact] + public void Can_Deserialize_Parentless_aka_Inline_List_Items_Without_Matching_Class_Name() { + var xmlFilePath = PathFor("InlineListSample.xml"); + var doc = XDocument.Load(xmlFilePath); + var xml = new XmlDeserializer(); + var output = xml.Deserialize(new() { Content = doc.ToString() })!; + + Assert.Equal(4, output.Images.Count); + } + + [Fact] + public void Can_Deserialize_Root_Elements_Without_Matching_Case_And_Dashes() { + var doc = CreateLowerCasedRootElementWithDashesXml(); + var response = new RestResponse { Content = doc }; + var d = new XmlDeserializer(); + var p = d.Deserialize>(response)!; + + Assert.NotNull(p); + Assert.Single(p); + Assert.Equal(45, p[0].ConceptId); + } + + [Fact] + public void Can_Deserialize_TimeSpan() { + var culture = CultureInfo.InvariantCulture; + var doc = new XDocument(culture); + TimeSpan? nullable = new TimeSpan(21, 30, 7); + var root = new XElement("Person"); + + root.Add(new XElement("Tick", new TimeSpan(468006))); + root.Add(new XElement("Millisecond", new TimeSpan(0, 0, 0, 0, 125))); + root.Add(new XElement("Second", new TimeSpan(0, 0, 8))); + root.Add(new XElement("Minute", new TimeSpan(0, 55, 2))); + root.Add(new XElement("Hour", new TimeSpan(21, 30, 7))); + root.Add(new XElement("NullableWithoutValue", (TimeSpan?)null)); + root.Add(new XElement("NullableWithValue", nullable)); + + doc.Add(root); + + var response = new RestResponse { + Content = doc.ToString() + }; + + var d = new XmlDeserializer { Culture = culture }; + var payload = d.Deserialize(response)!; + + Assert.Equal(new(468006), payload.Tick); + Assert.Equal(new(0, 0, 0, 0, 125), payload.Millisecond); + Assert.Equal(new(0, 0, 8), payload.Second); + Assert.Equal(new(0, 55, 2), payload.Minute); + Assert.Equal(new(21, 30, 7), payload.Hour); + Assert.Null(payload.NullableWithoutValue); + Assert.NotNull(payload.NullableWithValue); + Assert.Equal(new(21, 30, 7), payload.NullableWithValue.Value); + } + + [Fact] + public void Can_Deserialize_To_List_Inheritor_From_Custom_Root_With_Attributes() { + var xmlFilePath = PathFor("ListWithAttributes.xml"); + var doc = XDocument.Load(xmlFilePath); + var xml = new XmlDeserializer { RootElement = "Calls" }; + var output = xml.Deserialize(new() { Content = doc.ToString() })!; + + Assert.Equal(3, output.NumPages); + Assert.Equal(2, output.Count); + } + + [Fact] + public void Can_Deserialize_To_Standalone_List_With_Matching_Class_Case() { + var xmlFilePath = PathFor("InlineListSample.xml"); + var doc = XDocument.Load(xmlFilePath); + var xml = new XmlDeserializer(); + var output = xml.Deserialize>(new() { Content = doc.ToString() })!; + + Assert.Equal(4, output.Count); + } + + [Fact] + public void Can_Deserialize_To_Standalone_List_Without_Matching_Class_Case() { + var xmlFilePath = PathFor("InlineListSample.xml"); + var doc = XDocument.Load(xmlFilePath); + var xml = new XmlDeserializer(); + var output = xml.Deserialize>(new() { Content = doc.ToString() })!; + + Assert.Equal(4, output.Count); + } + + [Fact] + public void Can_Deserialize_When_RootElement_Deeper_Then_One() { + const string content = + "oneOneOnetwoTwoTwo3"; + var xml = new XmlDeserializer { RootElement = "subsubroot" }; + var output = xml.Deserialize(new() { Content = content }); + + Assert.Equal("oneOneOne", output.One); + Assert.Equal("twoTwoTwo", output.Two); + Assert.Equal(3, output.Three); + } + + [Fact] + public void Can_Use_DeserializeAs_Attribute() { + const string content = + "1Jacksonoddball"; + var xml = new XmlDeserializer(); + var output = xml.Deserialize(new() { Content = content })!; + + Assert.NotNull(output); + Assert.Equal("1", output.Sid); + Assert.Equal("Jackson", output.FriendlyName); + Assert.Equal("oddball", output.GoodPropertyName); + } + + [Fact] + public void Can_Use_DeserializeAs_Attribute_for_List() { + var xmlFilePath = PathFor("deserialize_as_list.xml"); + var doc = XDocument.Load(xmlFilePath); + var xml = new XmlDeserializer(); + var output = xml.Deserialize>(new() { Content = doc.ToString() })!; + + Assert.NotNull(output); + Assert.Equal("1", output[0].Sid); + } + + [Fact] + public void Can_Use_DeserializeAs_Attribute_for_List_Property() { + const string content = + "TestValue"; + + var xml = new XmlDeserializer(); + var output = xml.Deserialize(new() { Content = content })!; + + Assert.NotNull(output); + Assert.NotNull(output.ListWithGoodName); + Assert.NotEmpty(output.ListWithGoodName); + } + + [Fact] + public void Cannot_Deserialize_Node_To_An_Object_That_Has_Two_Properties_With_Text_Content_Attributes() { + var doc = CreateNoteXml(); + + var response = new RestResponse { Content = doc }; + var d = new XmlDeserializer(); + + Assert.Throws(() => d.Deserialize(response)); + } + + [Fact] + public void Ignore_Protected_Property_That_Exists_In_Data() { + var doc = CreateElementsXml(); + var response = new RestResponse { Content = doc }; + var d = new XmlDeserializer(); + var p = d.Deserialize(response)!; + + Assert.Null(p.IgnoreProxy); + } + + [Fact] + public void Ignore_ReadOnly_Property_That_Exists_In_Data() { + var doc = CreateElementsXml(); + var response = new RestResponse { Content = doc }; + var d = new XmlDeserializer(); + var p = d.Deserialize(response)!; + + Assert.Null(p.ReadOnlyProxy); + } + + [Fact] + public void Deserialize_Nested_List_Should_Not_Include_Deeply_Nested_Items() { + // Bug #1 test: HandleListDerivative should use Elements() on containers, not Descendants() + const string xml = """ + + + + 1 + + 2 + 3 + + + + + """; + + var deserializer = new XmlDeserializer(); + var result = deserializer.Deserialize(new RestResponse { Content = xml })!; + + // Should only have 1 item (id=1), not 3 (id=1,2,3) + Assert.NotNull(result); + Assert.NotNull(result.Items); + Assert.Single(result.Items); + Assert.Equal(1, result.Items[0].Id); + } + + [Fact] + public void Deserialize_RootElement_Should_Not_Throw_On_Duplicate_Nested_Names() { + // Bug #2 test: RootElement selection should handle duplicate names gracefully + const string xml = """ + + + + 72 + + + 74 + + + + + + """; + + var deserializer = new XmlDeserializer { RootElement = "items" }; + + // Should not throw InvalidOperationException: Sequence contains more than one element + var exception = Record.Exception(() => + deserializer.Deserialize(new RestResponse { Content = xml }) + ); + + Assert.Null(exception); + } + + [Fact] + public void Deserialize_RootElement_Should_Prefer_Shallowest_Match() { + // Bug #2 test: When multiple elements match RootElement, prefer the shallowest one + const string xml = """ + + + + 72 + + + 74 + + + + + + """; + + var deserializer = new XmlDeserializer { RootElement = "items" }; + var result = deserializer.Deserialize(new RestResponse { Content = xml })!; + + // Should deserialize from the top-level , not the nested one + Assert.NotNull(result); + Assert.NotNull(result.Items); + Assert.Single(result.Items); + Assert.Equal(72, result.Items[0].Id); + } + + [Fact] + public void Deserialize_RootElement_Should_Try_Direct_Child_First() { + // Bug #2 test: Should try Element() before DescendantsAndSelf() + const string xml = """ + + + direct + + + """; + + var deserializer = new XmlDeserializer { RootElement = "data" }; + var result = deserializer.Deserialize(new RestResponse { Content = xml }); + + Assert.Equal("direct", result.One); + } + + [Fact] + public void Deserialize_List_With_Container_Should_Use_Direct_Children_Only() { + // Test that container-based list deserialization uses Elements() not Descendants() + const string xml = """ + + + + 10 + + 20 + + + + 11 + + + + """; + + var deserializer = new XmlDeserializer(); + var result = deserializer.Deserialize(new RestResponse { Content = xml })!; + + Assert.NotNull(result.Items); + Assert.Equal(2, result.Items.Count); + Assert.Equal(10, result.Items[0].Id); + Assert.Equal(11, result.Items[1].Id); + } + + [Fact] + public void Deserialize_Nested_Items_Should_Also_Use_Direct_Children() { + // Test that nested subitems also correctly use direct children + const string xml = """ + + + + 1 + + 2 + + 3 + + 4 + + + + + + + """; + + var deserializer = new XmlDeserializer(); + var result = deserializer.Deserialize(new RestResponse { Content = xml })!; + + Assert.NotNull(result.Items); + Assert.Single(result.Items); + + var topItem = result.Items[0]; + Assert.Equal(1, topItem.Id); + Assert.NotNull(topItem.SubItems); + Assert.Equal(2, topItem.SubItems.Count); + Assert.Equal(2, topItem.SubItems[0].Id); + Assert.Equal(3, topItem.SubItems[1].Id); + } +} diff --git a/test/RestSharp.Tests.Serializers.Xml/XmlSerializerTests.cs b/test/RestSharp.Tests.Serializers.Xml/XmlSerializerTests.cs new file mode 100644 index 000000000..ae6d6ea2b --- /dev/null +++ b/test/RestSharp.Tests.Serializers.Xml/XmlSerializerTests.cs @@ -0,0 +1,560 @@ +using System.Globalization; +using System.Xml.Linq; +using RestSharp.Serializers; +using RestSharp.Serializers.Xml; +using RestSharp.Tests.Serializers.Xml.SampleClasses; + +namespace RestSharp.Tests.Serializers.Xml; + +public class XmlSerializerTests { + public XmlSerializerTests() { + Thread.CurrentThread.CurrentCulture = CultureInfo.InvariantCulture; + Thread.CurrentThread.CurrentUICulture = CultureInfo.InstalledUICulture; + } + + [Fact] + public void Can_serialize_a_list_of_items_with_interface_type() { + var items = new NamedItems { + Items = [ + new Person { + Name = "Foo", + Age = 50, + Price = 19.95m, + StartDate = new(2009, 12, 18, 10, 2, 23), + Items = [new() { Name = "One", Value = 1 }] + }, + + new Item { Name = "Two", Value = 2 }, + new Item { Name = "Three", Value = 3 } + ] + }; + + var xml = new XmlSerializer(); + var doc = xml.Serialize(items); + var expected = GetNamedItemsXDoc(CultureInfo.InvariantCulture); + + Assert.Equal(expected.ToString(), doc); + } + + [Fact] + public void Can_serialize_a_list_which_is_the_content_of_root_element() { + var contacts = new Contacts { + People = [ + new() { + Name = "Foo", + Age = 50, + Price = 19.95m, + StartDate = new(2009, 12, 18, 10, 2, 23), + Items = [ + new() { Name = "One", Value = 1 }, + new() { Name = "Two", Value = 2 }, + new() { Name = "Three", Value = 3 } + ] + }, + + new() { + Name = "Bar", + Age = 23, + Price = 23.23m, + StartDate = new(2009, 12, 23, 10, 23, 23), + Items = [ + new() { Name = "One", Value = 1 }, + new() { Name = "Two", Value = 2 }, + new() { Name = "Three", Value = 3 } + ] + } + ] + }; + + var xml = new XmlSerializer(); + var doc = xml.Serialize(contacts); + var expected = GetPeopleXDoc(CultureInfo.InvariantCulture); + + Assert.Equal(expected.ToString(), doc); + } + + [Fact] + public void Can_serialize_a_list_which_is_the_root_element() { + var pocoList = new PersonList { + new() { + Name = "Foo", + Age = 50, + Price = 19.95m, + StartDate = new(2009, 12, 18, 10, 2, 23), + Items = [ + new() { Name = "One", Value = 1 }, + new() { Name = "Two", Value = 2 }, + new() { Name = "Three", Value = 3 } + ] + }, + new() { + Name = "Bar", + Age = 23, + Price = 23.23m, + StartDate = new(2009, 12, 23, 10, 23, 23), + Items = [ + new() { Name = "One", Value = 1 }, + new() { Name = "Two", Value = 2 }, + new() { Name = "Three", Value = 3 } + ] + } + }; + var xml = new XmlSerializer(); + var doc = xml.Serialize(pocoList); + var expected = GetPeopleXDoc(CultureInfo.InvariantCulture); + + Assert.Equal(expected.ToString(), doc); + } + + [Fact] + public void Can_Serialize_An_Object_To_Node_With_Attribute_And_Text_Content() { + var note = new Note { + Id = 1, + Title = Note.ConstTitle, + Message = Note.ConstMessage + }; + + var xml = new XmlSerializer(); + var doc = xml.Serialize(note); + + var expected = GetNoteXDoc(); + var expectedStr = expected.ToString(); + + Assert.Equal(expectedStr, doc); + } + + [Fact] + public void Can_serialize_Enum() { + var enumClass = new ClassWithEnum { Color = Color.Red }; + var xml = new XmlSerializer(); + var doc = xml.Serialize(enumClass); + var expected = new XDocument(); + var root = new XElement("ClassWithEnum"); + + root.Add(new XElement("Color", "Red")); + expected.Add(root); + + Assert.Equal(expected.ToString(), doc); + } + + [Fact] + public void Can_serialize_simple_POCO() { + var poco = new Person { + Name = "Foo", + Age = 50, + Price = 19.95m, + StartDate = new(2009, 12, 18, 10, 2, 23), + Items = [ + new() { Name = "One", Value = 1 }, + new() { Name = "Two", Value = 2 }, + new() { Name = "Three", Value = 3 } + ] + }; + var xml = new XmlSerializer(); + var doc = xml.Serialize(poco); + var expected = GetSimplePocoXDoc(); + + Assert.Equal(expected.ToString(), doc); + } + + [Fact] + public void Can_serialize_simple_POCO_With_Attribute_Options_Defined() { + var poco = new WackyPerson { + Name = "Foo", + Age = 50, + Price = 19.95m, + StartDate = new(2009, 12, 18, 10, 2, 23) + }; + var xml = new XmlSerializer(); + var doc = xml.Serialize(poco); + var expected = GetSimplePocoXDocWackyNames(); + + Assert.Equal(expected.ToString(), doc); + } + + [Fact] + public void Can_serialize_simple_POCO_With_Attribute_Options_Defined_And_Property_Containing_IList_Elements() { + var poco = new WackyPerson { + Name = "Foo", + Age = 50, + Price = 19.95m, + StartDate = new(2009, 12, 18, 10, 2, 23), + ContactData = new() { + EmailAddresses = [ + new() { + Address = "test@test.com", + Location = "Work" + } + ] + } + }; + var xml = new XmlSerializer(); + var doc = xml.Serialize(poco); + var expected = GetSimplePocoXDocWackyNamesWithIListProperty(); + + Assert.Equal(expected.ToString(), doc); + } + + [Fact] + public void Can_serialize_simple_POCO_With_DateFormat_Specified() { + var poco = new Person { + Name = "Foo", + Age = 50, + Price = 19.95m, + StartDate = new(2009, 12, 18, 10, 2, 23) + }; + var xml = new XmlSerializer { DateFormat = DateFormat.ISO_8601 }; + var doc = xml.Serialize(poco); + var expected = GetSimplePocoXDocWithIsoDate(); + + Assert.Equal(expected.ToString(), doc); + } + + [Fact] + public void Can_serialize_simple_POCO_With_Different_Root_Element() { + var poco = new Person { + Name = "Foo", + Age = 50, + Price = 19.95m, + StartDate = new(2009, 12, 18, 10, 2, 23) + }; + var xml = new XmlSerializer { RootElement = "Result" }; + var doc = xml.Serialize(poco); + var expected = GetSimplePocoXDocWithRoot(); + + Assert.Equal(expected.ToString(), doc); + } + + [Fact] + public void Can_serialize_simple_POCO_With_XmlFormat_Specified() { + var poco = new Person { + Name = "Foo", + Age = 50, + Price = 19.95m, + StartDate = new(2009, 12, 18, 10, 2, 23), + IsCool = false + }; + var xml = new XmlSerializer { DateFormat = DateFormat.ISO_8601 }; + var doc = xml.Serialize(poco); + var expected = GetSimplePocoXDocWithXmlProperty(); + + Assert.Equal(expected.ToString(), doc); + } + + [Fact] + public void Cannot_Serialize_An_Object_With_Two_Properties_With_Text_Content_Attributes() { + var note = new WrongNote { + Id = 1, + Text = "What a note." + }; + + var xml = new XmlSerializer(); + + Assert.Throws(() => xml.Serialize(note)); + } + + [Fact] + public void Serializes_Properties_In_Specified_Order() { + var ordered = new OrderedProperties { + Name = "Name", + Age = 99, + StartDate = new(2010, 1, 1) + }; + var xml = new XmlSerializer(); + var doc = xml.Serialize(ordered); + var expected = GetSortedPropsXDoc(); + + Assert.Equal(expected.ToString(), doc); + } + + interface INamed { + string Name { get; set; } + } + + class Person : INamed { + public string Name { get; set; } + + public int Age { get; set; } + + public decimal Price { get; set; } + + public DateTime StartDate { get; set; } + + public List Items { get; set; } + + public bool? IsCool { get; set; } + } + + class Item : INamed { + public string Name { get; set; } + + public int Value { get; set; } + } + + enum Color { Red, Blue, Green } + + class ClassWithEnum { + public Color Color { get; set; } + } + + [SerializeAs(Name = "Person")] + class WackyPerson { + [SerializeAs(Name = "WackyName", Attribute = true)] + public string Name { get; set; } + + public int Age { get; set; } + + [SerializeAs(Attribute = true)] + public decimal Price { get; set; } + + [SerializeAs(Name = "start_date", Attribute = true)] + public DateTime StartDate { get; set; } + + [SerializeAs(Name = "contact-data")] + public ContactData ContactData { get; set; } + } + + class NamedItems { + [SerializeAs(Content = true)] + public List Items { get; set; } + } + + [SerializeAs(Name = "People")] + class Contacts { + [SerializeAs(Content = true)] + public List People { get; set; } + } + + [SerializeAs(Name = "People")] + class PersonList : List; + + class ContactData { + [SerializeAs(Name = "email-addresses")] + public List EmailAddresses { get; set; } = []; + } + + [SerializeAs(Name = "email-address")] + class EmailAddress { + [SerializeAs(Name = "address")] + public string Address { get; set; } + + [SerializeAs(Name = "location")] + public string Location { get; set; } + } + + static XDocument GetNoteXDoc() { + var doc = new XDocument(); + var root = new XElement("Note"); + + root.SetAttributeValue("Id", 1); + root.Value = Note.ConstMessage; + root.Add(new XElement("Title", Note.ConstTitle)); + + doc.Add(root); + + return doc; + } + + static XDocument GetSimplePocoXDoc() { + var doc = new XDocument(); + var root = new XElement("Person"); + + root.Add( + new XElement("Name", "Foo"), + new XElement("Age", 50), + new XElement("Price", 19.95m), + new XElement( + "StartDate", + new DateTime(2009, 12, 18, 10, 2, 23).ToString(CultureInfo.InvariantCulture) + ) + ); + + var items = new XElement("Items"); + + items.Add(new XElement("Item", new XElement("Name", "One"), new XElement("Value", 1))); + items.Add(new XElement("Item", new XElement("Name", "Two"), new XElement("Value", 2))); + items.Add(new XElement("Item", new XElement("Name", "Three"), new XElement("Value", 3))); + + root.Add(items); + doc.Add(root); + + return doc; + } + + static XDocument GetSimplePocoXDocWithIsoDate() { + var doc = new XDocument(); + var root = new XElement("Person"); + + root.Add( + new XElement("Name", "Foo"), + new XElement("Age", 50), + new XElement("Price", 19.95m), + new XElement("StartDate", new DateTime(2009, 12, 18, 10, 2, 23).ToString("s")) + ); + + doc.Add(root); + + return doc; + } + + static XDocument GetSimplePocoXDocWithXmlProperty() { + var doc = new XDocument(); + var root = new XElement("Person"); + + root.Add( + new XElement("Name", "Foo"), + new XElement("Age", 50), + new XElement("Price", 19.95m), + new XElement("StartDate", new DateTime(2009, 12, 18, 10, 2, 23).ToString("s")), + new XElement("IsCool", false) + ); + + doc.Add(root); + + return doc; + } + + static XDocument GetSimplePocoXDocWithRoot() { + var doc = new XDocument(); + var root = new XElement("Result"); + var start = new XElement("Person"); + + start.Add( + new XElement("Name", "Foo"), + new XElement("Age", 50), + new XElement("Price", 19.95m), + new XElement( + "StartDate", + new DateTime(2009, 12, 18, 10, 2, 23).ToString(CultureInfo.InvariantCulture) + ) + ); + + root.Add(start); + doc.Add(root); + + return doc; + } + + static XDocument GetSimplePocoXDocWackyNames() { + var doc = new XDocument(); + var root = new XElement("Person"); + + root.Add( + new XAttribute("WackyName", "Foo"), + new XElement("Age", 50), + new XAttribute("Price", 19.95m), + new XAttribute( + "start_date", + new DateTime(2009, 12, 18, 10, 2, 23).ToString(CultureInfo.InvariantCulture) + ) + ); + + doc.Add(root); + + return doc; + } + + static XDocument GetSimplePocoXDocWackyNamesWithIListProperty() { + var doc = new XDocument(); + var root = new XElement("Person"); + + root.Add( + new XAttribute("WackyName", "Foo"), + new XElement("Age", 50), + new XAttribute("Price", 19.95m), + new XAttribute( + "start_date", + new DateTime(2009, 12, 18, 10, 2, 23).ToString(CultureInfo.InvariantCulture) + ), + new XElement( + "contact-data", + new XElement( + "email-addresses", + new XElement( + "email-address", + new XElement("address", "test@test.com"), + new XElement("location", "Work") + ) + ) + ) + ); + + doc.Add(root); + + return doc; + } + + static XDocument GetSortedPropsXDoc() { + var doc = new XDocument(); + var root = new XElement("OrderedProperties"); + + root.Add(new XElement("StartDate", new DateTime(2010, 1, 1).ToString(CultureInfo.InvariantCulture))); + root.Add(new XElement("Name", "Name")); + root.Add(new XElement("Age", 99)); + + doc.Add(root); + + return doc; + } + + static XDocument GetNamedItemsXDoc(IFormatProvider culture) { + var doc = new XDocument(); + var root = new XElement("NamedItems"); + var element = new XElement("Person"); + var items = new XElement("Items"); + + items.Add(new XElement("Item", new XElement("Name", "One"), new XElement("Value", 1))); + + element.Add( + new XElement("Name", "Foo"), + new XElement("Age", 50), + new XElement("Price", 19.95m.ToString(culture)), + new XElement("StartDate", new DateTime(2009, 12, 18, 10, 2, 23).ToString(culture)) + ); + + element.Add(items); + root.Add(element); + root.Add(new XElement("Item", new XElement("Name", "Two"), new XElement("Value", 2))); + root.Add(new XElement("Item", new XElement("Name", "Three"), new XElement("Value", 3))); + + doc.Add(root); + + return doc; + } + + static XDocument GetPeopleXDoc(IFormatProvider culture) { + var doc = new XDocument(); + var root = new XElement("People"); + var element = new XElement("Person"); + var items = new XElement("Items"); + + items.Add(new XElement("Item", new XElement("Name", "One"), new XElement("Value", 1))); + items.Add(new XElement("Item", new XElement("Name", "Two"), new XElement("Value", 2))); + items.Add(new XElement("Item", new XElement("Name", "Three"), new XElement("Value", 3))); + + element.Add( + new XElement("Name", "Foo"), + new XElement("Age", 50), + new XElement("Price", 19.95m.ToString(culture)), + new XElement("StartDate", new DateTime(2009, 12, 18, 10, 2, 23).ToString(culture)) + ); + + element.Add(items); + root.Add(element); + element = new("Person"); + + element.Add( + new XElement("Name", "Bar"), + new XElement("Age", 23), + new XElement("Price", 23.23m.ToString(culture)), + new XElement("StartDate", new DateTime(2009, 12, 23, 10, 23, 23).ToString(culture)) + ); + + element.Add(items); + + root.Add(element); + doc.Add(root); + + return doc; + } +} \ No newline at end of file diff --git a/test/RestSharp.Tests.Shared/Extensions/StreamExtensions.cs b/test/RestSharp.Tests.Shared/Extensions/StreamExtensions.cs new file mode 100644 index 000000000..b4fd142ce --- /dev/null +++ b/test/RestSharp.Tests.Shared/Extensions/StreamExtensions.cs @@ -0,0 +1,23 @@ +using System.Text; + +namespace RestSharp.Tests.Shared.Extensions; + +public static class StreamExtensions { + public static void WriteStringUtf8(this Stream target, string value) { + var encoded = Encoding.UTF8.GetBytes(value); + + target.Write(encoded, 0, encoded.Length); + } + + public static string StreamToString(this Stream stream) { + using var streamReader = new StreamReader(stream); + + return streamReader.ReadToEnd(); + } + + public static async Task StreamToStringAsync(this Stream stream) { + using var streamReader = new StreamReader(stream); + + return await streamReader.ReadToEndAsync().ConfigureAwait(false); + } +} \ No newline at end of file diff --git a/test/RestSharp.Tests.Shared/Extensions/UriExtensions.cs b/test/RestSharp.Tests.Shared/Extensions/UriExtensions.cs new file mode 100644 index 000000000..c1c512ad0 --- /dev/null +++ b/test/RestSharp.Tests.Shared/Extensions/UriExtensions.cs @@ -0,0 +1,8 @@ +namespace RestSharp.Tests.Shared.Extensions; + +public static class UriExtensions { + public static IDictionary ParseQuery(this Uri uri) { + var query = uri.Query[1..].Split('&'); + return query.Select(x => x.Split('=')).ToDictionary(x => x[0], x => x[1]); + } +} \ No newline at end of file diff --git a/test/RestSharp.Tests.Shared/Extensions/WireMockExtensions.cs b/test/RestSharp.Tests.Shared/Extensions/WireMockExtensions.cs new file mode 100644 index 000000000..10751dcc4 --- /dev/null +++ b/test/RestSharp.Tests.Shared/Extensions/WireMockExtensions.cs @@ -0,0 +1,22 @@ +using RestSharp.Tests.Shared.Fixtures; +using WireMock.RequestBuilders; +using WireMock.ResponseBuilders; +using WireMock.Server; + +namespace RestSharp.Tests.Shared.Extensions; + +public static class WireMockExtensions { + public static RequestBodyCapturer ConfigureBodyCapturer(this WireMockServer server, Method method, bool usePath = true) { + var capturer = new RequestBodyCapturer(); + + var requestBuilder = Request + .Create() + .WithPath(usePath ? RequestBodyCapturer.Resource : "/") + .WithUrl(capturer.CaptureUrl) + .WithBody(capturer.CaptureBody) + .WithHeader(capturer.CaptureHeaders) + .UsingMethod(method.ToString().ToUpper()); + server.Given(requestBuilder).RespondWith(Response.Create().WithStatusCode(200)); + return capturer; + } +} \ No newline at end of file diff --git a/test/RestSharp.Tests.Shared/Fixtures/Handlers.cs b/test/RestSharp.Tests.Shared/Fixtures/Handlers.cs new file mode 100644 index 000000000..8cd404dd4 --- /dev/null +++ b/test/RestSharp.Tests.Shared/Fixtures/Handlers.cs @@ -0,0 +1,38 @@ +using System.Net; +using System.Reflection; + +namespace RestSharp.Tests.Shared.Fixtures; + +public static class Handlers { + /// + /// T should be a class that implements methods whose names match the urls being called, and take one parameter, an + /// HttpListenerContext. + /// e.g. + /// urls exercised: "http://localhost:8888/error" and "http://localhost:8888/get_list" + /// class MyHandler + /// { + /// void error(HttpListenerContext ctx) + /// { + /// // do something interesting here + /// } + /// void get_list(HttpListenerContext ctx) + /// { + /// // do something interesting here + /// } + /// } + /// + public static Action Generic() where T : new() + => ctx => { + var methodName = ctx.Request.Url!.Segments.Last(); + + var method = typeof(T).GetMethod( + methodName, + BindingFlags.NonPublic | BindingFlags.Public | BindingFlags.Instance | BindingFlags.Static + ); + + if (method!.IsStatic) + method.Invoke(null, [ctx]); + else + method.Invoke(new T(), [ctx]); + }; +} \ No newline at end of file diff --git a/test/RestSharp.Tests.Shared/Fixtures/RequestBodyCapturer.cs b/test/RestSharp.Tests.Shared/Fixtures/RequestBodyCapturer.cs new file mode 100644 index 000000000..cca83ff9c --- /dev/null +++ b/test/RestSharp.Tests.Shared/Fixtures/RequestBodyCapturer.cs @@ -0,0 +1,31 @@ +namespace RestSharp.Tests.Shared.Fixtures; + +public class RequestBodyCapturer { + public const string Resource = "/capture"; + + public string ContentType { get; private set; } + public bool HasBody { get; private set; } + public string Body { get; private set; } + public Uri Url { get; private set; } + public string RawUrl { get; private set; } + + public bool CaptureBody(string content) { + Body = content; + HasBody = !string.IsNullOrWhiteSpace(content); + return true; + } + + public bool CaptureHeaders(IDictionary headers) { + if (headers.TryGetValue("Content-Type", out var contentType)) { + ContentType = contentType[0]; + } + + return true; + } + + public bool CaptureUrl(string url) { + RawUrl = url; + Url = new(url); + return true; + } +} \ No newline at end of file diff --git a/test/RestSharp.Tests.Shared/Fixtures/SimpleServer.cs b/test/RestSharp.Tests.Shared/Fixtures/SimpleServer.cs new file mode 100644 index 000000000..5f6abc2f9 --- /dev/null +++ b/test/RestSharp.Tests.Shared/Fixtures/SimpleServer.cs @@ -0,0 +1,38 @@ +using System.Net; + +namespace RestSharp.Tests.Shared.Fixtures; + +public sealed class SimpleServer : IDisposable { + static readonly Random Random = new(DateTimeOffset.Now.Millisecond); + + readonly WebServer _server; + readonly CancellationTokenSource _cts = new(); + + public string Url { get; } + + SimpleServer( + int port, + Action handler = null, + AuthenticationSchemes authenticationSchemes = AuthenticationSchemes.Anonymous + ) { + Url = $"http://localhost:{port}/"; + _server = new(Url, handler, authenticationSchemes); + Task.Run(() => _server.Run(_cts.Token)); + } + + public void Dispose() { + _cts.Cancel(); + _server.Stop(); + _cts.Dispose(); + } + + public static SimpleServer Create( + Action handler = null, + AuthenticationSchemes authenticationSchemes = AuthenticationSchemes.Anonymous + ) { + var port = Random.Next(1000, 9999); + return new(port, handler, authenticationSchemes); + } + + public void SetHandler(Action handler) => _server.ChangeHandler(handler); +} \ No newline at end of file diff --git a/test/RestSharp.Tests.Shared/Fixtures/WebServer.cs b/test/RestSharp.Tests.Shared/Fixtures/WebServer.cs new file mode 100644 index 000000000..364ea6751 --- /dev/null +++ b/test/RestSharp.Tests.Shared/Fixtures/WebServer.cs @@ -0,0 +1,70 @@ +using System.Net; + +namespace RestSharp.Tests.Shared.Fixtures; + +public class WebServer { + readonly HttpListener _listener = new(); + Action _responderMethod; + + public WebServer(string prefix, Action method, AuthenticationSchemes authenticationSchemes) { + if (string.IsNullOrEmpty(prefix)) + throw new ArgumentException("URI prefix is required"); + + _listener.Prefixes.Add(prefix); + _listener.AuthenticationSchemes = authenticationSchemes; + + _responderMethod = method; + } + + public async Task Run(CancellationToken token) { + var taskFactory = new TaskFactory(token); + _listener.Start(); + + try { + while (!token.IsCancellationRequested && _listener.IsListening) { + try { + var ctx = await GetContextAsync(); + // ReSharper disable once ConditionIsAlwaysTrueOrFalse + if (ctx == null) continue; + + _responderMethod?.Invoke(ctx); + ctx.Response.OutputStream.Close(); + } + catch (Exception e) { + Console.WriteLine(e.ToString()); + } + } + } + catch (Exception e) { + Console.WriteLine(e.ToString()); + } + + return; + + Task GetContextAsync() + => taskFactory.FromAsync( + (callback, state) => ((HttpListener)state!).BeginGetContext(callback, state), + iar => { + try { + return ((HttpListener)iar.AsyncState!).EndGetContext(iar); + } + catch (ObjectDisposedException) { + // it's ok + return null; + } + catch (HttpListenerException) { + // it's ok + return null; + } + }, + _listener + ); + } + + public void Stop() { + _listener.Stop(); + _listener.Close(); + } + + public void ChangeHandler(Action handler) => _responderMethod = handler; +} \ No newline at end of file diff --git a/test/RestSharp.Tests.Shared/RequestTestsBase.cs b/test/RestSharp.Tests.Shared/RequestTestsBase.cs new file mode 100644 index 000000000..bc4d416c0 --- /dev/null +++ b/test/RestSharp.Tests.Shared/RequestTestsBase.cs @@ -0,0 +1,117 @@ +using System.Net; +using RestSharp.Serializers; +using RestSharp.Tests.Shared.Server; +using WireMock.ResponseBuilders; + +namespace RestSharp.Tests.Shared; + +public abstract class RequestTestsBase(bool disposeClient) { + protected abstract IRestClient GetClient(); + + IRestClient GetTestClient() => new TestClient(GetClient(), disposeClient); + + [Fact] + public async Task Can_Handle_Exception_Thrown_By_Interceptor_BeforeDeserialization() { + const string exceptionMessage = "Thrown from OnBeforeDeserialization"; + + var request = new RestRequest("success") { + Interceptors = [new ThrowingInterceptor(exceptionMessage)] + }; + + using var client = GetTestClient(); + var response = await client.ExecuteAsync(request); + + Assert.Equal(exceptionMessage, response.ErrorMessage); + Assert.Equal(ResponseStatus.Error, response.ResponseStatus); + } + + [Fact, Obsolete("Obsolete")] + public async Task Can_Handle_Exception_Thrown_By_OnBeforeDeserialization_Handler() { + const string exceptionMessage = "Thrown from OnBeforeDeserialization"; + + var request = new RestRequest("success"); + + request.OnBeforeDeserialization += _ => throw new Exception(exceptionMessage); + + using var client = GetTestClient(); + var response = await client.ExecuteAsync(request); + + Assert.Equal(exceptionMessage, response.ErrorMessage); + Assert.Equal(ResponseStatus.Error, response.ResponseStatus); + } + + [Fact] + public async Task Can_Perform_ExecuteGetAsync_With_Response_Type() { + using var client = GetTestClient(); + var request = new RestRequest("success"); + var response = await client.ExecuteAsync(request); + + response.StatusCode.Should().Be(HttpStatusCode.OK); + response.Data!.Message.Should().Be("Works!"); + } + + [Fact] + public async Task Can_Perform_GET_Async() { + const string val = "Basic async test"; + + var request = new RestRequest($"echo?msg={val}"); + + using var client = GetTestClient(); + var response = await client.ExecuteAsync(request); + response.Content.Should().Be(val); + } + +#if NET + [Fact] + public async Task Can_Timeout_GET_Async() { + var request = new RestRequest("timeout").AddBody("Body_Content"); + + // Half the value of ResponseHandler.Timeout + request.Timeout = TimeSpan.FromMilliseconds(200); + + using var client = GetTestClient(); + var response = await client.ExecuteAsync(request); + + response.ResponseStatus.Should().Be(ResponseStatus.TimedOut, response.ErrorMessage); + } +#endif + + [Fact] + public async Task Can_Perform_Delete_With_Response_Type() { + using var client = GetTestClient(); + var request = new RestRequest("delete"); + var response = await client.ExecuteAsync(request, Method.Delete); + + response.StatusCode.Should().Be(HttpStatusCode.OK); + response.Data!.Message.Should().Be("Works!"); + } + + [Fact] + public async Task Can_Delete_With_Response_Type_using_extension() { + using var client = GetTestClient(); + var request = new RestRequest("delete"); + var response = await client.DeleteAsync(request); + + response!.Message.Should().Be("Works!"); + } + + class ThrowingInterceptor(string errorMessage) : Interceptors.Interceptor { + public override ValueTask BeforeDeserialization(RestResponse response, CancellationToken cancellationToken) => throw new(errorMessage); + } + + class TestClient(IRestClient innerClient, bool disposeClient) : IRestClient { + public void Dispose() { + if (disposeClient) innerClient.Dispose(); + } + + public ReadOnlyRestClientOptions Options => innerClient.Options; + public RestSerializers Serializers => innerClient.Serializers; + public DefaultParameters DefaultParameters => innerClient.DefaultParameters; + + public Task ExecuteAsync(RestRequest request, CancellationToken cancellationToken = default) + => innerClient.ExecuteAsync(request, cancellationToken); + + public Task DownloadStreamAsync(RestRequest request, CancellationToken cancellationToken = default) + => innerClient.DownloadStreamAsync(request, cancellationToken); + } +} \ No newline at end of file diff --git a/test/RestSharp.Tests.Shared/RestSharp.Tests.Shared.csproj b/test/RestSharp.Tests.Shared/RestSharp.Tests.Shared.csproj new file mode 100644 index 000000000..06f32e8e6 --- /dev/null +++ b/test/RestSharp.Tests.Shared/RestSharp.Tests.Shared.csproj @@ -0,0 +1,11 @@ + + + false + + + + + + + + diff --git a/test/RestSharp.Tests.Shared/Server/Models.cs b/test/RestSharp.Tests.Shared/Server/Models.cs new file mode 100644 index 000000000..9ae54a400 --- /dev/null +++ b/test/RestSharp.Tests.Shared/Server/Models.cs @@ -0,0 +1,11 @@ +namespace RestSharp.Tests.Shared.Server; + +public record TestServerResponse(string Name, string Value); + +public record UploadResponse(string FileName, long Length, bool Equal); + +public record SuccessResponse(string Message); + +public class TestResponse { + public string Message { get; set; } = null!; +} \ No newline at end of file diff --git a/test/RestSharp.Tests.Shared/Server/WireMockTestServer.cs b/test/RestSharp.Tests.Shared/Server/WireMockTestServer.cs new file mode 100644 index 000000000..1df67db33 --- /dev/null +++ b/test/RestSharp.Tests.Shared/Server/WireMockTestServer.cs @@ -0,0 +1,226 @@ +using System.Net; +using System.Text.Json; +using WireMock; +using WireMock.RequestBuilders; +using WireMock.ResponseBuilders; +using WireMock.Server; +using WireMock.Types; +using WireMock.Util; + +namespace RestSharp.Tests.Shared.Server; + +// ReSharper disable once ClassNeverInstantiated.Global +public class WireMockTestServer : WireMockServer { + public WireMockTestServer() : base(new() { Port = 0, UseHttp2 = false, UseSSL = false }) { + Given(Request.Create().WithPath("/echo")) + .RespondWith(Response.Create().WithCallback(EchoQuery)); + + Given(Request.Create().WithPath("/success").UsingGet()) + .RespondWith(Response.Create().WithBodyAsJson(new SuccessResponse("Works!"))); + + Given(Request.Create().WithPath("/delete").UsingDelete()) + .RespondWith(Response.Create().WithBodyAsJson(new SuccessResponse("Works!"))); + + Given(Request.Create().WithPath("/content")) + .RespondWith(Response.Create().WithCallback(EchoJsonBody)); + + Given(Request.Create().WithPath("/post/json").UsingPost()) + .RespondWith(Response.Create().WithCallback(WrapBody)); + + Given(Request.Create().WithPath("/post/data").UsingPost()) + .RespondWith(Response.Create().WithCallback(HandleForm)); + + Given(Request.Create().WithPath("/post/form").UsingPost()) + .RespondWith(Response.Create().WithCallback(WrapForm)); + + Given(Request.Create().WithPath("/timeout")) + .RespondWith(Response.Create().WithDelay(1000)); + + Given(Request.Create().WithPath("/redirect")) + .RespondWith(Response.Create().WithStatusCode(HttpStatusCode.Redirect).WithHeader("Location", "/success")); + + Given(Request.Create().WithPath("/status").UsingGet()) + .RespondWith(Response.Create().WithCallback(StatusCode)); + + Given(Request.Create().WithPath("/headers")) + .RespondWith(Response.Create().WithCallback(EchoHeaders)); + + Given(Request.Create().WithPath("/redirect-countdown")) + .RespondWith(Response.Create().WithCallback(RedirectCountdown)); + + Given(Request.Create().WithPath("/redirect-with-status")) + .RespondWith(Response.Create().WithCallback(RedirectWithStatus)); + + Given(Request.Create().WithPath("/echo-request")) + .RespondWith(Response.Create().WithCallback(EchoRequest)); + + Given(Request.Create().WithPath("/set-cookie-and-redirect").UsingGet()) + .RespondWith(Response.Create().WithCallback(SetCookieAndRedirect)); + + Given(Request.Create().WithPath("/echo-cookies").UsingGet()) + .RespondWith(Response.Create().WithCallback(EchoCookies)); + + Given(Request.Create().WithPath("/redirect-no-query")) + .RespondWith(Response.Create().WithCallback(_ => new ResponseMessage { + StatusCode = 302, + Headers = new Dictionary> { + ["Location"] = new("/echo-request") + } + })); + + Given(Request.Create().WithPath("/redirect-custom-status")) + .RespondWith(Response.Create().WithCallback(RedirectCustomStatus)); + } + + static ResponseMessage WrapForm(IRequestMessage request) { + var response = request.BodyData!.BodyAsFormUrlEncoded!["big_string"].Length; + return CreateJson(new SuccessResponse($"Works! Length: {response}")); + } + + static readonly JsonSerializerOptions JsonOptions = new() { + PropertyNamingPolicy = JsonNamingPolicy.CamelCase, + PropertyNameCaseInsensitive = true + }; + + static ResponseMessage HandleForm(IRequestMessage request) { + var result = request.BodyData!.BodyAsFormUrlEncoded!.Select(x => new TestServerResponse(x.Key, x.Value)); + return CreateJson(result); + } + + static ResponseMessage EchoQuery(IRequestMessage request) { + var query = request.Query!["msg"]; + var msg = query[0]; + + return new ResponseMessage { + BodyData = new BodyData { + DetectedBodyType = BodyType.String, + BodyAsString = msg + } + }; + } + + static ResponseMessage EchoHeaders(IRequestMessage request) { + var headers = request.Headers!.Select(x => new TestServerResponse(x.Key, x.Value.First())); + return CreateJson(headers); + } + + static ResponseMessage EchoJsonBody(IRequestMessage request) => CreateJson(request.BodyAsJson!); + + static ResponseMessage WrapBody(IRequestMessage request) { + var data = JsonSerializer.Deserialize(request.Body!, JsonOptions); + return CreateJson(new TestResponse { Message = data?.Data ?? "" }); + } + + static ResponseMessage StatusCode(IRequestMessage request) { + var query = request.Query!["code"]; + var statusCode = int.Parse(query[0]); + + return new ResponseMessage { + StatusCode = statusCode + }; + } + + static ResponseMessage RedirectCountdown(IRequestMessage request) { + var n = 1; + + if (request.Query != null && request.Query.TryGetValue("n", out var nValues)) { + n = int.Parse(nValues[0]); + } + + if (n <= 1) { + return CreateJson(new SuccessResponse("Done!")); + } + + return new ResponseMessage { + StatusCode = (int)HttpStatusCode.TemporaryRedirect, + Headers = new Dictionary> { + ["Location"] = new($"/redirect-countdown?n={n - 1}") + } + }; + } + + static ResponseMessage RedirectWithStatus(IRequestMessage request) { + var status = 302; + var url = "/echo-request"; + + if (request.Query != null) { + if (request.Query.TryGetValue("status", out var statusValues)) { + status = int.Parse(statusValues[0]); + } + + if (request.Query.TryGetValue("url", out var urlValues)) { + url = urlValues[0]; + } + } + + return new ResponseMessage { + StatusCode = status, + Headers = new Dictionary> { + ["Location"] = new(url) + } + }; + } + + public static ResponseMessage EchoRequest(IRequestMessage request) { + var headers = request.Headers? + .ToDictionary(x => x.Key, x => string.Join(", ", x.Value)) + ?? new Dictionary(); + + return CreateJson(new { + Method = request.Method, + Headers = headers, + Body = request.Body ?? "" + }); + } + + static ResponseMessage SetCookieAndRedirect(IRequestMessage request) { + var url = "/echo-cookies"; + if (request.Query != null && request.Query.TryGetValue("url", out var urlValues)) + url = urlValues[0]; + + return new ResponseMessage { + StatusCode = 302, + Headers = new Dictionary> { + ["Location"] = new(url), + ["Set-Cookie"] = new("redirectCookie=value1; Path=/") + } + }; + } + + static ResponseMessage EchoCookies(IRequestMessage request) { + var cookieHeaders = new List(); + if (request.Headers != null && request.Headers.TryGetValue("Cookie", out var values)) + cookieHeaders.AddRange(values); + + var parsedCookies = request.Cookies?.Select(x => $"{x.Key}={x.Value}").ToList() + ?? new List(); + + return CreateJson(new { + RawCookieHeaders = cookieHeaders, + ParsedCookies = parsedCookies + }); + } + + static ResponseMessage RedirectCustomStatus(IRequestMessage request) { + var status = 399; + if (request.Query != null && request.Query.TryGetValue("status", out var statusValues)) + status = int.Parse(statusValues[0]); + + return new ResponseMessage { + StatusCode = status, + Headers = new Dictionary> { + ["Location"] = new("/echo-request") + } + }; + } + + public static ResponseMessage CreateJson(object response) + => new() { + BodyData = new BodyData { + BodyAsJson = response, + DetectedBodyType = BodyType.Json + } + }; +} + +public record TestRequest(string Data, int Number); \ No newline at end of file diff --git a/test/RestSharp.Tests/Auth/AuthenticatorTests.cs b/test/RestSharp.Tests/Auth/AuthenticatorTests.cs new file mode 100644 index 000000000..4129a76a6 --- /dev/null +++ b/test/RestSharp.Tests/Auth/AuthenticatorTests.cs @@ -0,0 +1,42 @@ +using System.Net; +using RestSharp.Authenticators; +using RestSharp.Tests.Fixtures; +using RichardSzalay.MockHttp; + +namespace RestSharp.Tests.Auth; + +public class AuthenticatorTests { + [Fact] + public async Task Should_add_authorization_header() { + const string auth = "LetMeIn"; + + using var client = MockHttpClient.Create( + Method.Get, + request => request.WithHeaders(KnownHeaders.Authorization, auth).Respond(HttpStatusCode.OK), + opt => opt.Authenticator = new TestAuthenticator(ParameterType.HttpHeader, KnownHeaders.Authorization, auth) + ); + var response = await client.ExecuteGetAsync(new RestRequest()); + response.StatusCode.Should().Be(HttpStatusCode.OK); + } + + [Fact] + public async Task Should_add_authorization_form_parameter() { + const string auth = "LetMeIn"; + const string formField = "token"; + + using var client = MockHttpClient.Create( + Method.Post, + request => request.WithFormData(formField, auth).Respond(HttpStatusCode.OK), + opt => opt.Authenticator = new TestAuthenticator(ParameterType.GetOrPost, formField, auth) + ); + var response = await client.ExecutePostAsync(new RestRequest()); + response.StatusCode.Should().Be(HttpStatusCode.OK); + } + + class TestAuthenticator(ParameterType type, string name, string value) : IAuthenticator { + public ValueTask Authenticate(IRestClient client, RestRequest request) { + request.AddParameter(name, value, type); + return default; + } + } +} \ No newline at end of file diff --git a/test/RestSharp.Tests/Auth/HttpBasicAuthTests.cs b/test/RestSharp.Tests/Auth/HttpBasicAuthTests.cs new file mode 100644 index 000000000..a8f3ea3ef --- /dev/null +++ b/test/RestSharp.Tests/Auth/HttpBasicAuthTests.cs @@ -0,0 +1,27 @@ +using System.Text; +using RestSharp.Authenticators; + +namespace RestSharp.Tests.Auth; + +public class HttpBasicAuthTests { + const string Username = "username"; + const string Password = "password"; + + readonly HttpBasicAuthenticator _auth = new(Username, Password); + + [Fact] + public async Task Authenticate_ShouldAddAuthorizationParameter_IfPreviouslyUnassigned() { + // Arrange + using var client = new RestClient(); + + var request = new RestRequest(); + request.AddQueryParameter("NotMatching", "", default); + var expectedToken = $"Basic {Convert.ToBase64String(Encoding.UTF8.GetBytes($"{Username}:{Password}"))}"; + + // Act + await _auth.Authenticate(client, request); + + // Assert + request.Parameters.Single(x => x.Name == KnownHeaders.Authorization).Value.Should().Be(expectedToken); + } +} \ No newline at end of file diff --git a/test/RestSharp.Tests/Auth/JwtAuthTests.cs b/test/RestSharp.Tests/Auth/JwtAuthTests.cs new file mode 100644 index 000000000..484d841ed --- /dev/null +++ b/test/RestSharp.Tests/Auth/JwtAuthTests.cs @@ -0,0 +1,124 @@ +using System.Globalization; +using RestSharp.Authenticators; + +namespace RestSharp.Tests.Auth; + +public class JwtAuthTests { + readonly string _testJwt; + readonly string _expectedAuthHeaderContent; + + public JwtAuthTests() { + Thread.CurrentThread.CurrentCulture = CultureInfo.InvariantCulture; + Thread.CurrentThread.CurrentUICulture = CultureInfo.InstalledUICulture; + + _testJwt = "eyJ0eXAiOiJKV1QiLA0KICJhbGciOiJIUzI1NiJ9" + + "." + + "eyJpc3MiOiJqb2UiLA0KICJleHAiOjEzMDA4MTkzODAsDQo" + + "gImh0dHA6Ly9leGFtcGxlLmNvbS9pc19yb290Ijp0cnVlfQ" + + "." + + "dBjftJeZ4CVP-mB92K27uhbUJU1p1r_wW1gFWFOEjXk"; + + _expectedAuthHeaderContent = $"Bearer {_testJwt}"; + } + + [Fact] + public async Task Can_Set_ValidFormat_Auth_Header() { + using var client = new RestClient(new RestClientOptions { Authenticator = new JwtAuthenticator(_testJwt) }); + + var request = new RestRequest(); + //In real case client.Execute(request) will invoke Authenticate method + await client.Options.Authenticator!.Authenticate(client, request); + + var authParam = request.Parameters.Single(p => p.Name!.Equals(KnownHeaders.Authorization, StringComparison.OrdinalIgnoreCase)); + + Assert.Equal(ParameterType.HttpHeader, authParam.Type); + Assert.Equal(_expectedAuthHeaderContent, authParam.Value); + } + + [Fact] + public async Task Can_Set_ValidFormat_Auth_Header_With_Bearer_Prefix() { + using var client = new RestClient(new RestClientOptions { Authenticator = new JwtAuthenticator($"Bearer {_testJwt}") }); + + var request = new RestRequest(); + //In real case client.Execute(request) will invoke Authenticate method + await client.Options.Authenticator!.Authenticate(client, request); + + var authParam = request.Parameters.Single(p => p.Name!.Equals(KnownHeaders.Authorization, StringComparison.OrdinalIgnoreCase)); + + Assert.Equal(ParameterType.HttpHeader, authParam.Type); + Assert.Equal(_expectedAuthHeaderContent, authParam.Value); + } + + [Fact] + public async Task Check_Only_Header_Authorization() { + using var client = new RestClient(new RestClientOptions { Authenticator = new JwtAuthenticator(_testJwt) }); + + var request = new RestRequest(); + // Paranoid server needs "two-factor authentication": JWT header and query param key for example + request.AddParameter(KnownHeaders.Authorization, "manualAuth", ParameterType.QueryString); + + // In real case client.Execute(request) will invoke Authenticate method + await client.Options.Authenticator!.Authenticate(client, request); + + var paramList = request.Parameters.Where(p => p.Name!.Equals(KnownHeaders.Authorization)).ToList(); + + Assert.Equal(2, paramList.Count); + + var queryAuthParam = paramList.Single(p => p.Type.Equals(ParameterType.QueryString)); + var headerAuthParam = paramList.Single(p => p.Type.Equals(ParameterType.HttpHeader)); + + Assert.Equal("manualAuth", queryAuthParam.Value); + Assert.Equal(_expectedAuthHeaderContent, headerAuthParam.Value); + } + + [Fact] + public async Task Set_Auth_Header_Only_Once() { + using var client = new RestClient(new RestClientOptions { Authenticator = new JwtAuthenticator(_testJwt) }); + + var request = new RestRequest(); + request.AddHeader(KnownHeaders.Authorization, "second_header_auth_token"); + + //In real case client.Execute(...) will invoke Authenticate method + await client.Options.Authenticator!.Authenticate(client, request); + + var paramList = request.Parameters.Where(p => p.Name.Equals(KnownHeaders.Authorization)).ToList(); + + paramList.Should().HaveCount(1); + + var authParam = paramList[0]; + + Assert.Equal(ParameterType.HttpHeader, authParam.Type); + Assert.Equal(_expectedAuthHeaderContent, authParam.Value); + Assert.NotEqual("Bearer second_header_auth_token", authParam.Value); + } + + [Fact] + public async Task Updates_Auth_Header() { + var request = new RestRequest(); + + var authenticator = new JwtAuthenticator(_expectedAuthHeaderContent); + + using var client = new RestClient(new RestClientOptions { Authenticator = authenticator }); + await client.Options.Authenticator!.Authenticate(client, request); + + authenticator.SetBearerToken("second_header_auth_token"); + await client.Options.Authenticator.Authenticate(client, request); + + var paramList = request.Parameters.Where(p => p.Name.Equals(KnownHeaders.Authorization)).ToList(); + + Assert.Single(paramList); + + var authParam = paramList[0]; + + Assert.Equal(ParameterType.HttpHeader, authParam.Type); + Assert.NotEqual(_expectedAuthHeaderContent, authParam.Value); + Assert.Equal("Bearer second_header_auth_token", authParam.Value); + } + + [Fact] + public void Throw_Argument_Null_Exception() { + var exception = Assert.Throws(() => new JwtAuthenticator(null!)); + + Assert.Equal("accessToken", exception.ParamName); + } +} \ No newline at end of file diff --git a/test/RestSharp.Tests/Auth/OAuth1AuthTests.cs b/test/RestSharp.Tests/Auth/OAuth1AuthTests.cs new file mode 100644 index 000000000..22cf3e1b9 --- /dev/null +++ b/test/RestSharp.Tests/Auth/OAuth1AuthTests.cs @@ -0,0 +1,167 @@ +using RestSharp.Authenticators; +using RestSharp.Authenticators.OAuth; + +namespace RestSharp.Tests.Auth; + +public class OAuth1AuthTests { + readonly OAuth1Authenticator _auth = new() { + CallbackUrl = "CallbackUrl", + ClientPassword = "ClientPassword", + Type = OAuthType.ClientAuthentication, + ClientUsername = "ClientUsername", + ConsumerKey = "ConsumerKey", + ConsumerSecret = "ConsumerSecret", + Realm = "Realm", + SessionHandle = "SessionHandle", + SignatureMethod = OAuthSignatureMethod.PlainText, + SignatureTreatment = OAuthSignatureTreatment.Escaped, + Token = "Token", + TokenSecret = "TokenSecret", + Verifier = "Verifier", + Version = "Version" + }; + + [Fact] + public void Authenticate_ShouldAddAuthorizationAsTextValueToRequest_OnHttpAuthorizationHeaderHandling() { + // Arrange + const string url = "https://no-query.string"; + + using var client = new RestClient(url); + var request = new RestRequest(); + + _auth.ParameterHandling = OAuthParameterHandling.HttpAuthorizationHeader; + + // Act + _auth.Authenticate(client, request); + + // Assert + var authParameter = request.Parameters.Single(x => x.Name == KnownHeaders.Authorization); + var value = (string)authParameter.Value; + + Assert.Contains("OAuth", value); + Assert.Contains("realm=\"Realm\"", value); + Assert.Contains("oauth_timestamp=", value); + Assert.Contains("oauth_signature=\"ConsumerSecret", value); + Assert.Contains("oauth_nonce=", value); + Assert.Contains("oauth_consumer_key=\"ConsumerKey\"", value); + Assert.Contains("oauth_signature_method=\"PLAINTEXT\"", value); + Assert.Contains("oauth_version=\"Version\"", value); + Assert.Contains("x_auth_mode=\"client_auth\"", value); + Assert.Contains("x_auth_username=\"ClientUsername\"", value); + Assert.Contains("x_auth_password=\"ClientPassword\"", value); + } + + [Fact] + public void Authenticate_ShouldAddSignatureToRequestAsSeparateParameters_OnUrlOrPostParametersHandling() { + // Arrange + const string url = "https://no-query.string"; + + using var client = new RestClient(url); + var request = new RestRequest(); + request.AddQueryParameter("queryparameter", "foobartemp"); + + _auth.ParameterHandling = OAuthParameterHandling.UrlOrPostParameters; + + // Act + _auth.Authenticate(client, request); + + // Assert + var parameters = request.Parameters; + ParameterShouldBe("x_auth_username", "ClientUsername"); + ParameterShouldBe("x_auth_password", "ClientPassword"); + ParameterShouldBe("x_auth_mode", "client_auth"); + ParameterShouldBe("oauth_consumer_key", "ConsumerKey"); + ParameterShouldHaveValue("oauth_signature"); + ParameterShouldBe("oauth_signature_method", "PLAINTEXT"); + ParameterShouldBe("oauth_version", "Version"); + ParameterShouldHaveValue("oauth_nonce"); + ParameterShouldHaveValue("oauth_timestamp"); + return; + + void ParameterShould(string name, Func check) { + var parameter = parameters.FirstOrDefault(x => x.Type == ParameterType.GetOrPost && x.Name == name); + parameter.Should().NotBeNull(); + check(parameter).Should().BeTrue(); + } + + void ParameterShouldBe(string name, string value) => ParameterShould(name, x => (string)x.Value == value); + + void ParameterShouldHaveValue(string name) => ParameterShould(name, x => !string.IsNullOrWhiteSpace((string)x.Value)); + } + + [Theory] + [InlineData(OAuthType.AccessToken, "Token", "Token")] + [InlineData(OAuthType.ProtectedResource, "Token", "Token")] + [InlineData(OAuthType.AccessToken, "SVyDD+RsFzSoZChk=", "SVyDD%2BRsFzSoZChk%3D")] + [InlineData(OAuthType.ProtectedResource, "SVyDD+RsFzSoZChk=", "SVyDD%2BRsFzSoZChk%3D")] + public void Authenticate_ShouldEncodeOAuthTokenParameter(OAuthType type, string value, string expected) { + // Arrange + const string url = "https://no-query.string"; + + using var client = new RestClient(url); + var request = new RestRequest(); + _auth.Type = type; + _auth.Token = value; + + // Act + _auth.Authenticate(client, request); + + // Assert + var authParameter = request.Parameters.Single(x => x.Name == KnownHeaders.Authorization); + var authHeader = (string)authParameter.Value; + + Assert.NotNull(authHeader); + Assert.Contains($"oauth_token=\"{expected}\"", authHeader); + } + + /// + /// According to the specifications of OAuth 1.0a, the customer secret is not required. + /// For more information, check the section 4 on https://oauth.net/core/1.0a/. + /// + [Theory] + [InlineData(OAuthType.AccessToken)] + [InlineData(OAuthType.ProtectedResource)] + public void Authenticate_ShouldAllowEmptyConsumerSecret_OnHttpAuthorizationHeaderHandling(OAuthType type) { + // Arrange + const string url = "https://no-query.string"; + + using var client = new RestClient(url); + var request = new RestRequest(); + _auth.Type = type; + _auth.ConsumerSecret = null; + + // Act + _auth.Authenticate(client, request); + + // Assert + var authParameter = request.Parameters.Single(x => x.Name == KnownHeaders.Authorization); + var value = (string)authParameter.Value; + + Assert.NotNull(value); + Assert.NotEmpty(value); + Assert.Contains("OAuth", value!); + Assert.Contains($"oauth_signature=\"{OAuthTools.UrlEncodeStrict("&")}", value); + } + + [Fact] + public async Task Authenticate_ShouldUriEncodeConsumerKey_OnHttpAuthorizationHeaderHandling() { + // Arrange + const string url = "https://no-query.string"; + + var client = new RestClient(url); + var request = new RestRequest(); + _auth.Type = OAuthType.ProtectedResource; + _auth.ConsumerKey = "my@consumer!key"; + _auth.ConsumerSecret = null; + + // Act + await _auth.Authenticate(client, request); + + // Assert + var authParameter = request.Parameters.Single(x => x.Name == KnownHeaders.Authorization); + var value = (string)authParameter.Value; + + value.Should().Contain("OAuth"); + value.Should().Contain("oauth_consumer_key=\"my%40consumer%21key"); + } +} \ No newline at end of file diff --git a/test/RestSharp.Tests/Auth/OAuth1SignatureTests.cs b/test/RestSharp.Tests/Auth/OAuth1SignatureTests.cs new file mode 100644 index 000000000..ee018dc5c --- /dev/null +++ b/test/RestSharp.Tests/Auth/OAuth1SignatureTests.cs @@ -0,0 +1,123 @@ +using RestSharp.Authenticators; +using RestSharp.Authenticators.OAuth; + +namespace RestSharp.Tests.Auth; + +public class OAuth1SignatureTests { + readonly OAuthWorkflow _workflow = new() { + ParameterHandling = OAuthParameterHandling.UrlOrPostParameters, + Token = "370773112-GmHxMAgYyLbNEtIKZeRNFsMKPR9EyMZeS9weJAEb", + TokenSecret = "LswwdoUaIvS8ltyTt5jkRh4J50vUPVVHtR2YPi5kE", + ConsumerKey = "xvz1evFS4wEEPTGEFPHBog", + ConsumerSecret = "kAcSOqF21Fu85e7zjz7ZN2U4ZRhfV3WpwPAoE3Z7kBw", + SignatureMethod = OAuthSignatureMethod.HmacSha1, + Version = "1.0", + GetNonce = () => "kYjzVBB8Y0ZFabxSWbWovY3uYSQ2pTgmZeNu2VS4cg", + GetTimestamp = () => "1318622958" + }; + + readonly RestClient _client = new("https://api.twitter.com/1.1"); + + readonly RestRequest _request = new RestRequest("statuses/update.json", Method.Post) + .AddParameter("status", "Hello Ladies + Gentlemen, a signed OAuth request!") + .AddParameter("include_entities", "true"); + + [Fact] + public void Adds_correct_signature() { + OAuth1Authenticator.AddOAuthData(_client, _request, _workflow, OAuthType.ProtectedResource, null); + + var signature = _request.Parameters.First(x => x.Name == "oauth_signature").Value; + signature.Should().Be("hCtSmYh+iHYCEqBWrE7C7hYmtUk="); + } + + [Fact] + public void Generates_correct_signature_base() { + const string method = "POST"; + + var requestParameters = _request.Parameters.ToWebParameters().ToArray(); + var parameters = new WebPairCollection(); + parameters.AddRange(requestParameters); + var url = _client.BuildUriString(_request); + _workflow.RequestUrl = url; + var oauthParameters = _workflow.BuildProtectedResourceSignature(method, parameters); + oauthParameters.Parameters.AddRange(requestParameters); + + var signatureBase = OAuthTools.ConcatenateRequestElements(method, url, oauthParameters.Parameters); + + signatureBase.Should() + .Be( + "POST&https%3A%2F%2Fapi.twitter.com%2F1.1%2Fstatuses%2Fupdate.json&include_entities%3Dtrue%26oauth_consumer_key%3Dxvz1evFS4wEEPTGEFPHBog%26oauth_nonce%3DkYjzVBB8Y0ZFabxSWbWovY3uYSQ2pTgmZeNu2VS4cg%26oauth_signature_method%3DHMAC-SHA1%26oauth_timestamp%3D1318622958%26oauth_token%3D370773112-GmHxMAgYyLbNEtIKZeRNFsMKPR9EyMZeS9weJAEb%26oauth_version%3D1.0%26status%3DHello%2520Ladies%2520%252B%2520Gentlemen%252C%2520a%2520signed%2520OAuth%2520request%2521" + ); + } + + [Fact] + public void Handles_path_with_exclamation_mark() { + // Test that a path segment with ! is encoded correctly in the signature base + var client = new RestClient("https://api.example.com"); + var request = new RestRequest("path/with!exclamation/resource", Method.Get); + + const string method = "GET"; + var url = client.BuildUri(request).ToString(); + var parameters = new WebPairCollection(); + + _workflow.RequestUrl = url; + var oauthParameters = _workflow.BuildProtectedResourceSignature(method, parameters); + + var signatureBase = OAuthTools.ConcatenateRequestElements(method, url, oauthParameters.Parameters); + + // The URL should be encoded with ! as %21 in the signature base + signatureBase.Should().Contain("path%2Fwith%21exclamation%2Fresource"); + } + + [Theory] + [InlineData("path/with!exclamation", "%21")] + [InlineData("path/with*asterisk", "%2A")] + [InlineData("path/with'apostrophe", "%27")] + [InlineData("path/with(paren", "%28")] + [InlineData("path/with)paren", "%29")] + public void Encodes_RFC3986_special_chars_in_path(string path, string encodedChar) { + // Test that RFC 3986 special characters are properly encoded in path segments + var client = new RestClient("https://api.example.com"); + var request = new RestRequest(path, Method.Get); + + const string method = "GET"; + var url = client.BuildUri(request).ToString(); + var parameters = new WebPairCollection(); + + _workflow.RequestUrl = url; + var oauthParameters = _workflow.BuildProtectedResourceSignature(method, parameters); + + var signatureBase = OAuthTools.ConcatenateRequestElements(method, url, oauthParameters.Parameters); + + // The URL should contain the encoded character in the signature base + signatureBase.Should().Contain(encodedChar); + } + + [Theory] + [InlineData("with!exclamation")] + [InlineData("with*asterisk")] + [InlineData("with'apostrophe")] + [InlineData("with(paren")] + [InlineData("with)paren")] + public void Handles_url_segment_with_RFC3986_special_chars(string segmentValue) { + // Test that URL segment parameters with RFC 3986 special characters don't get double-encoded + var client = new RestClient("https://api.example.com"); + var request = new RestRequest("path/{segment}/resource", Method.Get); + request.AddUrlSegment("segment", segmentValue); + + const string method = "GET"; + var url = client.BuildUri(request).ToString(); + var parameters = new WebPairCollection(); + + _workflow.RequestUrl = url; + var oauthParameters = _workflow.BuildProtectedResourceSignature(method, parameters); + + var signatureBase = OAuthTools.ConcatenateRequestElements(method, url, oauthParameters.Parameters); + + // The signature base should NOT contain double-encoded characters like %2521 (which is %25 + 21) + signatureBase.Should().NotContain("%25"); + + // But it should contain properly encoded special chars + signatureBase.Should().MatchRegex("%2[0-9A-F]"); + } +} \ No newline at end of file diff --git a/test/RestSharp.Tests/Auth/OAuth1Tests.cs b/test/RestSharp.Tests/Auth/OAuth1Tests.cs new file mode 100644 index 000000000..8f4356cf6 --- /dev/null +++ b/test/RestSharp.Tests/Auth/OAuth1Tests.cs @@ -0,0 +1,87 @@ +using System.Xml.Serialization; +using RestSharp.Authenticators; +using RestSharp.Authenticators.OAuth; +using RestSharp.Tests.Shared.Extensions; + +#pragma warning disable CS8618 + +namespace RestSharp.Tests.Auth; + +public class OAuth1Tests { + [XmlRoot("queue")] + class Queue { + [XmlElement("etag")] + public string Etag { get; set; } + + public List Items { get; set; } + } + + [XmlRoot("queue_item")] + class QueueItem { + [XmlElement("id")] + public string Id { get; set; } + + [XmlElement("position")] + public int Position { get; set; } + } + + [Fact] + public async Task Can_Authenticate_OAuth1_With_Querystring_Parameters() { + const string consumerKey = "enterConsumerKeyHere"; + const string consumerSecret = "enterConsumerSecretHere"; + const string baseUrl = "http://restsharp.org"; + + var expected = new List { + "oauth_consumer_key", + "oauth_nonce", + "oauth_signature_method", + "oauth_timestamp", + "oauth_version", + "oauth_signature" + }; + + using var client = new RestClient(baseUrl); + var request = new RestRequest(); + var authenticator = OAuth1Authenticator.ForRequestToken(consumerKey, consumerSecret); + authenticator.ParameterHandling = OAuthParameterHandling.UrlOrPostParameters; + await authenticator.Authenticate(client, request); + + var requestUri = new Uri(client.BuildUriString(request)); + var actual = requestUri.ParseQuery().Select(x => x.Key).ToList(); + + actual.Should().BeEquivalentTo(expected); + } + + [Theory] + [MemberData(nameof(EncodeParametersTestData))] + public void Properly_Encodes_Parameter_Names(IList<(string, string)> parameters, string expected) { + var postData = new WebPairCollection(); + postData.AddRange(parameters.Select(x => new WebPair(x.Item1, x.Item2))); + var sortedParams = OAuthTools.SortParametersExcludingSignature(postData); + + sortedParams.First().Should().Be(expected); + } + + public static IEnumerable EncodeParametersTestData => new List { + new object[] { + new List<(string, string)> { ("name[first]", "Chuck"), ("name[last]", "Testa") }, + "name%5Bfirst%5D=Chuck" + }, + new object[] { + new List<(string, string)> { ("country", "España") }, + "country=Espa%C3%B1a" + } + }; + + [Fact] + public void Encodes_parameter() { + var parameter = new WebPair("status", "Hello Ladies + Gentlemen, a signed OAuth request!"); + var parameters = new WebPairCollection { parameter }; + + const string expected = "status%3DHello%2520Ladies%2520%252B%2520Gentlemen%252C%2520a%2520signed%2520OAuth%2520request%2521"; + + var norm = OAuthTools.NormalizeRequestParameters(parameters); + var escaped = OAuthTools.UrlEncodeRelaxed(norm); + escaped.Should().Be(expected); + } +} \ No newline at end of file diff --git a/test/RestSharp.Tests/Auth/OAuthTests.cs b/test/RestSharp.Tests/Auth/OAuthTests.cs new file mode 100644 index 000000000..94e41010d --- /dev/null +++ b/test/RestSharp.Tests/Auth/OAuthTests.cs @@ -0,0 +1,95 @@ +using System.Globalization; +using System.Security.Cryptography; +using RestSharp.Authenticators.OAuth; +using RestSharp.Authenticators.OAuth.Extensions; + +namespace RestSharp.Tests.Auth; + +public class OAuthTests { + public OAuthTests() { + Thread.CurrentThread.CurrentCulture = CultureInfo.InvariantCulture; + Thread.CurrentThread.CurrentUICulture = CultureInfo.InstalledUICulture; + } + + [Fact] + public void HmacSha256_Does_Not_Accept_Nulls() { + const string consumerSecret = "12345678"; + + Assert.Throws( + () => OAuthTools.GetSignature(OAuthSignatureMethod.HmacSha256, null, consumerSecret) + ); + } + + [Theory] + [InlineData( + "The quick brown fox jumps over the lazy dog", + "rVL90tHhGt0eQ0TCITY74nVL22P%2FltlWS7WvJXpECPs%3D", + "12345678" + )] + [InlineData( + "The quick\tbrown\nfox\rjumps\r\nover\t\tthe\n\nlazy\r\n\r\ndog", + "C%2B2RY0Hna6VrfK1crCkU%2FV1e0ECoxoDh41iOOdmEMx8%3D", + "12345678" + )] + [InlineData("", "%2BnkCwZfv%2FQVmBbNZsPKbBT3kAg3JtVn3f3YMBtV83L8%3D", "12345678")] + [InlineData(" !\"#$%&'()*+,", "xcTgWGBVZaw%2Bilg6kjWAGt%2FhCcsVBMMe1CcDEnxnh8Y%3D", "12345678")] + [InlineData("AB", "JJgraAxzpO2Q6wiC3blM4eiQeA9WmkALaZI8yGRH4qM%3D", "CD!")] + public void HmacSha256_Hashes_Correctly(string value, string expected, string consumerSecret) { + var actual = OAuthTools.GetSignature(OAuthSignatureMethod.HmacSha256, value, consumerSecret); + + Assert.Equal(expected, actual); + } + + [Theory] + [InlineData("1234", "%31%32%33%34")] + [InlineData("\x00\x01\x02\x03", "%00%01%02%03")] + [InlineData("\r\n\t", "%0D%0A%09")] + public void PercentEncode_Encodes_Correctly(string value, string expected) { + var actual = value.PercentEncode(); + + Assert.Equal(expected, actual); + } + + [Theory] + [InlineData("The quick brown fox jumps over the lazy dog", 1024)] + [InlineData("The quick brown fox jumps over the lazy dog", 2048)] + [InlineData("The quick brown fox jumps over the lazy dog", 4096)] + [InlineData("", 2048)] + [InlineData(" !\"#$%&'()*+,", 2048)] + public void RsaSha1_Signs_Correctly(string value, int keySize) { + var hasher = SHA1.Create(); + var hash = hasher.ComputeHash(value.GetBytes()); + + using var crypto = new RSACryptoServiceProvider(keySize); + crypto.PersistKeyInCsp = false; + + var privateKey = crypto.ToXmlString(true); + + var signature = OAuthTools.GetSignature( + OAuthSignatureMethod.RsaSha1, + OAuthSignatureTreatment.Unescaped, + value, + privateKey + ); + + var signatureBytes = Convert.FromBase64String(signature); + + Assert.True(crypto.VerifyHash(hash, CryptoConfig.MapNameToOID("SHA1"), signatureBytes)); + } + + [Theory] + [InlineData("abcdefghijklmnopqrstuvwxyz", "abcdefghijklmnopqrstuvwxyz")] + [InlineData("ABCDEFGHIJKLMNOPQRSTUVWXYZ", "ABCDEFGHIJKLMNOPQRSTUVWXYZ")] + [InlineData("0123456789", "0123456789")] + [InlineData("-._~", "-._~")] + [InlineData(" !\"#$%&'()*+,", "%20%21%22%23%24%25%26%27%28%29%2A%2B%2C")] + [InlineData("%$%", "%25%24%25")] + [InlineData("%", "%25")] + [InlineData("/:;<=>?@", "%2F%3A%3B%3C%3D%3E%3F%40")] + [InlineData("\x00\x01\a\b\f\n\r\t\v", "%00%01%07%08%0C%0A%0D%09%0B")] + public void UrlStrictEncode_Encodes_Correctly(string value, string expected) { + var actual = OAuthTools.UrlEncodeStrict(value); + + Assert.Equal(expected, actual); + } +} \ No newline at end of file diff --git a/test/RestSharp.Tests/CredentialConfigurationTests.cs b/test/RestSharp.Tests/CredentialConfigurationTests.cs new file mode 100644 index 000000000..1528e4489 --- /dev/null +++ b/test/RestSharp.Tests/CredentialConfigurationTests.cs @@ -0,0 +1,44 @@ +using System.Net; + +namespace RestSharp.Tests; + +public class CredentialConfigurationTests { + [Fact] + public void Explicit_credentials_are_not_overwritten_by_UseDefaultCredentials() { + var credentials = new NetworkCredential("user", "password"); + var options = new RestClientOptions("https://dummy.org") { + Credentials = credentials, + UseDefaultCredentials = false + }; + + var handler = new HttpClientHandler(); + RestClient.ConfigureHttpMessageHandler(handler, options); + + handler.Credentials.Should().BeSameAs(credentials); + } + + [Fact] + public void DefaultCredentials_set_explicitly_are_not_overwritten() { + var options = new RestClientOptions("https://dummy.org") { + Credentials = CredentialCache.DefaultCredentials, + UseDefaultCredentials = false + }; + + var handler = new HttpClientHandler(); + RestClient.ConfigureHttpMessageHandler(handler, options); + + handler.Credentials.Should().BeSameAs(CredentialCache.DefaultCredentials); + } + + [Fact] + public void UseDefaultCredentials_sets_credentials_when_no_explicit_credentials() { + var options = new RestClientOptions("https://dummy.org") { + UseDefaultCredentials = true + }; + + var handler = new HttpClientHandler(); + RestClient.ConfigureHttpMessageHandler(handler, options); + + handler.UseDefaultCredentials.Should().BeTrue(); + } +} diff --git a/test/RestSharp.Tests/ErrorMessageTests.cs b/test/RestSharp.Tests/ErrorMessageTests.cs new file mode 100644 index 000000000..811f23445 --- /dev/null +++ b/test/RestSharp.Tests/ErrorMessageTests.cs @@ -0,0 +1,43 @@ +using System.Security.Authentication; + +namespace RestSharp.Tests; + +public class ErrorMessageTests { + [Fact] + public async Task ErrorMessage_surfaces_innermost_exception_message() { + const string innerMessage = "The remote certificate is invalid according to the validation procedure."; + + var innerException = new AuthenticationException(innerMessage); + var wrappedException = new HttpRequestException("An error occurred while sending the request.", innerException); + + var handler = new FakeHandler(wrappedException); + var client = new RestClient(new RestClientOptions("https://dummy.org") { ConfigureMessageHandler = _ => handler }); + + var response = await client.ExecuteAsync(new RestRequest("/")); + + response.ErrorMessage.Should().Be(innerMessage); + response.ErrorException.Should().BeOfType(); + response.ErrorException!.InnerException.Should().BeOfType(); + response.ResponseStatus.Should().Be(ResponseStatus.Error); + } + + [Fact] + public async Task ErrorMessage_uses_direct_message_when_no_inner_exception() { + const string message = "No such host is known."; + + var exception = new HttpRequestException(message); + var handler = new FakeHandler(exception); + var client = new RestClient(new RestClientOptions("https://dummy.org") { ConfigureMessageHandler = _ => handler }); + + var response = await client.ExecuteAsync(new RestRequest("/")); + + response.ErrorMessage.Should().Be(message); + response.ErrorException.Should().BeOfType(); + response.ErrorException!.InnerException.Should().BeNull(); + } + + class FakeHandler(Exception exception) : HttpMessageHandler { + protected override Task SendAsync(HttpRequestMessage request, CancellationToken cancellationToken) + => throw exception; + } +} diff --git a/test/RestSharp.Tests/Fixtures/MockHttpClient.cs b/test/RestSharp.Tests/Fixtures/MockHttpClient.cs new file mode 100644 index 000000000..4de8c1a24 --- /dev/null +++ b/test/RestSharp.Tests/Fixtures/MockHttpClient.cs @@ -0,0 +1,18 @@ +using RichardSzalay.MockHttp; + +namespace RestSharp.Tests.Fixtures; + +public static class MockHttpClient { + const string Url = "https://dummy.org"; + + public static RestClient Create(Method method, Func configureHandler, ConfigureRestClient configure = null) { + var mockHttp = new MockHttpMessageHandler(); + configureHandler(mockHttp.When(RestClient.AsHttpMethod(method), Url)); + + var options = new RestClientOptions(Url) { + ConfigureMessageHandler = _ => mockHttp + }; + configure?.Invoke(options); + return new RestClient(options); + } +} \ No newline at end of file diff --git a/test/RestSharp.Tests/Headers/DefaultHeaderTests.cs b/test/RestSharp.Tests/Headers/DefaultHeaderTests.cs new file mode 100644 index 000000000..dd1e69c42 --- /dev/null +++ b/test/RestSharp.Tests/Headers/DefaultHeaderTests.cs @@ -0,0 +1,23 @@ +namespace RestSharp.Tests.Headers; + +public class DefaultHeaderTests { + const string BaseUrl = "http://localhost:8888/"; + + [Fact] + public void AddDefaultHeadersUsingDictionary() { + var headers = new Dictionary { + { KnownHeaders.ContentType, ContentType.Json }, + { KnownHeaders.Accept, ContentType.Json }, + { KnownHeaders.ContentEncoding, "gzip, deflate" } + }; + + var expected = headers.Select(x => new HeaderParameter(x.Key, x.Value)); + + using var client = new RestClient(BaseUrl); + client.AddDefaultHeaders(headers); + + var actual = client.DefaultParameters.Select(x => x as HeaderParameter); + expected.Should().BeSubsetOf(actual); + } + +} \ No newline at end of file diff --git a/test/RestSharp.Tests/Headers/HeaderRangeTests.cs b/test/RestSharp.Tests/Headers/HeaderRangeTests.cs new file mode 100644 index 000000000..ccedaa280 --- /dev/null +++ b/test/RestSharp.Tests/Headers/HeaderRangeTests.cs @@ -0,0 +1,23 @@ +namespace RestSharp.Tests.Parameters; + +public class HeaderRangeTests { + [Fact] + public async Task ShouldParseOutLongRangeSpecifier() { + using var restClient = new RestClient("http://localhost"); + var req = new RestRequest("bob"); + const long start = (long)int.MaxValue + 1; + const long end = start + 1; + + req.AddHeader("Range", $"pages={start}-{end}"); + await restClient.ExecuteAsync(req); + } + + [Fact] + public async Task ShouldParseOutRangeSpecifier() { + using var restClient = new RestClient("http://localhost"); + var req = new RestRequest("bob"); + + req.AddHeader("Range", "pages=1-2"); + await restClient.ExecuteAsync(req); + } +} \ No newline at end of file diff --git a/test/RestSharp.Tests/Headers/HostHeaderTests.cs b/test/RestSharp.Tests/Headers/HostHeaderTests.cs new file mode 100644 index 000000000..4f16e6a12 --- /dev/null +++ b/test/RestSharp.Tests/Headers/HostHeaderTests.cs @@ -0,0 +1,50 @@ +namespace RestSharp.Tests; + +public class HostHeaderTests { + [Fact] + public void Cannot_Set_Empty_Host_Header() { + var request = new RestRequest(); + var exception = Assert.Throws(() => request.AddHeader("Host", string.Empty)); + + Assert.Equal("value", exception.ParamName); + } + + [Theory] + [InlineData("http://localhost")] + [InlineData("hostname 1234")] + [InlineData("-leading.hyphen.not.allowed")] + [InlineData("bad:port")] + [InlineData(" no.leading.white-space")] + [InlineData("no.trailing.white-space ")] + [InlineData(".leading.dot.not.allowed")] + [InlineData("double.dots..not.allowed")] + [InlineData(".")] + [InlineData(".:2345")] + [InlineData(":5678")] + [InlineData("")] + [InlineData("foo:bar:baz")] + public void Cannot_Set_Invalid_Host_Header(string value) { + var request = new RestRequest(); + var exception = Assert.Throws(() => request.AddHeader("Host", value)); + + Assert.Equal("value", exception.ParamName); + } + + [Theory] + [InlineData("localhost")] + [InlineData("localhost:1234")] + [InlineData("host.local")] + [InlineData("anotherhost.local:2345")] + [InlineData("www.w3.org")] + [InlineData("www.w3.org:3456")] + [InlineData("8.8.8.8")] + [InlineData("a.1.b.2")] + [InlineData("10.20.30.40:1234")] + [InlineData("0host")] + [InlineData("hypenated-hostname")] + [InlineData("multi--hyphens")] + public void Can_Set_Valid_Host_Header(string value) { + var request = new RestRequest(); + request.AddHeader("Host", value); + } +} \ No newline at end of file diff --git a/test/RestSharp.Tests/Headers/RequestHeaderTests.cs b/test/RestSharp.Tests/Headers/RequestHeaderTests.cs new file mode 100644 index 000000000..bf8bc4c4b --- /dev/null +++ b/test/RestSharp.Tests/Headers/RequestHeaderTests.cs @@ -0,0 +1,187 @@ +namespace RestSharp.Tests; + +public class RequestHeaderTests { + static readonly KeyValuePair AcceptHeader = new(KnownHeaders.Accept, ContentType.Json); + static readonly KeyValuePair AcceptLanguageHeader = new(KnownHeaders.AcceptLanguage, "en-us,en;q=0.5"); + static readonly KeyValuePair KeepAliveHeader = new(KnownHeaders.KeepAlive, "300"); + + readonly List> _headers = [AcceptHeader, AcceptLanguageHeader, KeepAliveHeader]; + + [Fact] + public void AddHeaders_SameCaseDuplicatesExist_ThrowsException() { + var headers = _headers; + _headers.Add(AcceptHeader); + + var request = new RestRequest(); + + var exception = Assert.Throws(() => request.AddHeaders(headers)); + Assert.Equal("Duplicate header names exist: ACCEPT", exception.Message); + } + + [Fact] + public void AddHeaders_DifferentCaseDuplicatesExist_ThrowsException() { + var headers = _headers; + headers.Add(new(KnownHeaders.Accept, ContentType.Json)); + + var request = new RestRequest(); + + var exception = Assert.Throws(() => request.AddHeaders(headers)); + Assert.Equal("Duplicate header names exist: ACCEPT", exception.Message); + } + + [Fact] + public void AddHeaders_NoDuplicatesExist_Has3Headers() { + var request = new RestRequest(); + request.AddHeaders(_headers); + + var httpParameters = GetHeaders(request); + Assert.Equal(3, httpParameters.Length); + } + + [Fact] + public void AddHeaders_NoDuplicatesExistUsingDictionary_Has3Headers() { + var headers = new Dictionary { + { KnownHeaders.Accept, ContentType.Json }, + { KnownHeaders.AcceptLanguage, "en-us,en;q=0.5" }, + { KnownHeaders.KeepAlive, "300" } + }; + + var request = new RestRequest(); + request.AddHeaders(headers); + + var httpParameters = GetHeaders(request); + Assert.Equal(3, httpParameters.Count()); + } + + [Fact] + public void AddOrUpdateHeader_ShouldUpdateExistingHeader_WhenHeaderExist() { + // Arrange + var request = new RestRequest(); + request.AddHeader(KnownHeaders.Accept, ContentType.Xml); + + // Act + request.AddOrUpdateHeader(KnownHeaders.Accept, ContentType.Json); + + // Assert + GetHeader(request, KnownHeaders.Accept).Should().Be(ContentType.Json); + } + + [Fact] + public void AddOrUpdateHeader_ShouldUpdateExistingHeader_WhenHeaderDoesNotExist() { + // Arrange + var request = new RestRequest(); + + // Act + request.AddOrUpdateHeader(KnownHeaders.Accept, ContentType.Json); + + // Assert + GetHeader(request, KnownHeaders.Accept).Should().Be(ContentType.Json); + } + + [Fact] + public void AddOrUpdateHeaders_ShouldAddHeaders_WhenNoneExists() { + // Arrange + var headers = new Dictionary { + { KnownHeaders.Accept, ContentType.Json }, + { KnownHeaders.AcceptLanguage, "en-us,en;q=0.5" }, + { KnownHeaders.KeepAlive, "300" } + }; + + var request = new RestRequest(); + + // Act + request.AddOrUpdateHeaders(headers); + + // Assert + var requestHeaders = GetHeaders(request); + + var expected = headers.Select(x => new HeaderParameter(x.Key, x.Value)); + expected.Should().BeEquivalentTo(requestHeaders); + } + + [Fact] + public void AddOrUpdateHeaders_ShouldUpdateHeaders_WhenAllExists() { + // Arrange + var headers = new Dictionary { + { KnownHeaders.Accept, ContentType.Json }, + { KnownHeaders.KeepAlive, "300" } + }; + + var updatedHeaders = new Dictionary { + { KnownHeaders.Accept, ContentType.Xml }, + { KnownHeaders.KeepAlive, "400" } + }; + + var request = new RestRequest(); + request.AddHeaders(headers); + + // Act + request.AddOrUpdateHeaders(updatedHeaders); + + // Assert + var requestHeaders = GetHeaders(request); + + HeaderParameter[] expected = [new(KnownHeaders.Accept, ContentType.Xml), new(KnownHeaders.KeepAlive, "400")]; + requestHeaders.Should().BeEquivalentTo(expected); + } + + [Fact] + public void AddOrUpdateHeaders_ShouldAddAndUpdateHeaders_WhenSomeExists() { + // Arrange + var headers = new Dictionary { + { KnownHeaders.Accept, ContentType.Json }, + { KnownHeaders.KeepAlive, "300" } + }; + + var updatedHeaders = new Dictionary { + { KnownHeaders.Accept, ContentType.Xml }, + { KnownHeaders.AcceptLanguage, "en-us,en;q=0.5" } + }; + + var request = new RestRequest(); + request.AddHeaders(headers); + + // Act + request.AddOrUpdateHeaders(updatedHeaders); + + // Assert + var requestHeaders = GetHeaders(request); + + HeaderParameter[] expected = [ + new(KnownHeaders.Accept, ContentType.Xml), + new(KnownHeaders.AcceptLanguage, "en-us,en;q=0.5"), + new(KnownHeaders.KeepAlive, "300") + ]; + requestHeaders.Should().BeEquivalentTo(expected); + } + + [Fact] + public void Should_not_allow_null_header_value() { + string value = null; + var request = new RestRequest(); + // ReSharper disable once AssignNullToNotNullAttribute + Assert.Throws("value", () => request.AddHeader("name", value)); + } + + [Fact] + public void Should_not_allow_null_header_name() { + var request = new RestRequest(); + Assert.Throws("name", () => request.AddHeader(null!, "value")); + } + + [Fact] + public void Should_not_allow_empty_header_name() { + var request = new RestRequest(); + Assert.Throws("name", () => request.AddHeader("", "value")); + } + + [Fact] + public void Should_not_allow_CRLF_in_header_value() { + var request = new RestRequest(); + Assert.Throws(() => request.AddHeader("name", "test\r\nUser-Agent: injected header!\r\n\r\nGET /smuggled HTTP/1.1\r\nHost: insert.some.site.here")); + } + + static Parameter[] GetHeaders(RestRequest request) => request.Parameters.Where(x => x.Type == ParameterType.HttpHeader).ToArray(); + + static string GetHeader(RestRequest request, string name) => request.Parameters.FirstOrDefault(x => x.Name == name)?.Value?.ToString(); +} \ No newline at end of file diff --git a/test/RestSharp.Tests/InvariantCultureTests.cs b/test/RestSharp.Tests/InvariantCultureTests.cs new file mode 100644 index 000000000..6816adae2 --- /dev/null +++ b/test/RestSharp.Tests/InvariantCultureTests.cs @@ -0,0 +1,98 @@ +using System.Globalization; + +namespace RestSharp.Tests; + +public class InvariantCultureTests { + [Fact] + public void AddParameter_uses_invariant_culture_for_double() { + var originalCulture = CultureInfo.CurrentCulture; + + try { + CultureInfo.CurrentCulture = new CultureInfo("da-DK"); + var request = new RestRequest().AddParameter("value", 1.234); + + var parameter = request.Parameters.FirstOrDefault(p => p.Name == "value"); + parameter.Should().NotBeNull(); + parameter!.Value.Should().Be("1.234"); + } + finally { + CultureInfo.CurrentCulture = originalCulture; + } + } + + [Fact] + public void AddParameter_can_use_specific_culture() { + var request = new RestRequest().AddParameter("value", 1.234, culture: new CultureInfo("da-DK")); + + var parameter = request.Parameters.FirstOrDefault(p => p.Name == "value"); + parameter.Should().NotBeNull(); + parameter!.Value.Should().Be("1,234"); + } + + [Fact] + public void AddOrUpdateParameter_uses_invariant_culture_for_double() { + var originalCulture = CultureInfo.CurrentCulture; + + try { + CultureInfo.CurrentCulture = new CultureInfo("da-DK"); + var request = new RestRequest().AddOrUpdateParameter("value", 1.234); + + var parameter = request.Parameters.FirstOrDefault(p => p.Name == "value"); + parameter.Should().NotBeNull(); + parameter!.Value.Should().Be("1.234"); + } + finally { + CultureInfo.CurrentCulture = originalCulture; + } + } + + [Fact] + public void AddQueryParameter_uses_invariant_culture_for_decimal() { + var originalCulture = CultureInfo.CurrentCulture; + + try { + CultureInfo.CurrentCulture = new CultureInfo("fr-FR"); + var request = new RestRequest().AddQueryParameter("price", 99.95m); + + var parameter = request.Parameters.FirstOrDefault(p => p.Name == "price"); + parameter.Should().NotBeNull(); + parameter!.Value.Should().Be("99.95"); + } + finally { + CultureInfo.CurrentCulture = originalCulture; + } + } + + [Fact] + public void AddUrlSegment_uses_invariant_culture_for_float() { + var originalCulture = CultureInfo.CurrentCulture; + + try { + CultureInfo.CurrentCulture = new CultureInfo("de-DE"); + var request = new RestRequest("{id}").AddUrlSegment("id", 3.14f); + + var parameter = request.Parameters.FirstOrDefault(p => p.Name == "id"); + parameter.Should().NotBeNull(); + parameter!.Value.Should().Be("3.14"); + } + finally { + CultureInfo.CurrentCulture = originalCulture; + } + } + + [Fact] + public void CreateParameter_uses_invariant_culture_for_object_value() { + var originalCulture = CultureInfo.CurrentCulture; + + try { + CultureInfo.CurrentCulture = new CultureInfo("da-DK"); + object value = 1.234; + var parameter = Parameter.CreateParameter("value", value, ParameterType.QueryString); + + parameter.Value.Should().Be("1.234"); + } + finally { + CultureInfo.CurrentCulture = originalCulture; + } + } +} diff --git a/test/RestSharp.Tests/MultipartFormTests.cs b/test/RestSharp.Tests/MultipartFormTests.cs new file mode 100644 index 000000000..3e6d555ec --- /dev/null +++ b/test/RestSharp.Tests/MultipartFormTests.cs @@ -0,0 +1,34 @@ +using System.Net; +using RestSharp.Tests.Fixtures; +using RichardSzalay.MockHttp; + +namespace RestSharp.Tests; + +public class MultipartFormTests { + [Fact] + public async Task ShouldHaveJsonContentType() { + var jsonData = new { + Company = "Microsoft", + ZipCode = "LS339", + Country = "USA" + }; + + using var client = MockHttpClient.Create(Method.Post, req => req.With(CheckRequest).Respond(HttpStatusCode.OK)); + + var request = new RestRequest { + Method = Method.Post, + AlwaysMultipartFormData = true + }; + request.AddJsonBody(jsonData); + + var response = await client.ExecuteAsync(request); + response.StatusCode.Should().Be(HttpStatusCode.OK); + return; + + bool CheckRequest(HttpRequestMessage msg) { + if (msg.Content is not MultipartFormDataContent formDataContent) return false; + + return formDataContent.First().Headers.ContentType!.MediaType == ContentType.Json; + } + } +} diff --git a/test/RestSharp.Tests/ObjectParserTests.cs b/test/RestSharp.Tests/ObjectParserTests.cs new file mode 100644 index 000000000..769493a86 --- /dev/null +++ b/test/RestSharp.Tests/ObjectParserTests.cs @@ -0,0 +1,57 @@ +// ReSharper disable PropertyCanBeMadeInitOnly.Local +using System.Globalization; + +namespace RestSharp.Tests; + +public class ObjectParserTests { + [Fact] + public void ShouldUseRequestProperty() { + var now = DateTime.Now; + var dates = new[] { now, now.AddDays(1), now.AddDays(2) }; + + var request = new TestObject { + SomeData = "test", + SomeDate = now, + Plain = 123, + PlainArray = dates, + DatesArray = dates + }; + + var parsed = request.GetProperties().ToDictionary(x => x.Name, x => x.Value); + parsed["some_data"].Should().Be(request.SomeData); + parsed["SomeDate"].Should().Be(request.SomeDate.ToString("d", CultureInfo.InvariantCulture)); + parsed["Plain"].Should().Be(request.Plain.ToString(CultureInfo.InvariantCulture)); + parsed["PlainArray"].Should().Be(string.Join(",", dates.Select(x => x.ToString(CultureInfo.InvariantCulture)))); + parsed["dates"].Should().Be(string.Join(",", dates.Select(x => x.ToString("d", CultureInfo.InvariantCulture)))); + } + + [Fact] + public void ShouldProduceMultipleParametersForArray() { + var request = new AnotherTestObject { + SomeIds = [1, 2, 3] + }; + var expected = request.SomeIds.Select(x => ("ids[]", x.ToString())); + var parsed = request.GetProperties().Select(x => (x.Name, x.Value)); + + parsed.Should().BeEquivalentTo(expected); + } + + class AnotherTestObject { + [RequestProperty(Name = "ids", ArrayQueryType = RequestArrayQueryType.ArrayParameters)] + public int[] SomeIds { get; set; } + } + + class TestObject { + [RequestProperty(Name = "some_data")] + public string SomeData { get; set; } + + [RequestProperty(Format = "d")] + public DateTime SomeDate { get; set; } + + [RequestProperty(Name = "dates", Format = "d")] + public DateTime[] DatesArray { get; set; } + + public int Plain { get; set; } + public DateTime[] PlainArray { get; set; } + } +} diff --git a/test/RestSharp.Tests/OptionsTests.cs b/test/RestSharp.Tests/OptionsTests.cs new file mode 100644 index 000000000..9a310ef13 --- /dev/null +++ b/test/RestSharp.Tests/OptionsTests.cs @@ -0,0 +1,17 @@ +namespace RestSharp.Tests; + +public class OptionsTests { + [Fact] + public void HttpClient_AllowAutoRedirect_Is_Always_False() { + var value = true; + var options = new RestClientOptions { FollowRedirects = true, ConfigureMessageHandler = Configure }; + using var _ = new RestClient(options); + value.Should().BeFalse("RestSharp handles redirects internally"); + return; + + HttpMessageHandler Configure(HttpMessageHandler handler) { + value = (handler as HttpClientHandler)!.AllowAutoRedirect; + return handler; + } + } +} \ No newline at end of file diff --git a/test/RestSharp.Tests/Parameters/ObjectParameterTests.ArrayData.cs b/test/RestSharp.Tests/Parameters/ObjectParameterTests.ArrayData.cs new file mode 100644 index 000000000..367395d9f --- /dev/null +++ b/test/RestSharp.Tests/Parameters/ObjectParameterTests.ArrayData.cs @@ -0,0 +1,5 @@ +namespace RestSharp.Tests.Parameters; + +public partial class ObjectParameterTests { + sealed record ArrayData([property: RequestProperty(ArrayQueryType = RequestArrayQueryType.ArrayParameters)] TEnumerable Array) where TEnumerable : notnull; +} diff --git a/test/RestSharp.Tests/Parameters/ObjectParameterTests.CsvData.cs b/test/RestSharp.Tests/Parameters/ObjectParameterTests.CsvData.cs new file mode 100644 index 000000000..07cb78dc1 --- /dev/null +++ b/test/RestSharp.Tests/Parameters/ObjectParameterTests.CsvData.cs @@ -0,0 +1,5 @@ +namespace RestSharp.Tests.Parameters; + +public partial class ObjectParameterTests { + sealed record CsvData([property: RequestProperty(ArrayQueryType = RequestArrayQueryType.CommaSeparated)] TEnumerable Csv) where TEnumerable : notnull; +} diff --git a/test/RestSharp.Tests/Parameters/ObjectParameterTests.FormattedData.cs b/test/RestSharp.Tests/Parameters/ObjectParameterTests.FormattedData.cs new file mode 100644 index 000000000..fb76f8405 --- /dev/null +++ b/test/RestSharp.Tests/Parameters/ObjectParameterTests.FormattedData.cs @@ -0,0 +1,5 @@ +namespace RestSharp.Tests.Parameters; + +public partial class ObjectParameterTests { + sealed record FormattedData([property: RequestProperty(Format = "hh:mm tt")] TDateTime FormattedParameter) where TDateTime : notnull; +} diff --git a/test/RestSharp.Tests/Parameters/ObjectParameterTests.NamedData.cs b/test/RestSharp.Tests/Parameters/ObjectParameterTests.NamedData.cs new file mode 100644 index 000000000..2a6c0f574 --- /dev/null +++ b/test/RestSharp.Tests/Parameters/ObjectParameterTests.NamedData.cs @@ -0,0 +1,5 @@ +namespace RestSharp.Tests.Parameters; + +public partial class ObjectParameterTests { + sealed record NamedData([property: RequestProperty(Name = "CustomName")] object NamedParameter); +} diff --git a/test/RestSharp.Tests/Parameters/ObjectParameterTests.cs b/test/RestSharp.Tests/Parameters/ObjectParameterTests.cs new file mode 100644 index 000000000..305427f90 --- /dev/null +++ b/test/RestSharp.Tests/Parameters/ObjectParameterTests.cs @@ -0,0 +1,732 @@ +using System.Collections; +using System.Globalization; + +namespace RestSharp.Tests.Parameters; + +public partial class ObjectParameterTests { + public ObjectParameterTests() => Thread.CurrentThread.CurrentCulture = CultureInfo.InvariantCulture; + + [Fact] + public void Can_Add_Object_with_IntegerArray_property() { + var request = new RestRequest(); + var items = new[] { 2, 3, 4 }; + request.AddObject(new { Items = items }); + request.Parameters.First().Should().Be(new GetOrPostParameter("Items", string.Join(",", items))); + } + + [Fact] + public void Can_Add_Object_Static_with_Integer_property() { + const int item = 1230; + var @object = new { Item = item }; + var request = new RestRequest().AddObjectStatic(@object); + + request + .Parameters + .Should() + .ContainSingle() + .Which + .Should() + .BeEquivalentTo(new GetOrPostParameter(nameof(@object.Item), "1230")); + } + + [Fact] + public void Can_Add_Object_Static_with_Integer_as_Object_property() { + const int item = 1230; + var @object = new { Item = (object)item }; + var request = new RestRequest().AddObjectStatic(@object); + + request + .Parameters + .Should() + .ContainSingle() + .Which + .Should() + .BeEquivalentTo(new GetOrPostParameter(nameof(@object.Item), "1230")); + } + + [Fact] + public void Can_Add_Object_Static_with_IntegerArray_property() { + var items = new[] { 1, 2, 3 }; + var @object = new { Items = items }; + var request = new RestRequest().AddObjectStatic(@object); + + request + .Parameters + .Should() + .ContainSingle() + .Which + .Should() + .BeEquivalentTo(new GetOrPostParameter(nameof(@object.Items), "1,2,3")); + } + + [Fact] + public void Can_Add_Object_Static_with_IntegerArray_as_ObjectArray_property() { + var items = new object[] { 1, 2, 3 }; + var @object = new { Items = items }; + var request = new RestRequest().AddObjectStatic(@object); + + request + .Parameters + .Should() + .ContainSingle() + .Which + .Should() + .BeEquivalentTo(new GetOrPostParameter(nameof(@object.Items), "1,2,3")); + } + + [Fact] + public void Can_Add_Object_Static_with_IntegerArray_as_Object_property() { + var items = new[] { 1, 2, 3 }; + var @object = new { Items = (object)items }; + var request = new RestRequest().AddObjectStatic(@object); + + request + .Parameters + .Should() + .ContainSingle() + .Which + .Should() + .BeEquivalentTo(new GetOrPostParameter(nameof(@object.Items), "1,2,3")); + } + + [Fact] + public void Can_Add_Object_Static_with_IntegerArray_as_ObjectArray_as_Object_property() { + var items = new object[] { 1, 2, 3 }; + var @object = new { Items = (object)items }; + var request = new RestRequest().AddObjectStatic(@object); + + request + .Parameters + .Should() + .ContainSingle() + .Which + .Should() + .BeEquivalentTo(new GetOrPostParameter(nameof(@object.Items), "1,2,3")); + } + + [Fact] + public void Can_Add_Object_Static_with_IntegerArray_as_Enumerable_property() { + var items = new[] { 1, 2, 3 }; + var @object = new { Items = (IEnumerable)items }; + var request = new RestRequest().AddObjectStatic(@object); + + request + .Parameters + .Should() + .ContainSingle() + .Which + .Should() + .BeEquivalentTo(new GetOrPostParameter(nameof(@object.Items), "1,2,3")); + } + + [Fact] + public void Can_Add_Object_Static_with_IntegerArray_as_Enumerable_as_Object_property() { + IEnumerable items = new[] { 1, 2, 3 }; + var @object = new { Items = (object)items }; + var request = new RestRequest().AddObjectStatic(@object); + + request + .Parameters + .Should() + .ContainSingle() + .Which + .Should() + .BeEquivalentTo(new GetOrPostParameter(nameof(@object.Items), "1,2,3")); + } + + [Fact] + public void Can_Add_Object_Static_with_String_property() { + const string item = "Hello world"; + var @object = new { Item = item }; + var request = new RestRequest().AddObjectStatic(@object); + + request + .Parameters + .Should() + .ContainSingle() + .Which + .Should() + .BeEquivalentTo(new GetOrPostParameter(nameof(@object.Item), item)); + } + + [Fact] + public void Can_Add_Object_Static_with_String_as_Object_property() { + const string item = "Hello world"; + var @object = new { Item = (object)item }; + var request = new RestRequest().AddObjectStatic(@object); + + request + .Parameters + .Should() + .ContainSingle() + .Which + .Should() + .BeEquivalentTo(new GetOrPostParameter(nameof(@object.Item), item)); + } + + [Fact] + public void Can_Add_Object_Static_with_StringArray_property() { + var items = new[] { "Hello", "world", "from", "C#" }; + var @object = new { Items = items }; + var request = new RestRequest().AddObjectStatic(@object); + + request + .Parameters + .Should() + .ContainSingle() + .Which + .Should() + .BeEquivalentTo(new GetOrPostParameter(nameof(@object.Items), "Hello,world,from,C#")); + } + + [Fact] + public void Can_Add_Object_Static_with_StringArray_as_ObjectArray_property() { + var items = new object[] { "Hello", "world", "from", "C#" }; + var @object = new { Items = items }; + var request = new RestRequest().AddObjectStatic(@object); + + request + .Parameters + .Should() + .ContainSingle() + .Which + .Should() + .BeEquivalentTo(new GetOrPostParameter(nameof(@object.Items), "Hello,world,from,C#")); + } + + [Fact] + public void Can_Add_Object_Static_with_StringArray_as_Object_property() { + var items = new[] { "Hello", "world", "from", "C#" }; + var @object = new { Items = (object)items }; + var request = new RestRequest().AddObjectStatic(@object); + + request + .Parameters + .Should() + .ContainSingle() + .Which + .Should() + .BeEquivalentTo(new GetOrPostParameter(nameof(@object.Items), "Hello,world,from,C#")); + } + + [Fact] + public void Can_Add_Object_Static_with_StringArray_as_ObjectArray_as_Object_property() { + var items = new object[] { "Hello", "world", "from", "C#" }; + var @object = new { Items = (object)items }; + var request = new RestRequest().AddObjectStatic(@object); + + request + .Parameters + .Should() + .ContainSingle() + .Which + .Should() + .BeEquivalentTo(new GetOrPostParameter(nameof(@object.Items), "Hello,world,from,C#")); + } + + [Fact] + public void Can_Add_Object_Static_with_StringArray_as_Enumerable_property() { + var items = new[] { "Hello", "world", "from", "C#" }; + var @object = new { Items = (IEnumerable)items }; + var request = new RestRequest().AddObjectStatic(@object); + + request + .Parameters + .Should() + .ContainSingle() + .Which + .Should() + .BeEquivalentTo(new GetOrPostParameter(nameof(@object.Items), "Hello,world,from,C#")); + } + + [Fact] + public void Can_Add_Object_Static_with_StringArray_as_Enumerable_as_Object_property() { + IEnumerable items = new[] { "Hello", "world", "from", "C#" }; + var @object = new { Items = (object)items }; + var request = new RestRequest().AddObjectStatic(@object); + + request + .Parameters + .Should() + .ContainSingle() + .Which + .Should() + .BeEquivalentTo(new GetOrPostParameter(nameof(@object.Items), "Hello,world,from,C#")); + } + + [Fact] + public void Can_Add_Object_Static_with_DateTime_property() { + var item = DateTime.Parse("09/08/2025 13:35:23"); + var @object = new { Item = item }; + var request = new RestRequest().AddObjectStatic(@object); + + request + .Parameters + .Should() + .ContainSingle() + .Which + .Should() + .BeEquivalentTo(new GetOrPostParameter(nameof(@object.Item), "09/08/2025 13:35:23")); + } + + [Fact] + public void Can_Add_Object_Static_with_DateTime_as_Object_property() { + var item = DateTime.Parse("04/06/2006 19:56:44"); + var @object = new { Item = (object)item }; + var request = new RestRequest().AddObjectStatic(@object); + + request + .Parameters + .Should() + .ContainSingle() + .Which + .Should() + .BeEquivalentTo(new GetOrPostParameter(nameof(@object.Item), "04/06/2006 19:56:44")); + } + + [Fact] + public void Can_Add_Object_Static_with_DateTimeArray_property() { + var items = new[] { DateTime.Parse("01/01/2023 00:00:00"), DateTime.Parse("02/03/2024 14:30:00") }; + var @object = new { Items = items }; + var request = new RestRequest().AddObjectStatic(@object); + + request + .Parameters + .Should() + .ContainSingle() + .Which + .Should() + .BeEquivalentTo(new GetOrPostParameter(nameof(@object.Items), "01/01/2023 00:00:00,02/03/2024 14:30:00")); + } + + [Fact] + public void Can_Add_Object_Static_with_DateTimeArray_as_ObjectArray_property() { + var items = new object[] { DateTime.Parse("01/01/2023 00:00:00"), DateTime.Parse("02/03/2024 14:30:00") }; + var @object = new { Items = items }; + var request = new RestRequest().AddObjectStatic(@object); + + request + .Parameters + .Should() + .ContainSingle() + .Which + .Should() + .BeEquivalentTo(new GetOrPostParameter(nameof(@object.Items), "01/01/2023 00:00:00,02/03/2024 14:30:00")); + } + + [Fact] + public void Can_Add_Object_Static_with_DateTimeArray_as_Object_property() { + var items = new[] { DateTime.Parse("01/01/2023 00:00:00"), DateTime.Parse("02/03/2024 14:30:00") }; + var @object = new { Items = (object)items }; + var request = new RestRequest().AddObjectStatic(@object); + + request + .Parameters + .Should() + .ContainSingle() + .Which + .Should() + .BeEquivalentTo(new GetOrPostParameter(nameof(@object.Items), "01/01/2023 00:00:00,02/03/2024 14:30:00")); + } + + [Fact] + public void Can_Add_Object_Static_with_DateTimeArray_as_ObjectArray_as_Object_property() { + var items = new object[] { DateTime.Parse("01/01/2023 00:00:00"), DateTime.Parse("02/03/2024 14:30:00") }; + var @object = new { Items = (object)items }; + var request = new RestRequest().AddObjectStatic(@object); + + request + .Parameters + .Should() + .ContainSingle() + .Which + .Should() + .BeEquivalentTo(new GetOrPostParameter(nameof(@object.Items), "01/01/2023 00:00:00,02/03/2024 14:30:00")); + } + + [Fact] + public void Can_Add_Object_Static_with_DateTimeArray_as_Enumerable_property() { + var items = new[] { DateTime.Parse("01/01/2023 00:00:00"), DateTime.Parse("02/03/2024 14:30:00") }; + var @object = new { Items = (IEnumerable)items }; + var request = new RestRequest().AddObjectStatic(@object); + + request + .Parameters + .Should() + .ContainSingle() + .Which + .Should() + .BeEquivalentTo(new GetOrPostParameter(nameof(@object.Items), "01/01/2023 00:00:00,02/03/2024 14:30:00")); + } + + [Fact] + public void Can_Add_Object_Static_with_DateTimeArray_as_Enumerable_as_Object_property() { + IEnumerable items = new[] { DateTime.Parse("01/01/2023 00:00:00"), DateTime.Parse("02/03/2024 14:30:00") }; + var @object = new { Items = (object)items }; + var request = new RestRequest().AddObjectStatic(@object); + + request + .Parameters + .Should() + .ContainSingle() + .Which + .Should() + .BeEquivalentTo(new GetOrPostParameter(nameof(@object.Items), "01/01/2023 00:00:00,02/03/2024 14:30:00")); + } + + [Fact] + public void Can_Add_Object_Static_with_ObjectArray_property() { + var items = new object[] { "Hello world", 120, DateTime.Parse("06/06/2006 17:49:21"), Guid.Parse("1970a57f-d7f8-45d7-a269-f20e329d9432") }; + var @object = new { Items = items }; + var request = new RestRequest().AddObjectStatic(@object); + + request + .Parameters + .Should() + .ContainSingle() + .Which + .Should() + .BeEquivalentTo(new GetOrPostParameter(nameof(@object.Items), "Hello world,120,06/06/2006 17:49:21,1970a57f-d7f8-45d7-a269-f20e329d9432")); + } + + [Fact] + public void Can_Add_Object_Static_with_ObjectArray_as_Object_property() { + var items = new object[] { "Hello world", 120, DateTime.Parse("06/06/2006 17:49:21"), Guid.Parse("1970a57f-d7f8-45d7-a269-f20e329d9432") }; + var @object = new { Items = (object)items }; + var request = new RestRequest().AddObjectStatic(@object); + + request + .Parameters + .Should() + .ContainSingle() + .Which + .Should() + .BeEquivalentTo(new GetOrPostParameter(nameof(@object.Items), "Hello world,120,06/06/2006 17:49:21,1970a57f-d7f8-45d7-a269-f20e329d9432")); + } + + [Fact] + public void Can_Add_Object_Static_with_ObjectArray_as_Enumerable_property() { + var items = new object[] { "Hello world", 120, DateTime.Parse("06/06/2006 17:49:21"), Guid.Parse("1970a57f-d7f8-45d7-a269-f20e329d9432") }; + var @object = new { Items = (IEnumerable)items }; + var request = new RestRequest().AddObjectStatic(@object); + + request + .Parameters + .Should() + .ContainSingle() + .Which + .Should() + .BeEquivalentTo(new GetOrPostParameter(nameof(@object.Items), "Hello world,120,06/06/2006 17:49:21,1970a57f-d7f8-45d7-a269-f20e329d9432")); + } + + [Fact] + public void Can_Add_Object_Static_with_ObjectArray_as_Enumerable_as_Object_property() { + IEnumerable items = new object[] { "Hello world", 120, DateTime.Parse("06/06/2006 17:49:21"), Guid.Parse("1970a57f-d7f8-45d7-a269-f20e329d9432") }; + var @object = new { Items = (object)items }; + var request = new RestRequest().AddObjectStatic(@object); + + request + .Parameters + .Should() + .ContainSingle() + .Which + .Should() + .BeEquivalentTo(new GetOrPostParameter(nameof(@object.Items), "Hello world,120,06/06/2006 17:49:21,1970a57f-d7f8-45d7-a269-f20e329d9432")); + } + + [Fact] + public void Can_Add_Object_Static_with_custom_property_name() { + var item = new object[] { "Hello world", Array.Empty() }; + var namedData = new NamedData(item); + var request = new RestRequest().AddObjectStatic(namedData); + + request + .Parameters + .Should() + .ContainSingle() + .Which + .Should() + .BeEquivalentTo(new GetOrPostParameter("CustomName", "Hello world,Guid[] Array")); + } + + [Fact] + public void Can_Add_Object_Static_with_DateTime_using_custom_property_format() { + var item = DateTime.Parse("05/02/2020 09:12:33"); + var namedData = new FormattedData(item); + var request = new RestRequest().AddObjectStatic(namedData); + + request + .Parameters + .Should() + .ContainSingle() + .Which + .Should() + .BeEquivalentTo(new GetOrPostParameter(nameof(FormattedData.FormattedParameter), "09:12 AM")); + } + + [Fact] + public void Can_Add_Object_Static_with_DateTime_as_Object_using_custom_property_format() { + var item = DateTime.Parse("05/02/2020 09:12:33"); + var namedData = new FormattedData(item); + var request = new RestRequest().AddObjectStatic(namedData); + + request + .Parameters + .Should() + .ContainSingle() + .Which + .Should() + .BeEquivalentTo(new GetOrPostParameter(nameof(FormattedData.FormattedParameter), "09:12 AM")); + } + + [Fact] + public void Can_Add_Object_Static_with_DateTimeArray_using_custom_property_format() { + var item = new[] { DateTime.Parse("03/03/2019 12:11:00"), DateTime.Parse("10/05/2049 10:12:53"), DateTime.Parse("04/06/2025 23:44:59") }; + var namedData = new FormattedData(item); + var request = new RestRequest().AddObjectStatic(namedData); + + request + .Parameters + .Should() + .ContainSingle() + .Which + .Should() + .BeEquivalentTo(new GetOrPostParameter(nameof(FormattedData.FormattedParameter), "12:11 PM,10:12 AM,11:44 PM")); + } + + [Fact] + public void Can_Add_Object_Static_with_DateTimeArray_as_ObjectArray_using_custom_property_format() { + var item = new object[] { DateTime.Parse("03/03/2019 12:11:00"), DateTime.Parse("10/05/2049 10:12:53"), DateTime.Parse("04/06/2025 23:44:59") }; + var namedData = new FormattedData(item); + var request = new RestRequest().AddObjectStatic(namedData); + + request + .Parameters + .Should() + .ContainSingle() + .Which + .Should() + .BeEquivalentTo(new GetOrPostParameter(nameof(FormattedData.FormattedParameter), "12:11 PM,10:12 AM,11:44 PM")); + } + + [Fact] + public void Can_Add_Object_Static_with_DateTimeArray_as_Object_using_custom_property_format() { + var item = new[] { DateTime.Parse("03/03/2019 12:11:00"), DateTime.Parse("10/05/2049 10:12:53"), DateTime.Parse("04/06/2025 23:44:59") }; + var namedData = new FormattedData(item); + var request = new RestRequest().AddObjectStatic(namedData); + + request + .Parameters + .Should() + .ContainSingle() + .Which + .Should() + .BeEquivalentTo(new GetOrPostParameter(nameof(FormattedData.FormattedParameter), "12:11 PM,10:12 AM,11:44 PM")); + } + + [Fact] + public void Can_Add_Object_Static_with_DateTimeArray_as_ObjectArray_as_Object_using_custom_property_format() { + var item = new object[] { DateTime.Parse("03/03/2019 12:11:00"), DateTime.Parse("10/05/2049 10:12:53"), DateTime.Parse("04/06/2025 23:44:59") }; + var namedData = new FormattedData(item); + var request = new RestRequest().AddObjectStatic(namedData); + + request + .Parameters + .Should() + .ContainSingle() + .Which + .Should() + .BeEquivalentTo(new GetOrPostParameter(nameof(FormattedData.FormattedParameter), "12:11 PM,10:12 AM,11:44 PM")); + } + + [Fact] + public void Can_Add_Object_Static_with_DateTimeArray_as_Enumerable_using_custom_property_format() { + var item = new[] { DateTime.Parse("03/03/2019 12:11:00"), DateTime.Parse("10/05/2049 10:12:53"), DateTime.Parse("04/06/2025 23:44:59") }; + var namedData = new FormattedData(item); + var request = new RestRequest().AddObjectStatic(namedData); + + request + .Parameters + .Should() + .ContainSingle() + .Which + .Should() + .BeEquivalentTo(new GetOrPostParameter(nameof(FormattedData.FormattedParameter), "12:11 PM,10:12 AM,11:44 PM")); + } + + [Fact] + public void Can_Add_Object_Static_with_DateTimeArray_as_ObjectArray_as_Enumerable_using_custom_property_format() { + var item = new object[] { DateTime.Parse("03/03/2019 12:11:00"), DateTime.Parse("10/05/2049 10:12:53"), DateTime.Parse("04/06/2025 23:44:59") }; + var namedData = new FormattedData(item); + var request = new RestRequest().AddObjectStatic(namedData); + + request + .Parameters + .Should() + .ContainSingle() + .Which + .Should() + .BeEquivalentTo(new GetOrPostParameter(nameof(FormattedData.FormattedParameter), "12:11 PM,10:12 AM,11:44 PM")); + } + + [Fact] + public void Can_Add_Object_Static_with_StringArray_using_Csv_format() { + var items = new[] { "Hello", "world", "from", ".NET" }; + var namedData = new CsvData(items); + var request = new RestRequest().AddObjectStatic(namedData); + + request + .Parameters + .Should() + .ContainSingle() + .Which + .Should() + .BeEquivalentTo(new GetOrPostParameter(nameof(CsvData.Csv), "Hello,world,from,.NET")); + } + + [Fact] + public void Can_Add_Object_Static_with_StringArray_as_ObjectArray_using_Csv_format() { + var items = new object[] { "Hello", "world", "from", ".NET" }; + var namedData = new CsvData(items); + var request = new RestRequest().AddObjectStatic(namedData); + + request + .Parameters + .Should() + .ContainSingle() + .Which + .Should() + .BeEquivalentTo(new GetOrPostParameter(nameof(CsvData.Csv), "Hello,world,from,.NET")); + } + + [Fact] + public void Can_Add_Object_Static_with_StringArray_as_Object_using_Csv_format() { + var items = new[] { "Hello", "world", "from", ".NET" }; + var namedData = new CsvData(items); + var request = new RestRequest().AddObjectStatic(namedData); + + request + .Parameters + .Should() + .ContainSingle() + .Which + .Should() + .BeEquivalentTo(new GetOrPostParameter(nameof(CsvData.Csv), "Hello,world,from,.NET")); + } + + [Fact] + public void Can_Add_Object_Static_with_StringArray_as_ObjectArray_as_Object_using_Csv_format() { + var items = new object[] { "Hello", "world", "from", ".NET" }; + var namedData = new CsvData(items); + var request = new RestRequest().AddObjectStatic(namedData); + + request + .Parameters + .Should() + .ContainSingle() + .Which + .Should() + .BeEquivalentTo(new GetOrPostParameter(nameof(CsvData.Csv), "Hello,world,from,.NET")); + } + + [Fact] + public void Can_Add_Object_Static_with_StringArray_using_Array_format() { + var items = new[] { "Hello", "world", "from", ".NET" }; + var namedData = new ArrayData(items); + var request = new RestRequest().AddObjectStatic(namedData); + + request + .Parameters + .Should() + .BeEquivalentTo(new[] { + new GetOrPostParameter($"{nameof(ArrayData.Array)}[]", "Hello"), + new GetOrPostParameter($"{nameof(ArrayData.Array)}[]", "world"), + new GetOrPostParameter($"{nameof(ArrayData.Array)}[]", "from"), + new GetOrPostParameter($"{nameof(ArrayData.Array)}[]", ".NET") + }); + } + + [Fact] + public void Can_Add_Object_Static_with_StringArray_as_ObjectArray_using_Array_format() { + var items = new object[] { "Hello", "world", "from", ".NET" }; + var namedData = new ArrayData(items); + var request = new RestRequest().AddObjectStatic(namedData); + + request + .Parameters + .Should() + .BeEquivalentTo(new[] { + new GetOrPostParameter($"{nameof(ArrayData.Array)}[]", "Hello"), + new GetOrPostParameter($"{nameof(ArrayData.Array)}[]", "world"), + new GetOrPostParameter($"{nameof(ArrayData.Array)}[]", "from"), + new GetOrPostParameter($"{nameof(ArrayData.Array)}[]", ".NET") + }); + } + + [Fact] + public void Can_Add_Object_Static_with_StringArray_as_Object_using_Array_format() { + var items = new[] { "Hello", "world", "from", ".NET" }; + var namedData = new ArrayData(items); + var request = new RestRequest().AddObjectStatic(namedData); + + request + .Parameters + .Should() + .BeEquivalentTo(new[] { + new GetOrPostParameter($"{nameof(ArrayData.Array)}[]", "Hello"), + new GetOrPostParameter($"{nameof(ArrayData.Array)}[]", "world"), + new GetOrPostParameter($"{nameof(ArrayData.Array)}[]", "from"), + new GetOrPostParameter($"{nameof(ArrayData.Array)}[]", ".NET") + }); + } + + [Fact] + public void Can_Add_Object_Static_with_StringArray_as_ObjectArray_as_Object_using_Array_format() { + var items = new object[] { "Hello", "world", "from", ".NET" }; + var namedData = new ArrayData(items); + var request = new RestRequest().AddObjectStatic(namedData); + + request + .Parameters + .Should() + .BeEquivalentTo(new[] { + new GetOrPostParameter($"{nameof(ArrayData.Array)}[]", "Hello"), + new GetOrPostParameter($"{nameof(ArrayData.Array)}[]", "world"), + new GetOrPostParameter($"{nameof(ArrayData.Array)}[]", "from"), + new GetOrPostParameter($"{nameof(ArrayData.Array)}[]", ".NET") + }); + } + + [Fact] + public void RefStructs_are_ignored() { + const string value = "Hello world"; + var stringValue = new StringValue(value); + var request = new RestRequest().AddObjectStatic(stringValue); + request + .Parameters + .Should() + .ContainSingle() + .Which + .Should() + .BeEquivalentTo(new GetOrPostParameter(nameof(StringValue.Value), value)); + } + + [Fact] + public void Properties_are_filtered() { + var @object = new { Name = "Hello world", Age = 12, Guid = Guid.Parse("72df165c-0cef-4654-987f-cd844f1e5ce9"), Ignore = "Ignored" }; + var request = new RestRequest().AddObjectStatic(@object, nameof(@object.Name), nameof(@object.Age), nameof(@object.Guid)); + request + .Parameters + .Should() + .BeEquivalentTo(new[] { + new GetOrPostParameter(nameof(@object.Name), "Hello world"), + new GetOrPostParameter(nameof(@object.Age), "12"), + new GetOrPostParameter(nameof(@object.Guid), "72df165c-0cef-4654-987f-cd844f1e5ce9") + }); + } + + public sealed record StringValue(string Value) { + // ReSharper disable once UnusedMember.Global + public ReadOnlySpan AsSpan => Value.AsSpan(); + } +} diff --git a/test/RestSharp.Tests/Parameters/ParameterValidationTests.cs b/test/RestSharp.Tests/Parameters/ParameterValidationTests.cs new file mode 100644 index 000000000..81b6f39a7 --- /dev/null +++ b/test/RestSharp.Tests/Parameters/ParameterValidationTests.cs @@ -0,0 +1,42 @@ +namespace RestSharp.Tests.Parameters; + +public class ParameterValidationTests { + [Fact] + public void RestRequest_AlwaysMultipartFormData_IsAllowed() { + var request = new RestRequest { AlwaysMultipartFormData = true }; + request.ValidateParameters(); + } + + [Fact] + public void RestRequest_AlwaysSingleFileAsContent_IsAllowed() { + var request = new RestRequest { AlwaysSingleFileAsContent = true }; + request.ValidateParameters(); + } + + [Fact] + public void RestRequest_AlwaysSingleFileAsContent_And_AlwaysMultipartFormData_IsNotAllowed() { + var request = new RestRequest { + AlwaysSingleFileAsContent = true, + AlwaysMultipartFormData = true + }; + Assert.Throws(() => request.ValidateParameters()); + } + + [Fact] + public void RestRequest_AlwaysSingleFileAsContent_And_PostParameters_IsNotAllowed() { + var request = new RestRequest { + Method = Method.Post, + AlwaysSingleFileAsContent = true + }; + + request.AddParameter("name", "value", ParameterType.GetOrPost); + Assert.Throws(() => request.ValidateParameters()); + } + + [Fact] + public void RestRequest_AlwaysSingleFileAsContent_And_BodyParameters_IsNotAllowed() { + var request = new RestRequest { AlwaysSingleFileAsContent = true }; + request.AddParameter("name", "value", ParameterType.RequestBody); + Assert.Throws(() => request.ValidateParameters()); + } +} \ No newline at end of file diff --git a/test/RestSharp.Tests/Parameters/UrlSegmentTests.cs b/test/RestSharp.Tests/Parameters/UrlSegmentTests.cs new file mode 100644 index 000000000..d7358a333 --- /dev/null +++ b/test/RestSharp.Tests/Parameters/UrlSegmentTests.cs @@ -0,0 +1,88 @@ +namespace RestSharp.Tests.Parameters; + +public class UrlSegmentTests { + const string BaseUrlNoTrail = "http://localhost:8888"; + const string BaseUrl = $"{BaseUrlNoTrail}/"; + + [Fact] + public void AddUrlSegmentWithInt() { + const string name = "foo"; + + var request = new RestRequest().AddUrlSegment(name, 1); + var actual = request.Parameters.FirstOrDefault(x => x.Name == name); + var expected = new UrlSegmentParameter(name, "1"); + + expected.Should().BeEquivalentTo(actual); + } + + [Fact] + public void AddUrlSegmentModifiesUrlSegmentWithInt() { + const string name = "foo"; + const string pathTemplate = "/{0}/resource"; + const int urlSegmentValue = 1; + + var path = string.Format(pathTemplate, $"{{{name}}}"); + var request = new RestRequest(path).AddUrlSegment(name, urlSegmentValue); + var expected = $"{BaseUrlNoTrail}{string.Format(pathTemplate, urlSegmentValue)}"; + + using var client = new RestClient(BaseUrl); + var actual = client.BuildUriString(request); + + expected.Should().BeEquivalentTo(actual); + } + + [Fact] + public void AddUrlSegmentModifiesUrlSegmentWithString() { + const string name = "foo"; + const string pathTemplate = "/{0}/resource"; + const string urlSegmentValue = "bar"; + + var path = string.Format(pathTemplate, $"{{{name}}}"); + var request = new RestRequest(path).AddUrlSegment(name, urlSegmentValue); + var expected = $"{BaseUrlNoTrail}{string.Format(pathTemplate, urlSegmentValue)}"; + + using var client = new RestClient(BaseUrl); + + var actual = client.BuildUriString(request); + + expected.Should().BeEquivalentTo(actual); + } + + [Theory] + [InlineData("bar%2fBAR")] + [InlineData("bar%2FBAR")] + public void UrlSegmentParameter_WithValueWithEncodedSlash_WillReplaceEncodedSlashByDefault(string inputValue) { + var urlSegmentParameter = new UrlSegmentParameter("foo", inputValue); + urlSegmentParameter.Value.Should().BeEquivalentTo("bar/BAR"); + } + + [Theory] + [InlineData("bar%2fBAR")] + [InlineData("bar%2FBAR")] + public void UrlSegmentParameter_WithValueWithEncodedSlash_CanReplaceEncodedSlash(string inputValue) { + var urlSegmentParameter = new UrlSegmentParameter("foo", inputValue, replaceEncodedSlash: true); + urlSegmentParameter.Value.Should().BeEquivalentTo("bar/BAR"); + } + + [Theory] + [InlineData("bar%2fBAR")] + [InlineData("bar%2FBAR")] + public void UrlSegmentParameter_WithValueWithEncodedSlash_CanLeaveEncodedSlash(string inputValue) { + var urlSegmentParameter = new UrlSegmentParameter("foo", inputValue, replaceEncodedSlash: false); + urlSegmentParameter.Value.Should().BeEquivalentTo(inputValue); + } + + [Fact] + public void AddSameUrlSegmentTwice_ShouldReplaceFirst() { + const string host = "https://api.example.com"; + var client = new RestClient(); + var request = new RestRequest($"{host}/orgs/{{segment}}/something"); + request.AddUrlSegment("segment", 1); + var url1 = client.BuildUriString(request); + request.AddUrlSegment("segment", 2); + var url2 = client.BuildUriString(request); + + url1.Should().Be($"{host}/orgs/1/something"); + url2.Should().Be($"{host}/orgs/2/something"); + } +} \ No newline at end of file diff --git a/test/RestSharp.Tests/RestClientTests.cs b/test/RestSharp.Tests/RestClientTests.cs new file mode 100644 index 000000000..0bb54b328 --- /dev/null +++ b/test/RestSharp.Tests/RestClientTests.cs @@ -0,0 +1,126 @@ +using RestSharp.Serializers; +using RestSharp.Serializers.Json; + +namespace RestSharp.Tests; + +public class RestClientTests { + const string BaseUrl = "http://localhost:8888/"; + + [Theory] + [InlineData(Method.Get, Method.Post)] + [InlineData(Method.Post, Method.Get)] + [InlineData(Method.Delete, Method.Get)] + [InlineData(Method.Head, Method.Post)] + [InlineData(Method.Put, Method.Patch)] + [InlineData(Method.Patch, Method.Put)] + [InlineData(Method.Post, Method.Put)] + [InlineData(Method.Get, Method.Delete)] + public async Task Execute_with_RestRequest_and_Method_overrides_previous_request_method(Method reqMethod, Method overrideMethod) { + var req = new RestRequest("", reqMethod); + + using var client = new RestClient(BaseUrl); + await client.ExecuteAsync(req, overrideMethod); + + req.Method.Should().Be(overrideMethod); + } + + [Fact] + public async Task ConfigureHttp_will_set_proxy_to_null_with_no_exceptions_When_no_proxy_can_be_found() { + var req = new RestRequest(); + + using var client = new RestClient(new RestClientOptions(BaseUrl) { Proxy = null }); + await client.ExecuteAsync(req); + } + + [Fact] + public void UseJson_leaves_only_json_serializer() { + // arrange + var baseUrl = new Uri(BaseUrl); + + // act + using var client = new RestClient(baseUrl, configureSerialization: cfg => cfg.UseJson()); + + // assert + client.Serializers.Serializers.Should().HaveCount(1); + client.Serializers.GetSerializer(DataFormat.Json).Should().NotBeNull(); + } + + [Fact] + public void UseXml_leaves_only_json_serializer() { + // arrange + var baseUrl = new Uri(BaseUrl); + + // act + using var client = new RestClient(baseUrl, configureSerialization: cfg => cfg.UseXml()); + + // assert + client.Serializers.Serializers.Should().HaveCount(1); + client.Serializers.GetSerializer(DataFormat.Xml).Should().NotBeNull(); + } + + [Fact] + public void UseOnlySerializer_leaves_only_custom_serializer() { + // arrange + var baseUrl = new Uri(BaseUrl); + + // act + using var client = new RestClient(baseUrl, configureSerialization: cfg => cfg.UseOnlySerializer(() => new SystemTextJsonSerializer())); + + // assert + client.Serializers.Serializers.Should().HaveCount(1); + client.Serializers.GetSerializer(DataFormat.Json).Should().NotBeNull(); + } + + [Fact] + public void Should_reuse_httpClient_instance() { + using var client1 = new RestClient(new Uri("https://fake.api"), useClientFactory: true); + using var client2 = new RestClient(new Uri("https://fake.api"), useClientFactory: true); + + client1.HttpClient.Should().BeSameAs(client2.HttpClient); + } + + [Fact] + public void Should_use_new_httpClient_instance() { + using var client1 = new RestClient(new Uri("https://fake.api")); + using var client2 = new RestClient(new Uri("https://fake.api")); + + client1.HttpClient.Should().NotBeSameAs(client2.HttpClient); + } + + [Fact] + public void ConfigureDefaultParameters_sets_user_agent_new_httpClient_instance() { + // arrange + var clientOptions = new RestClientOptions(); + + // act + using var restClient = new RestClient(clientOptions); + + //assert + Assert.Single( + restClient.DefaultParameters, + parameter => parameter is { Type: ParameterType.HttpHeader, Name: KnownHeaders.UserAgent, Value: string valueAsString } && + valueAsString == clientOptions.UserAgent + ); + + Assert.Empty(restClient.HttpClient.DefaultRequestHeaders.UserAgent); + } + + [Fact] + public void ConfigureDefaultParameters_sets_user_agent_given_httpClient_instance() { + // arrange + var httpClient = new HttpClient(); + var clientOptions = new RestClientOptions(); + + // act + using var restClient = new RestClient(httpClient, clientOptions); + + //assert + Assert.Single( + restClient.DefaultParameters, + parameter => parameter is { Type: ParameterType.HttpHeader, Name: KnownHeaders.UserAgent, Value: string valueAsString } && + valueAsString == clientOptions.UserAgent + ); + + Assert.Empty(httpClient.DefaultRequestHeaders.UserAgent); + } +} \ No newline at end of file diff --git a/test/RestSharp.Tests/RestContentTests.cs b/test/RestSharp.Tests/RestContentTests.cs new file mode 100644 index 000000000..8f1a97343 --- /dev/null +++ b/test/RestSharp.Tests/RestContentTests.cs @@ -0,0 +1,28 @@ +namespace RestSharp.Tests; + +public class RestContentTests { + [Fact] + public void RestContent_CaseInsensitiveHeaders() { + const string myContentType = "application/x-custom"; + + var request = new RestRequest("resource").AddHeader("coNteNt-TypE", myContentType); + var content = new RequestContent(new RestClient(), request); + + var httpContent = content.BuildContent(); + + httpContent.Headers.ContentType!.MediaType.Should().Be(myContentType); + } + + [Fact] + public void RestContent_supports_manual_json_body() { + string myContentType = ContentType.Json; + const string myJsonString = "[]"; + + var request = new RestRequest("resource").AddParameter(myContentType, myJsonString, ParameterType.RequestBody); + var content = new RequestContent(new RestClient(), request); + + var httpContent = content.BuildContent(); + + httpContent.Headers.ContentType!.MediaType.Should().Be(myContentType); + } +} diff --git a/test/RestSharp.Tests/RestRequestTests.cs b/test/RestSharp.Tests/RestRequestTests.cs new file mode 100644 index 000000000..dc2053c09 --- /dev/null +++ b/test/RestSharp.Tests/RestRequestTests.cs @@ -0,0 +1,40 @@ +namespace RestSharp.Tests; + +public class RestRequestTests { + [Fact] + public void RestRequest_Request_Property() { + var request = new RestRequest("resource"); + request.Resource.Should().Be("resource"); + } + + [Fact] + public void RestRequest_Test_Already_Encoded() { + const string resource = "/api/get?query=Id%3d198&another=notencoded&novalue="; + const string baseUrl = "https://example.com"; + + var request = new RestRequest(resource); + var parameters = request.Parameters.ToArray(); + + request.Resource.Should().Be("/api/get"); + parameters.Length.Should().Be(3); + + var expected = new[] { + new { Name = "query", Value = "Id%3d198", Type = ParameterType.QueryString, Encode = false }, + new { Name = "another", Value = "notencoded", Type = ParameterType.QueryString, Encode = false }, + new { Name = "novalue", Value = "", Type = ParameterType.QueryString, Encode = false } + }; + parameters.Should().BeEquivalentTo(expected, options => options.ExcludingMissingMembers()); + + using var client = new RestClient(baseUrl); + var actual = client.BuildUriString(request); + actual.Should().Be($"{baseUrl}{resource}"); + } + + [Fact] + public async Task RestRequest_Fail_On_Exception() { + var req = new RestRequest("nonexisting"); + + using var client = new RestClient(new RestClientOptions("http://localhost:12345") { ThrowOnAnyError = true }); + await Assert.ThrowsAsync(() => client.ExecuteAsync(req)); + } +} \ No newline at end of file diff --git a/test/RestSharp.Tests/RestSharp.Tests.csproj b/test/RestSharp.Tests/RestSharp.Tests.csproj new file mode 100644 index 000000000..af5fb6fa9 --- /dev/null +++ b/test/RestSharp.Tests/RestSharp.Tests.csproj @@ -0,0 +1,39 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + UrlBuilderTests.cs + + + UrlBuilderTests.cs + + + \ No newline at end of file diff --git a/RestSharp.Tests/SampleData/4sq.txt b/test/RestSharp.Tests/SampleData/4sq.json similarity index 100% rename from RestSharp.Tests/SampleData/4sq.txt rename to test/RestSharp.Tests/SampleData/4sq.json diff --git a/RestSharp.Tests/SampleData/GenericWithList.txt b/test/RestSharp.Tests/SampleData/GenericWithList.json similarity index 100% rename from RestSharp.Tests/SampleData/GenericWithList.txt rename to test/RestSharp.Tests/SampleData/GenericWithList.json diff --git a/RestSharp.Tests/SampleData/bearertoken.txt b/test/RestSharp.Tests/SampleData/bearertoken.json similarity index 100% rename from RestSharp.Tests/SampleData/bearertoken.txt rename to test/RestSharp.Tests/SampleData/bearertoken.json diff --git a/RestSharp.Tests/SampleData/datetimes.txt b/test/RestSharp.Tests/SampleData/datetimes.json similarity index 100% rename from RestSharp.Tests/SampleData/datetimes.txt rename to test/RestSharp.Tests/SampleData/datetimes.json diff --git a/RestSharp.Tests/SampleData/iso8601datetimes.txt b/test/RestSharp.Tests/SampleData/iso8601datetimes.json similarity index 100% rename from RestSharp.Tests/SampleData/iso8601datetimes.txt rename to test/RestSharp.Tests/SampleData/iso8601datetimes.json diff --git a/RestSharp.Tests/SampleData/jsonarray.txt b/test/RestSharp.Tests/SampleData/jsonarray.json similarity index 100% rename from RestSharp.Tests/SampleData/jsonarray.txt rename to test/RestSharp.Tests/SampleData/jsonarray.json diff --git a/RestSharp.Tests/SampleData/jsondictionary.txt b/test/RestSharp.Tests/SampleData/jsondictionary.json similarity index 100% rename from RestSharp.Tests/SampleData/jsondictionary.txt rename to test/RestSharp.Tests/SampleData/jsondictionary.json diff --git a/RestSharp.Tests/SampleData/jsondictionary_KeysType.txt b/test/RestSharp.Tests/SampleData/jsondictionary_KeysType.json similarity index 100% rename from RestSharp.Tests/SampleData/jsondictionary_KeysType.txt rename to test/RestSharp.Tests/SampleData/jsondictionary_KeysType.json diff --git a/RestSharp.Tests/SampleData/jsondictionary_null.txt b/test/RestSharp.Tests/SampleData/jsondictionary_null.json similarity index 100% rename from RestSharp.Tests/SampleData/jsondictionary_null.txt rename to test/RestSharp.Tests/SampleData/jsondictionary_null.json diff --git a/RestSharp.Tests/SampleData/jsonenums.txt b/test/RestSharp.Tests/SampleData/jsonenums.json similarity index 100% rename from RestSharp.Tests/SampleData/jsonenums.txt rename to test/RestSharp.Tests/SampleData/jsonenums.json diff --git a/RestSharp.Tests/SampleData/jsonenumtypes.txt b/test/RestSharp.Tests/SampleData/jsonenumtypes.json similarity index 100% rename from RestSharp.Tests/SampleData/jsonenumtypes.txt rename to test/RestSharp.Tests/SampleData/jsonenumtypes.json diff --git a/RestSharp.Tests/SampleData/jsonlists.txt b/test/RestSharp.Tests/SampleData/jsonlists.json similarity index 100% rename from RestSharp.Tests/SampleData/jsonlists.txt rename to test/RestSharp.Tests/SampleData/jsonlists.json diff --git a/test/RestSharp.Tests/SampleData/newdatetimes.json b/test/RestSharp.Tests/SampleData/newdatetimes.json new file mode 100644 index 000000000..8c193c13b --- /dev/null +++ b/test/RestSharp.Tests/SampleData/newdatetimes.json @@ -0,0 +1,4 @@ +{ + "DateTime": "new Date(1309421746929)", + "DateTimeNegative": "new Date(-1)" +} \ No newline at end of file diff --git a/RestSharp.Tests/SampleData/objectproperty.txt b/test/RestSharp.Tests/SampleData/objectproperty.json similarity index 100% rename from RestSharp.Tests/SampleData/objectproperty.txt rename to test/RestSharp.Tests/SampleData/objectproperty.json diff --git a/RestSharp.Tests/SampleData/person.json.txt b/test/RestSharp.Tests/SampleData/person.json similarity index 100% rename from RestSharp.Tests/SampleData/person.json.txt rename to test/RestSharp.Tests/SampleData/person.json diff --git a/RestSharp.Tests/SampleData/sojson.txt b/test/RestSharp.Tests/SampleData/sojson.json similarity index 100% rename from RestSharp.Tests/SampleData/sojson.txt rename to test/RestSharp.Tests/SampleData/sojson.json diff --git a/RestSharp.Tests/SampleData/timespans.txt b/test/RestSharp.Tests/SampleData/timespans.json similarity index 100% rename from RestSharp.Tests/SampleData/timespans.txt rename to test/RestSharp.Tests/SampleData/timespans.json diff --git a/test/RestSharp.Tests/SampleData/underscore_prefix.json b/test/RestSharp.Tests/SampleData/underscore_prefix.json new file mode 100644 index 000000000..753421134 --- /dev/null +++ b/test/RestSharp.Tests/SampleData/underscore_prefix.json @@ -0,0 +1,18 @@ +{ + "User": { + "_id": 1786, + "_displayName": "John Sheehan", + "Reputation": 18332, + "CreationDate": 1219071163, + "_displayName": "John Sheehan", + "EmailHash": "lkdsafadfjsadfkjlsdjflkjdsf", + "Age": "28", + "LastAccessDate": 1269715453, + "WebsiteUrl": "http://john-sheehan.com/blog", + "Location": "Minnesota", + "AboutMe": "

Follow me on Twitter

\r\n\r\n

Read my blog

\r\n\r\n

Visit managedassembly.com - A community for .NET developers.

\r\n\r\n

I am the founder of RIM Systems, maker of SnapLeague, a web-based league management system for recreational athletics.

", + "Views": 1639, + "UpVotes": 1665, + "DownVotes": 427 + } +} \ No newline at end of file diff --git a/test/RestSharp.Tests/StringExtensionsTests.cs b/test/RestSharp.Tests/StringExtensionsTests.cs new file mode 100644 index 000000000..045be6d9f --- /dev/null +++ b/test/RestSharp.Tests/StringExtensionsTests.cs @@ -0,0 +1,73 @@ +using System.Globalization; +using System.Text; +using RestSharp.Extensions; + +namespace RestSharp.Tests; + +public class StringExtensionsTests { + [Fact] + public void UrlEncode_Throws_ArgumentNullException_For_Null_Input() { + string nullString = null; + // ReSharper disable once ExpressionIsAlwaysNull + Assert.Throws(() => nullString!.UrlEncode()); + } + + [Fact] + public void UrlEncode_Returns_Correct_Length_When_Less_Than_Limit() { + const int numLessThanLimit = 32766; + var stringWithLimitLength = new string('*', numLessThanLimit); + var encodedAndDecoded = stringWithLimitLength.UrlEncode().UrlDecode(); + Assert.Equal(numLessThanLimit, encodedAndDecoded.Length); + } + + [Fact] + public void UrlEncode_Returns_Correct_Length_When_More_Than_Limit() { + const int numGreaterThanLimit = 65000; + var stringWithLimitLength = new string('*', numGreaterThanLimit); + var encodedAndDecoded = stringWithLimitLength.UrlEncode().UrlDecode(); + Assert.Equal(numGreaterThanLimit, encodedAndDecoded.Length); + } + + [Fact] + public void UrlEncode_Does_Not_Fail_When_4_Byte_Unicode_Character_Lies_Between_Chunks() { + var stringWithLimitLength = new string('*', 32765); + stringWithLimitLength += "😉*****"; // 2 + 5 chars + var encodedAndDecoded = stringWithLimitLength.UrlEncode().UrlDecode(); + Assert.Equal(stringWithLimitLength, encodedAndDecoded); + + // now between another 2 chunks + stringWithLimitLength = new string('*', 32766 * 2 - 1); + stringWithLimitLength += "😉*****"; // 2 + 5 chars + encodedAndDecoded = stringWithLimitLength.UrlEncode().UrlDecode(); + Assert.Equal(stringWithLimitLength, encodedAndDecoded); + } + + [Fact] + public void UrlEncodeTest() { + const string parameter = "ø"; + Assert.Equal("%F8", parameter.UrlEncode(Encoding.GetEncoding("ISO-8859-1")), true); + Assert.Equal("%C3%B8", parameter.UrlEncode(), true); + } + + [Theory] + [InlineData("this_is_a_test", true, "ThisIsATest")] + [InlineData("this_is_a_test", false, "This_Is_A_Test")] + public void ToPascalCase(string start, bool removeUnderscores, string finish) { + var result = start.ToPascalCase(removeUnderscores, CultureInfo.InvariantCulture); + + Assert.Equal(finish, result); + } + + [Theory] + [InlineData("DueDate", "dueDate")] + [InlineData("ID", "id")] + [InlineData("IDENTIFIER", "identifier")] + [InlineData("primaryId", "primaryId")] + [InlineData("A", "a")] + [InlineData("ThisIsATest", "thisIsATest")] + public void ToCamelCase(string start, string finish) { + var result = start.ToCamelCase(CultureInfo.InvariantCulture); + + Assert.Equal(finish, result); + } +} \ No newline at end of file diff --git a/test/RestSharp.Tests/UrlBuilderTests.Get.cs b/test/RestSharp.Tests/UrlBuilderTests.Get.cs new file mode 100644 index 000000000..4a2909697 --- /dev/null +++ b/test/RestSharp.Tests/UrlBuilderTests.Get.cs @@ -0,0 +1,239 @@ +namespace RestSharp.Tests; + +public partial class UrlBuilderTests { + [Fact] + public void GET_with_empty_base_and_query_parameters_without_encoding() { + var request = new RestRequest($"{Base}/{Resource}?param1=value1") + .AddQueryParameter("foo", "bar,baz", false); + var expected = new Uri($"{Base}/{Resource}?param1=value1&foo=bar,baz"); + + using var client = new RestClient(); + + var output = client.BuildUri(request); + Assert.Equal(expected, output); + } + + [Fact] + public void GET_with_empty_base_and_resource_containing_tokens() { + var request = new RestRequest($"{Base}/{Resource}/{{foo}}"); + request.AddUrlSegment("foo", "bar"); + + using var client = new RestClient(); + + var expected = new Uri($"{Base}/{Resource}/bar"); + var output = client.BuildUri(request); + + Assert.Equal(expected, output); + } + + [Fact] + public void GET_with_empty_request() { + var request = new RestRequest(); + var expected = new Uri(Base); + + using var client = new RestClient(new Uri(Base)); + + var output = client.BuildUri(request); + Assert.Equal(expected, output); + } + + [Fact] + public void GET_with_empty_request_and_bare_hostname() { + var request = new RestRequest(); + var expected = new Uri(Base); + + using var client = new RestClient(new Uri(Base)); + + var output = client.BuildUri(request); + Assert.Equal(expected, output); + } + + [Fact] + public void GET_with_empty_request_and_query_parameters_without_encoding() { + var request = new RestRequest(); + request.AddQueryParameter("foo", "bar,baz", false); + var expected = new Uri($"{Base}/{Resource}?param1=value1&foo=bar,baz"); + + using var client = new RestClient($"{Base}/{Resource}?param1=value1"); + + var output = client.BuildUri(request); + Assert.Equal(expected, output); + } + + [Fact] + public void GET_with_pipe_character_in_query_parameter_without_encoding() { + var request = new RestRequest(); + request.AddQueryParameter("ids", "in:001|116", false); + const string expected = $"{Base}/{Resource}?ids=in:001|116"; + + using var client = new RestClient($"{Base}/{Resource}"); + + var output = client.BuildUriString(request); + Assert.Equal(expected, output); + } + + [Fact] + public void GET_with_Invalid_Url_string_throws_exception() + => Assert.Throws(() => { _ = new RestClient("invalid url"); } + ); + + [Fact] + public void GET_with_leading_slash() { + var request = new RestRequest($"/{Resource}"); + var expected = new Uri($"{Base}/{Resource}"); + + using var client = new RestClient(new Uri(Base)); + + var output = client.BuildUri(request); + Assert.Equal(expected, output); + } + + [Fact] + public void GET_with_leading_slash_and_baseurl_trailing_slash() { + var request = new RestRequest($"/{Resource}"); + request.AddParameter("foo", "bar"); + var expected = new Uri($"{Base}/{Resource}?foo=bar"); + + using var client = new RestClient(new Uri(Base)); + + var output = client.BuildUri(request); + Assert.Equal(expected, output); + } + + [Fact] + public void GET_with_multiple_instances_of_same_key() { + var request = new RestRequest("v1/people/~/network/updates"); + request.AddParameter("type", "STAT"); + request.AddParameter("type", "PICT"); + request.AddParameter("count", "50"); + request.AddParameter("start", "50"); + var expected = new Uri("https://api.linkedin.com/v1/people/~/network/updates?type=STAT&type=PICT&count=50&start=50"); + + using var client = new RestClient("https://api.linkedin.com"); + + var output = client.BuildUri(request); + Assert.Equal(expected, output); + } + + [Fact] + public void GET_with_resource_containing_null_token() { + var request = new RestRequest($"/{Resource}/{{foo}}"); + request.AddUrlSegment("foo", null); + + using var client = new RestClient(new Uri(Base)); + + var output = client.BuildUri(request); + Assert.Equal(new($"{Base}/{Resource}/"), output); + } + + [Fact] + public void GET_with_resource_containing_slashes() { + var request = new RestRequest($"{Resource}/foo"); + var expected = new Uri($"{Base}/{Resource}/foo"); + + using var client = new RestClient(new Uri(Base)); + + var output = client.BuildUri(request); + Assert.Equal(expected, output); + } + + [Fact] + public void GET_with_resource_containing_tokens() { + var request = new RestRequest($"{Resource}/{{foo}}"); + request.AddUrlSegment("foo", "bar"); + var expected = new Uri($"{Base}/{Resource}/bar"); + + using var client = new RestClient(new Uri(Base)); + + var output = client.BuildUri(request); + Assert.Equal(expected, output); + } + + [Fact] + public void GET_with_Uri_and_resource_containing_tokens() { + var request = new RestRequest($"/{{foo}}/{Resource}/{{baz}}"); + request.AddUrlSegment("foo", "bar"); + request.AddUrlSegment("baz", "bat"); + var expected = new Uri($"{Base}/bar/{Resource}/bat"); + + using var client = new RestClient(Base); + + var output = client.BuildUri(request); + Assert.Equal(expected, output); + } + + [Fact] + public void GET_with_Uri_containing_tokens() { + var request = new RestRequest(); + request.AddUrlSegment("foo", "bar"); + var expected = new Uri(Base); + + using var client = new RestClient(Base); + + var output = client.BuildUri(request); + Assert.Equal(expected, output); + } + + [Fact] + public void GET_with_Url_string_and_resource_containing_tokens() { + var request = new RestRequest($"{Resource}/{{baz}}"); + request.AddUrlSegment("foo", "bar"); + request.AddUrlSegment("baz", "bat"); + var expected = new Uri($"{Base}/bar/{Resource}/bat"); + + using var client = new RestClient($"{Base}/{{foo}}"); + + var output = client.BuildUri(request); + Assert.Equal(expected, output); + } + + [Fact] + public void GET_with_Url_string_containing_tokens() { + var request = new RestRequest(); + request.AddUrlSegment("foo", "bar"); + var expected = new Uri($"{Base}/bar"); + + using var client = new RestClient($"{Base}/{{foo}}"); + + var output = client.BuildUri(request); + Assert.Equal(expected, output); + } + + [Fact] + public void GET_wth_trailing_slash_and_query_parameters() { + var request = new RestRequest($"/{Resource}/"); + request.AddParameter("foo", "bar"); + var expected = new Uri($"{Base}/{Resource}/?foo=bar"); + + using var client = new RestClient(Base); + + var output = client.BuildUri(request); + Assert.Equal(expected, output); + } + + [Fact] + public void Multiple_query_parameters_with_same_name() { + var request = new RestRequest($"/{Resource}/") + .AddQueryParameter("foo", "bar") + .AddQueryParameter("foo", "baz"); + var expected = new Uri($"{Base}/{Resource}/?foo=bar&foo=baz"); + + using var client = new RestClient(Base); + + var output = client.BuildUri(request); + Assert.Equal(expected, output); + } + + [Fact] + public void Query_parameter_with_non_string_value() { + var request = new RestRequest($"/{Resource}/") + .AddQueryParameter("foo", 123) + .AddQueryParameter("bar", true); + var expected = new Uri($"{Base}/{Resource}/?foo=123&bar=True"); + + using var client = new RestClient(Base); + + var output = client.BuildUri(request); + Assert.Equal(expected, output); + } +} \ No newline at end of file diff --git a/test/RestSharp.Tests/UrlBuilderTests.Post.cs b/test/RestSharp.Tests/UrlBuilderTests.Post.cs new file mode 100644 index 000000000..129b1079f --- /dev/null +++ b/test/RestSharp.Tests/UrlBuilderTests.Post.cs @@ -0,0 +1,60 @@ +namespace RestSharp.Tests; + +public partial class UrlBuilderTests { + [Fact] + public void POST_with_leading_slash() { + var request = new RestRequest($"/{Resource}", Method.Post); + var expected = new Uri($"{Base}/{Resource}"); + + using var client = new RestClient(new Uri(Base)); + + var output = client.BuildUri(request); + Assert.Equal(expected, output); + } + + [Fact] + public void POST_with_leading_slash_and_baseurl_trailing_slash() { + var request = new RestRequest($"/{Resource}", Method.Post); + var expected = new Uri($"{Base}/{Resource}"); + + using var client = new RestClient(Base); + + var output = client.BuildUri(request); + Assert.Equal(expected, output); + } + + [Fact] + public void POST_with_querystring_containing_tokens() { + var request = new RestRequest(Resource, Method.Post); + request.AddParameter("foo", "bar", ParameterType.QueryString); + var expected = new Uri($"{Base}/{Resource}?foo=bar"); + + using var client = new RestClient(Base); + + var output = client.BuildUri(request); + Assert.Equal(expected, output); + } + + [Fact] + public void POST_with_resource_containing_slashes() { + var request = new RestRequest($"{Resource}/foo", Method.Post); + var expected = new Uri($"{Base}/{Resource}/foo"); + + using var client = new RestClient(Base); + + var output = client.BuildUri(request); + Assert.Equal(expected, output); + } + + [Fact] + public void POST_with_resource_containing_tokens() { + var request = new RestRequest($"{Resource}/{{foo}}", Method.Post); + request.AddUrlSegment("foo", "bar"); + var expected = new Uri($"{Base}/{Resource}/bar"); + + using var client = new RestClient(Base); + + var output = client.BuildUri(request); + Assert.Equal(expected, output); + } +} \ No newline at end of file diff --git a/test/RestSharp.Tests/UrlBuilderTests.cs b/test/RestSharp.Tests/UrlBuilderTests.cs new file mode 100644 index 000000000..9a80a20f6 --- /dev/null +++ b/test/RestSharp.Tests/UrlBuilderTests.cs @@ -0,0 +1,147 @@ +using System.Text; + +namespace RestSharp.Tests; + +/// +/// Note: These tests do not handle QueryString building, which is handled in Http, not RestClient +/// +public partial class UrlBuilderTests { + const string Base = "https://some.path"; + const string Resource = "resource"; + + [Fact] + public void Should_add_parameter_if_it_is_new() { + var request = new RestRequest(); + request.AddOrUpdateParameter("param2", "value2"); + request.AddOrUpdateParameter("param3", "value3"); + var expected = new Uri($"{Base}/{Resource}?param1=value1¶m2=value2¶m3=value3"); + + using var client = new RestClient($"{Base}/{Resource}?param1=value1"); + + var output = client.BuildUri(request); + Assert.Equal(expected, output); + } + + [Fact] + public void Should_build_uri_using_selected_encoding() { + var request = new RestRequest(); + // adding parameter with o-slash character which is encoded differently between + // utf-8 and iso-8859-1 + request.AddOrUpdateParameter("town", "Hillerød"); + var expectedDefaultEncoding = new Uri($"{Base}/{Resource}?town=Hiller%C3%B8d"); + var expectedIso89591Encoding = new Uri($"{Base}/{Resource}?town=Hiller%f8d"); + + using var client1 = new RestClient(new RestClientOptions($"{Base}/{Resource}")); + Assert.Equal(expectedDefaultEncoding, client1.BuildUri(request)); + + using var client2 = new RestClient(new RestClientOptions($"{Base}/{Resource}") { Encoding = Encoding.GetEncoding("ISO-8859-1") }); + Assert.Equal(expectedIso89591Encoding, client2.BuildUri(request)); + } + + [Fact] + public void Should_build_uri_with_resource_full_uri() { + var request = new RestRequest($"{Base}/connect/authorize"); + var expected = new Uri($"{Base}/connect/authorize"); + + using var client = new RestClient(Base); + + var output = client.BuildUri(request); + Assert.Equal(expected, output); + } + + [Fact] + public void Should_encode_colon() { + var request = new RestRequest(); + // adding parameter with o-slash character which is encoded differently between + // utf-8 and iso-8859-1 + request.AddOrUpdateParameter("parameter", "some:value"); + + using var client = new RestClient($"{Base}/{Resource}"); + + var expectedDefaultEncoding = new Uri($"{Base}/{Resource}?parameter=some%3avalue"); + Assert.Equal(expectedDefaultEncoding, client.BuildUri(request)); + } + + [Fact] + public void Should_not_duplicate_question_mark() { + var request = new RestRequest(); + request.AddParameter("param2", "value2"); + var expected = new Uri($"{Base}/{Resource}?param1=value1¶m2=value2"); + + using var client = new RestClient($"{Base}/{Resource}?param1=value1"); + + var output = client.BuildUri(request); + Assert.Equal(expected, output); + } + + [Fact] + public void Should_not_touch_request_url() { + const string baseUrl = "https://rs.test.org"; + const string requestUrl = "reportserver?/Prod/Report"; + + var req = new RestRequest(requestUrl, Method.Post); + + using var client = new RestClient(baseUrl); + + var resultUrl = client.BuildUri(req).ToString(); + resultUrl.Should().Be($"{baseUrl}/{requestUrl}"); + } + + [Fact] + public void Should_update_parameter_if_it_already_exists() { + var request = new RestRequest(); + request.AddOrUpdateParameter("param2", "value2"); + request.AddOrUpdateParameter("param2", "value2-1"); + var expected = new Uri($"{Base}/{Resource}?param1=value1¶m2=value2-1"); + + using var client = new RestClient($"{Base}/{Resource}?param1=value1"); + + var output = client.BuildUri(request); + Assert.Equal(expected, output); + } + + [Fact] + public void Should_use_ipv6_address() { + var baseUrl = new Uri("https://[fe80::290:e8ff:fe8b:2537%en10]:8443"); + var request = new RestRequest("api/v1/auth"); + + using var client = new RestClient(baseUrl); + + var actual = client.BuildUri(request); + actual.HostNameType.Should().Be(UriHostNameType.IPv6); + actual.AbsoluteUri.Should().Be("https://[fe80::290:e8ff:fe8b:2537]:8443/api/v1/auth"); + } + + + [Fact] + public void BuildUri_should_build_with_passing_link_as_Uri() { + // arrange + var relative = new Uri("/foo/bar/baz", UriKind.Relative); + var absoluteUri = new Uri(new(Base), relative); + var req = new RestRequest(absoluteUri); + + // act + using var client = new RestClient(); + + var builtUri = client.BuildUri(req); + + // assert + absoluteUri.Should().Be(builtUri); + } + + [Fact] + public void BuildUri_should_build_with_passing_link_as_Uri_with_set_BaseUrl() { + // arrange + var baseUrl = new Uri(Base); + var relative = new Uri("/foo/bar/baz", UriKind.Relative); + var req = new RestRequest(relative); + + // act + using var client = new RestClient(baseUrl); + + var builtUri = client.BuildUri(req); + + // assert + new Uri(baseUrl, relative).Should().Be(builtUri); + } +} \ No newline at end of file