Be more forgiving about the source of the attributes (#129)

ConsumePlugin/GeneratedRestClient.fs

@@ -1140,6 +1140,69 @@ module ApiWithHeaders =
             member _.SomeHeader : string = someHeader ()
             member _.SomeOtherHeader : int = someOtherHeader ()
 
+            member this.GetPathParam (parameter : string, ct : CancellationToken option) =
+                async {
+                    let! ct = Async.CancellationToken
+
+                    let uri =
+                        System.Uri (
+                            (match client.BaseAddress with
+                             | null ->
+                                 raise (
+                                     System.ArgumentNullException (
+                                         nameof (client.BaseAddress),
+                                         "No base address was supplied on the type, and no BaseAddress was on the HttpClient."
+                                     )
+                                 )
+                             | v -> v),
+                            System.Uri (
+                                "endpoint/{param}"
+                                    .Replace ("{param}", parameter.ToString () |> System.Web.HttpUtility.UrlEncode),
+                                System.UriKind.Relative
+                            )
+                        )
+
+                    let httpMessage =
+                        new System.Net.Http.HttpRequestMessage (
+                            Method = System.Net.Http.HttpMethod.Get,
+                            RequestUri = uri
+                        )
+
+                    do httpMessage.Headers.Add ("X-Foo", this.SomeHeader.ToString ())
+                    do httpMessage.Headers.Add ("Authorization", this.SomeOtherHeader.ToString ())
+                    do httpMessage.Headers.Add ("Header-Name", "Header-Value")
+                    let! response = client.SendAsync (httpMessage, ct) |> Async.AwaitTask
+                    let response = response.EnsureSuccessStatusCode ()
+                    let! responseString = response.Content.ReadAsStringAsync ct |> Async.AwaitTask
+                    return responseString
+                }
+                |> (fun a -> Async.StartAsTask (a, ?cancellationToken = ct))
+        }
+namespace PureGym
+
+open System
+open System.Threading
+open System.Threading.Tasks
+open System.IO
+open System.Net
+open System.Net.Http
+open RestEase
+
+/// Module for constructing a REST client.
+[<CompilationRepresentation(CompilationRepresentationFlags.ModuleSuffix)>]
+[<RequireQualifiedAccess>]
+module ApiWithHeaders2 =
+    /// Create a REST client. The input functions will be re-evaluated on every HTTP request to obtain the required values for the corresponding header properties.
+    let make
+        (someHeader : unit -> string)
+        (someOtherHeader : unit -> int)
+        (client : System.Net.Http.HttpClient)
+        : IApiWithHeaders2
+        =
+        { new IApiWithHeaders2 with
+            member _.SomeHeader : string = someHeader ()
+            member _.SomeOtherHeader : int = someOtherHeader ()
+
             member this.GetPathParam (parameter : string, ct : CancellationToken option) =
                 async {
                     let! ct = Async.CancellationToken

ConsumePlugin/RestApiExample.fs

@@ -120,7 +120,8 @@ type internal IApiWithoutBaseAddress =
 [<WoofWare.Myriad.Plugins.HttpClient>]
 [<BasePath "foo">]
 type IApiWithBasePath =
-    [<Get "endpoint/{param}">]
+    // Example where we use the bundled attributes rather than RestEase's
+    [<WoofWare.Myriad.Plugins.RestEase.Get "endpoint/{param}">]
     abstract GetPathParam : [<Path "param">] parameter : string * ?cancellationToken : CancellationToken -> Task<string>
 
 [<WoofWare.Myriad.Plugins.HttpClient>]
@@ -141,3 +142,16 @@ type IApiWithHeaders =
 
     [<Get "endpoint/{param}">]
     abstract GetPathParam : [<Path "param">] parameter : string * ?ct : CancellationToken -> Task<string>
+
+[<WoofWare.Myriad.Plugins.HttpClient>]
+[<WoofWare.Myriad.Plugins.RestEase.Header("Header-Name", "Header-Value")>]
+type IApiWithHeaders2 =
+    [<WoofWare.Myriad.Plugins.RestEase.Header "X-Foo">]
+    abstract SomeHeader : string
+
+    [<WoofWare.Myriad.Plugins.RestEase.Header "Authorization">]
+    abstract SomeOtherHeader : int
+
+    [<Get "endpoint/{param}">]
+    abstract GetPathParam :
+        [<WoofWare.Myriad.Plugins.RestEase.Path "param">] parameter : string * ?ct : CancellationToken -> Task<string>

WoofWare.Myriad.Plugins.Attributes/RestEase.fs

@@ -0,0 +1,63 @@
+namespace WoofWare.Myriad.Plugins
+
+open System
+
+/// Module containing duplicates of the supported RestEase attributes, in case you don't want
+/// to take a dependency on RestEase.
+[<RequireQualifiedAccess>]
+module RestEase =
+    /// Indicates that a method represents an HTTP Get query to the specified endpoint.
+    type GetAttribute (path : string) =
+        inherit Attribute ()
+
+    /// Indicates that a method represents an HTTP Post query to the specified endpoint.
+    type PostAttribute (path : string) =
+        inherit Attribute ()
+
+    /// Indicates that a method represents an HTTP Delete query to the specified endpoint.
+    type DeleteAttribute (path : string) =
+        inherit Attribute ()
+
+    /// Indicates that a method represents an HTTP Head query to the specified endpoint.
+    type HeadAttribute (path : string) =
+        inherit Attribute ()
+
+    /// Indicates that a method represents an HTTP Options query to the specified endpoint.
+    type OptionsAttribute (path : string) =
+        inherit Attribute ()
+
+    /// Indicates that a method represents an HTTP Put query to the specified endpoint.
+    type PutAttribute (path : string) =
+        inherit Attribute ()
+
+    /// Indicates that a method represents an HTTP Patch query to the specified endpoint.
+    type PatchAttribute (path : string) =
+        inherit Attribute ()
+
+    /// Indicates that a method represents an HTTP Trace query to the specified endpoint.
+    type TraceAttribute (path : string) =
+        inherit Attribute ()
+
+    /// Indicates that this argument to a method is interpolated into the HTTP request at runtime
+    /// by setting a query parameter (with the given name) to the value of the annotated argument.
+    type QueryAttribute (paramName : string) =
+        inherit Attribute ()
+
+    /// Indicates that this interface represents a REST client which accesses an API whose paths are
+    /// all relative to the given address.
+    type BaseAddressAttribute (addr : string) =
+        inherit Attribute ()
+
+    /// Indicates that this interface member causes the interface to set a header with the given name,
+    /// whose value is obtained whenever required by a fresh call to the interface member.
+    type HeaderAttribute (header : string, value : string option) =
+        inherit Attribute ()
+        new (header : string) = HeaderAttribute (header, None)
+        new (header : string, value : string) = HeaderAttribute (header, Some value)
+
+    /// Indicates that this argument to a method is interpolated into the request path at runtime
+    /// by writing it into the templated string that specifies the HTTP query e.g. in the `[<Get "/foo/{template}">]`.
+    type PathAttribute (path : string option) =
+        inherit Attribute ()
+        new (path : string) = PathAttribute (Some path)
+        new () = PathAttribute None

WoofWare.Myriad.Plugins.Attributes/SurfaceBaseline.txt

@@ -18,4 +18,33 @@ WoofWare.Myriad.Plugins.JsonSerializeAttribute..ctor [constructor]: unit
 WoofWare.Myriad.Plugins.JsonSerializeAttribute.DefaultIsExtensionMethod [static property]: [read-only] bool
 WoofWare.Myriad.Plugins.JsonSerializeAttribute.get_DefaultIsExtensionMethod [static method]: unit -> bool
 WoofWare.Myriad.Plugins.RemoveOptionsAttribute inherit System.Attribute
-WoofWare.Myriad.Plugins.RemoveOptionsAttribute..ctor [constructor]: unit
+WoofWare.Myriad.Plugins.RemoveOptionsAttribute..ctor [constructor]: unit
+WoofWare.Myriad.Plugins.RestEase inherit obj
+WoofWare.Myriad.Plugins.RestEase+BaseAddressAttribute inherit System.Attribute
+WoofWare.Myriad.Plugins.RestEase+BaseAddressAttribute..ctor [constructor]: string
+WoofWare.Myriad.Plugins.RestEase+DeleteAttribute inherit System.Attribute
+WoofWare.Myriad.Plugins.RestEase+DeleteAttribute..ctor [constructor]: string
+WoofWare.Myriad.Plugins.RestEase+GetAttribute inherit System.Attribute
+WoofWare.Myriad.Plugins.RestEase+GetAttribute..ctor [constructor]: string
+WoofWare.Myriad.Plugins.RestEase+HeadAttribute inherit System.Attribute
+WoofWare.Myriad.Plugins.RestEase+HeadAttribute..ctor [constructor]: string
+WoofWare.Myriad.Plugins.RestEase+HeaderAttribute inherit System.Attribute
+WoofWare.Myriad.Plugins.RestEase+HeaderAttribute..ctor [constructor]: (string, string option)
+WoofWare.Myriad.Plugins.RestEase+HeaderAttribute..ctor [constructor]: (string, string)
+WoofWare.Myriad.Plugins.RestEase+HeaderAttribute..ctor [constructor]: string
+WoofWare.Myriad.Plugins.RestEase+OptionsAttribute inherit System.Attribute
+WoofWare.Myriad.Plugins.RestEase+OptionsAttribute..ctor [constructor]: string
+WoofWare.Myriad.Plugins.RestEase+PatchAttribute inherit System.Attribute
+WoofWare.Myriad.Plugins.RestEase+PatchAttribute..ctor [constructor]: string
+WoofWare.Myriad.Plugins.RestEase+PathAttribute inherit System.Attribute
+WoofWare.Myriad.Plugins.RestEase+PathAttribute..ctor [constructor]: string
+WoofWare.Myriad.Plugins.RestEase+PathAttribute..ctor [constructor]: string option
+WoofWare.Myriad.Plugins.RestEase+PathAttribute..ctor [constructor]: unit
+WoofWare.Myriad.Plugins.RestEase+PostAttribute inherit System.Attribute
+WoofWare.Myriad.Plugins.RestEase+PostAttribute..ctor [constructor]: string
+WoofWare.Myriad.Plugins.RestEase+PutAttribute inherit System.Attribute
+WoofWare.Myriad.Plugins.RestEase+PutAttribute..ctor [constructor]: string
+WoofWare.Myriad.Plugins.RestEase+QueryAttribute inherit System.Attribute
+WoofWare.Myriad.Plugins.RestEase+QueryAttribute..ctor [constructor]: string
+WoofWare.Myriad.Plugins.RestEase+TraceAttribute inherit System.Attribute
+WoofWare.Myriad.Plugins.RestEase+TraceAttribute..ctor [constructor]: string

WoofWare.Myriad.Plugins.Attributes/Test/TestSurface.fs

@@ -11,11 +11,9 @@ module TestSurface =
     [<Test>]
     let ``Ensure API surface has not been modified`` () = ApiSurface.assertIdentical assembly
 
-    (*
     [<Test>]
     let ``Check version against remote`` () =
         MonotonicVersion.validate assembly "WoofWare.Myriad.Plugins.Attributes"
-    *)
 
     [<Test ; Explicit>]
     let ``Update API surface`` () =

WoofWare.Myriad.Plugins.Attributes/WoofWare.Myriad.Plugins.Attributes.fsproj

@@ -19,6 +19,7 @@
 
   <ItemGroup>
     <Compile Include="Attributes.fs"/>
+    <Compile Include="RestEase.fs" />
     <EmbeddedResource Include="version.json"/>
     <EmbeddedResource Include="SurfaceBaseline.txt"/>
     <None Include="..\README.md">

WoofWare.Myriad.Plugins.Attributes/version.json

@@ -1,7 +1,7 @@
 {
-  "version": "2.2",
+  "version": "3.0",
   "publicReleaseRefSpec": [
     "^refs/heads/main$"
   ],
   "pathFilters": null
-}
+}

WoofWare.Myriad.Plugins/HttpClientGenerator.fs

@@ -1,8 +1,6 @@
 namespace WoofWare.Myriad.Plugins
 
-open System
 open System.Net.Http
-open System.Text
 open Fantomas.FCS.Syntax
 open Fantomas.FCS.SyntaxTrivia
 open Fantomas.FCS.Xml
@@ -82,34 +80,50 @@ module internal HttpClientGenerator =
                 match attr.TypeName.AsString with
                 | "Get"
                 | "GetAttribute"
+                | "WoofWare.Myriad.Plugins.RestEase.Get"
+                | "WoofWare.Myriad.Plugins.RestEase.GetAttribute"
                 | "RestEase.Get"
                 | "RestEase.GetAttribute" -> Some (HttpMethod.Get, attr.ArgExpr)
                 | "Post"
                 | "PostAttribute"
+                | "WoofWare.Myriad.Plugins.RestEase.Post"
+                | "WoofWare.Myriad.Plugins.RestEase.PostAttribute"
                 | "RestEase.Post"
                 | "RestEase.PostAttribute" -> Some (HttpMethod.Post, attr.ArgExpr)
                 | "Put"
                 | "PutAttribute"
+                | "WoofWare.Myriad.Plugins.RestEase.Put"
+                | "WoofWare.Myriad.Plugins.RestEase.PutAttribute"
                 | "RestEase.Put"
                 | "RestEase.PutAttribute" -> Some (HttpMethod.Put, attr.ArgExpr)
                 | "Delete"
                 | "DeleteAttribute"
+                | "WoofWare.Myriad.Plugins.RestEase.Delete"
+                | "WoofWare.Myriad.Plugins.RestEase.DeleteAttribute"
                 | "RestEase.Delete"
                 | "RestEase.DeleteAttribute" -> Some (HttpMethod.Delete, attr.ArgExpr)
                 | "Head"
                 | "HeadAttribute"
+                | "WoofWare.Myriad.Plugins.RestEase.Head"
+                | "WoofWare.Myriad.Plugins.RestEase.HeadAttribute"
                 | "RestEase.Head"
                 | "RestEase.HeadAttribute" -> Some (HttpMethod.Head, attr.ArgExpr)
                 | "Options"
                 | "OptionsAttribute"
+                | "WoofWare.Myriad.Plugins.RestEase.Options"
+                | "WoofWare.Myriad.Plugins.RestEase.OptionsAttribute"
                 | "RestEase.Options"
                 | "RestEase.OptionsAttribute" -> Some (HttpMethod.Options, attr.ArgExpr)
                 | "Patch"
                 | "PatchAttribute"
+                | "WoofWare.Myriad.Plugins.RestEase.Patch"
+                | "WoofWare.Myriad.Plugins.RestEase.PatchAttribute"
                 | "RestEase.Patch"
                 | "RestEase.PatchAttribute" -> Some (HttpMethod.Patch, attr.ArgExpr)
                 | "Trace"
                 | "TraceAttribute"
+                | "WoofWare.Myriad.Plugins.RestEase.Trace"
+                | "WoofWare.Myriad.Plugins.RestEase.TraceAttribute"
                 | "RestEase.Trace"
                 | "RestEase.TraceAttribute" -> Some (HttpMethod.Trace, attr.ArgExpr)
                 | _ -> None
@@ -127,7 +141,8 @@ module internal HttpClientGenerator =
         |> List.choose (fun attr ->
             match attr.TypeName.AsString with
             | "Header"
-            | "RestEase.Header" ->
+            | "RestEase.Header"
+            | "WoofWare.Myriad.Plugins.RestEase.Header" ->
                 match attr.ArgExpr with
                 | SynExpr.Paren (SynExpr.Tuple (_, [ v1 ; v2 ], _, _), _, _, _) ->
                     Some [ SynExpr.stripOptionalParen v1 ; SynExpr.stripOptionalParen v2 ]
@@ -709,6 +724,10 @@ module internal HttpClientGenerator =
         attrs
         |> List.choose (fun attr ->
             match attr.TypeName.AsString with
+            | "RestEase.Query"
+            | "RestEase.QueryAttribute"
+            | "WoofWare.Myriad.Plugins.RestEase.Query"
+            | "WoofWare.Myriad.Plugins.RestEase.QueryAttribute"
             | "Query"
             | "QueryAttribute" ->
                 match attr.ArgExpr with
@@ -717,6 +736,10 @@ module internal HttpClientGenerator =
                     Some (HttpAttribute.Query (Some s))
                 | SynExpr.Const (a, _) -> failwith $"unrecognised constant arg to the Query attribute: %+A{a}"
                 | _ -> None
+            | "RestEase.Path"
+            | "RestEase.PathAttribute"
+            | "WoofWare.Myriad.Plugins.RestEase.Path"
+            | "WoofWare.Myriad.Plugins.RestEase.PathAttribute"
             | "Path"
             | "PathAttribute" ->
                 match attr.ArgExpr with
@@ -725,6 +748,10 @@ module internal HttpClientGenerator =
                 | SynExpr.Const (SynConst.Unit, _) -> Some (HttpAttribute.Path PathSpec.MatchArgName)
                 | SynExpr.Const (a, _) -> failwith $"unrecognised constant arg to the Path attribute: %+A{a}"
                 | _ -> None
+            | "RestEase.Body"
+            | "RestEase.BodyAttribute"
+            | "WoofWare.Myriad.Plugins.RestEase.Body"
+            | "WoofWare.Myriad.Plugins.RestEase.BodyAttribute"
             | "Body"
             | "BodyAttribute" ->
                 match attr.ArgExpr with
@@ -740,8 +767,10 @@ module internal HttpClientGenerator =
             match attr.TypeName.AsString with
             | "BasePath"
             | "RestEase.BasePath"
+            | "WoofWare.Myriad.Plugins.RestEase.BasePath"
             | "BasePathAttribute"
-            | "RestEase.BasePathAttribute" -> Some attr.ArgExpr
+            | "RestEase.BasePathAttribute"
+            | "WoofWare.Myriad.Plugins.RestEase.BasePathAttribute" -> Some attr.ArgExpr
             | _ -> None
         )
 
@@ -751,8 +780,10 @@ module internal HttpClientGenerator =
             match attr.TypeName.AsString with
             | "BaseAddress"
             | "RestEase.BaseAddress"
+            | "WoofWare.Myriad.Plugins.RestEase.BaseAddress"
             | "BaseAddressAttribute"
-            | "RestEase.BaseAddressAttribute" -> Some attr.ArgExpr
+            | "RestEase.BaseAddressAttribute"
+            | "WoofWare.Myriad.Plugins.RestEase.BaseAddressAttribute" -> Some attr.ArgExpr
             | _ -> None
         )