News

Click here for the latest information on what has been happening with the project...

What is FluentGeoApi?

It's a .Net 3.5/C# wrapper to the api from GeoApi.com. The wrapper uses a "fluent" style to simplify GeoApi interaction and use. It completely hides the underlying REST interface and Json (GeoJson) wire format so you can get on with putting the awesome GeoApi to use in your .Net application.

For example to do a simple search the syntax is,

var searchResult = SimpleSearch.CentredOn(-122.421218M, 37.75647M)
.Radius().Is(0.1M).Kilometers()
.UseDemoApiKey()
// other fluent methods...
// .FormatPretty()
// .LimitResultsTo(5)
// .Type().Is().Business(), POI(), Intersection() etc...
.Execute()
.Deserialise();

// access properties of strongly typed object, examples...
// searchResult.Query.Type
// searchResult.Query.Parameters["num-results"]
// searchResult.Result[0].DistanceInMeters
// searchResult.Result[0].Metadata.Name
// searchResult.Result[0].Metadata.Views.Count()
// searchResult.Result[0].Metadata.ShortUrl

The excellent Json.Net library is used to do all the json heavylifting and big kudos to JNK for making this and my life simpler!

Coverage

The code is still in development however GeoApi methods that work are,

• Application User Entity
• Create/Update
• Delete
• Search
• Simple Search
• Keyword Search

There is over 100 unit (behaviour) tests already and all major functionality is covered.

Api Methods Not Covered YET

I aim to get the wrapper 100% complete against the v1 GeoApi but as it stands the following methods are not available in the wrapper,

• Parents Methods
• Search
• MQL Search
• View
• User
• Listing
• Media

Limitations

The geometry used by GeoApi follows the GeoJson specification. I have created a separate assembly that this wrapper uses (and is included with it) to read and write GeoJson however I have not completed support for all geometry types yet. This matrix shows the current support,

(where Read means this geometry type coming back from GeoApi can be deserialised into a strongly typed object and Write means it can be serialised and sent to GeoApi). However, as long as you don't try to deserialise the json that comes back all calls will work - you just can't convert the json result into a strongly type .Net object but you can still access it.

Project Status

• Still active - I wrote this wrapper for another project of mine and although it implements all the functionality I need I see it as a personal goal to get it to 100% GeoApi coverage - I'm particularly excited about how a fluent interface style can help build MQL searches.
• No plans expose the code for collaboration. It is possible though, the code is hosted on a private project at Unfuddle using Subversion source control so if you feel like you want to contribute then I could be persuaded to add you to this project.

Still with me?

Great! The wiki is the place to start learning about how to use FluentGeoApi, here you will find help creating your entities, deleting them, performing simple and keyword searches