# encoding: ascii
# api: powershell
# title: New-ODataServiceProxy
# description: A wrapper for DataSvcUtil to generate web service proxies in-memory for OData services like NetFlix (which are not handled correctly by PowerShell’s built-in New-WebServiceProxy).
# version: 1.0
# type: function
# author: Joel Bennett
# license: CC0
# function: New-ODataServiceProxy
# x-poshcode-id: 2043
# x-derived-from-id: 2460
# x-archived: 2013-11-05T02:56:42
# x-published: 2010-08-03T14:35:00
#
# Also includes a type cache, because if you call it again with the same url it was throwing an error. NOTE: calling it with the same URL will generate a NEW context object (this is important to know if you start really working with this — we’re not caching the context, just the type information).
# This release fixed a minor compile issue if your host is reporting $PSVersionTable.CLRVersion.Major is 4 ;-)
# REQUIRES AT LEAST .Net 3.5 SP1 with the Data Services Update for Windows 7/2008 R2 or Windows XP/Vista/Server 2003/2008
# Note that this ships in the box with .Net Framework 4, but unless you’ve modified PoweShell ISE’s app.config, or are using PoshConsole, you can’t really use that, so you’ll need the latest 3.5 SP1 plus the Data Services Update.
#
function New-ODataServiceProxy {
#.Synopsis
# Creates a proxy class for an odata web service
# YOU NEED TO BE VERY CAREFUL NOT TO OUTPUT THE PROXY OBJECT TO THE POWERSHELL HOST!
#.Description
# Uses the data service client utility (DataSvcUtil.exe) to generate a proxy class (and types for all objects) for an OData web service.
# WARNING: Outputting this object to the PowerShell host will result in queriying all the object collections on the service.
#.Parameter URI
# The URI for the web service
#.Parameter Passthru
# Causes the method to output all of the types defined by the service metadata as well as the actual service object.
#.Example
# $proxy = New-ODataServiceProxy http://odata.netflix.com/Catalog/
# $AdventuresInOdyssey = $proxy.Titles.AddQueryOption('$filter',"substringof('Adventures in Odyssey',Name)")
# $AdventuresInOdyssey | Format-List Name, ReleaseYear, Url, Synopsis
#.Example
# function Get-Films {
# param($Name)
# $proxy = New-ODataServiceProxy http://odata.netflix.com/Catalog/
# if($Name -match "\*") {
# $sName = $Name -replace "\*"
# # Note the substring PLUS a Where -like filter to pull off wildcard matching which isn't supported by NetFlix
# $Global:Films = $proxy.Titles.AddQueryOption('$filter',"substringof('$sName',Name)") | Where { $_.Name -like $Name }
# } else {
# $Global:Films = $proxy.Titles.AddQueryOption('$filter',"'$Name' eq Name")
# }
# $Films | Format-List Name, ReleaseYear, AverageRating, Url, Synopsis
# Write-Host "NOTE: This data is cached in `$Films" -Fore Yellow
# }
#
# C:\PS>Get-Films Salt
#
#.Link http://msdn.microsoft.com/en-us/library/ee383989.aspx
#.Notes
# I can't stress enough that you should not output the object or any property that returns a System.Data.Services.Client.DataServiceQuery[T] without a filter unless you're sure that's what you want.
#
# ADO.NET Data Service Client Utility http://msdn.microsoft.com/en-us/library/ee383989.aspx
# AddQueryOption http://msdn.microsoft.com/en-us/library/cc646860.aspx
# NetFlix Catalog http://developer.netflix.com/docs/oData_Catalog
# Data Services Update for .Net 3.5 SP1 http://support.microsoft.com/kb/982307
#
# VERSION HISTORY:
# v1.0 - 2010 Aug 02 - First Version http://poshcode.org/2039
# v1.1 - 2010 Aug 03 - Simple Caching http://poshcode.org/2040
# - Added a type cache to make it easier to find proxies you've already compiled (because we can't recompile them)
# v1.2 - 2010 Aug 03 - Examples
# - Added additional examples
# v1.3 - 2010 Aug 03 - This Version
# - Removed the -Language parameter from Add-Type when on .Net4 (setting it explicitly results in downgrading to 3, and having multiple assembly references!?)
param( $URI = "http://odata.netflix.com/Catalog/", [switch]$Passthru )
if(!(Test-Path Variable::Global:ODataServices)){
## You can only use this on .Net 4 or .Net 3.5 SP1
## For .Net 3.5 SP1 you need to download http://support.microsoft.com/kb/982307
## If you don't have it, this won't succeed
[Reflection.Assembly]::Load("System.Data.Services.Client, Version=3.5.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089") | Out-Null
$global:ODataServices = @{}
}
$normalized = ([uri]$URI).AbsoluteUri.TrimEnd("/")
if($global:ODataServices.ContainsKey($normalized)) {
New-Object $global:ODataServices.$normalized.ContextType $URI
if($Passthru) {
$global:ODataServices.$normalized.OtherTypes
}
return
}
## Find the right DataSvcUtil for this version of .Net
switch($PSVersionTable.ClrVersion.Major) {
4 { # PoshConsole and modded .Net4 PowerShell_ISE etc.
Set-Alias Get-ODataServiceDefinition (Get-ChildItem ([System.Runtime.InteropServices.RuntimeEnvironment]::GetRuntimeDirectory()) DataSvcUtil.exe)
break
}
2 { # PowerShell.exe and everyone else
$FrameworkPath = [System.Runtime.InteropServices.RuntimeEnvironment]::GetRuntimeDirectory() | Split-Path
Set-Alias Get-ODataServiceDefinition (Get-ChildItem $FrameworkPath\v3.5\DataSvcUtil.exe)
break
}
default { throw "The script is out of date, please fix it and upload a new one to PoshCode!" }
}
## Get the service definition into a string via a temp file
$temp = [IO.Path]::GetTempFileName()
Get-ODataServiceDefinition -out:$temp -uri:$URI -nologo | Out-Null
$code = @(Get-Content $temp) -join "`n" # -Delim ([char]0)
Remove-Item $temp
switch($PSVersionTable.ClrVersion.Major) {
4 {
$Types = Add-Type $code -Reference "System.Data.Services.Client, Version=3.5.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089", "System.Core" -Passthru
}
2 {
$Types = Add-Type $code -Reference "System.Data.Services.Client, Version=3.5.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089" -Passthru -Language CSharpVersion3
}
default { throw "The script is out of date, please fix it and upload a new one to PoshCode!" }
}
if(!$Types) { return }
$ContextType = $Types | Where-Object { $_.BaseType -eq [System.Data.Services.Client.DataServiceContext] }
$global:ODataServices.$normalized = New-Object PSObject -Property @{ContextType=$ContextType; OtherTypes=$([Type[]]($Types|Where-Object{$_.BaseType -ne [System.Data.Services.Client.DataServiceContext]}))}
$ctx = new-object $ContextType $URI
Write-Output $ctx
if($Passthru) { Write-Output $types }
}