Get a random gif from Giphy. ***NOTE: Invoke-TerminalGif was moved to MSTerminalSettings module***

Search-Giphy.ps1

#requires -module msterminalsettings,threadjob

###QUICKSTART
#FIRST: Run this in your Powershell Windows Terminal: Install-Module threadjob,msterminalsettings -scope currentuser
#THEN: iex (iwr git.io/invoketerminalgif)
#THEN: Get-Help Search-Giphy -Examples
#THEN: Get-Help Invoke-TerminalGif -Examples
#THEN: Search-Giphy | Format-List -prop *
#THEN: Invoke-TerminalGif https://media.giphy.com/media/g9582DNuQppxC/giphy.gif


function Search-Giphy {
    <#
.SYNOPSIS
    Fetches Gif Information and direct Gif Links from Giphy, a meme delivery service
.DESCRIPTION
    This is a frontend to the Giphy API to find and request gifs from Giphy. It implements the API described here: https://developers.giphy.com/docs/api/
.EXAMPLE
    PS> Search-Giphy
    Returns a random gif information object
    title          bitly_url              username source
    -----          ---------              -------- ------
    nick jonas GIF https://gph.is/1SR6uiv          https://ddlovatosrps.tumblr.com/post/120447116655/positive-nick-jonas-gif-hunt-under-the-cut-you
.EXAMPLE
    PS> Search-Giphy -ImageType Sticker
    Returns a random sticker information object
    title                                                             bitly_url              username source
    -----                                                             ---------              -------- ------
    festival woodstock Sticker by Wielka Orkiestra Świątecznej Pomocy https://gph.is/2mZ7V2k WOSP
.EXAMPLE
    PS> Search-Giphy -DirectURL
    Returns only the direct link to a random gif
    https://media3.giphy.com/media/q9WSYOP1KUlgc/giphy.gif?cid=f499c4a35d19a6596653673632f7ddec&rid=giphy.gif
.EXAMPLE
    PS> Search-Giphy -Filter "Excited"
    Returns GIFs that match 'Excited'
.EXAMPLE
    PS> Search-Giphy -Filter Excited -Channel reactions -tag cat -first 3
    Returns 3 GIFs that match 'Excited' in the reactions channel with tag of Cat
.EXAMPLE
    PS> Search-Giphy -Trending -First 3
    Get the top 3 trending gifs
.EXAMPLE
    PS> Search-Giphy -Translate -Phrase "cute flying bat" -Weirdness 5
    Translates the phrase "cute flying bat" to a Gif with a weirdness factor of 5 using Giphy's special sauce
.EXAMPLE
    PS> Search-Giphy -Translate -Phrase "cute flying bat" -Weirdness 5 -DirectUrl
    Translate the phrase "cute flying bat" to a gif with a Weirdness rating of 5.
.NOTES
    Created 2019 by Justin Grote
    The giphy public beta API key is embedded in this script and is subject to very frequent rate limiting. You can sign up for your own free Giphy API key, just be aware no special means in this script are used to "protect" the key.
    Recommendation so you don't have to specify it each time: $PSDefaultParameterValues['Search-Giphy:ApiKey'] = 'yourapikey'
#>
    [CmdletBinding(SupportsPaging, DefaultParameterSetName = 'random')]
    param (
        #If performing a search, this is a query string of a word or phrase to find. If using -Translate, this is the phrase you want to convert to a gif
        [Parameter(Mandatory, Position = 0, ParameterSetName = 'search')]
        [String]$Filter,

        #If performing a search, limit to a verified channel. This is the same as specifying "@channelname" in the Filter parameter
        [Parameter(Position = 2, ParameterSetName = 'search')]
        [String]$Channel,

        #Specify a phrase and gfycat will translate that phrase into a gif
        [Parameter(Mandatory, Position = 1, ParameterSetName = 'translate')]
        [String]$Phrase,

        #Specify a weirdness factor from 0 to 10. The translations will get weirder the higher number you specify
        [Parameter(ParameterSetName = 'translate')]
        [ValidateRange(0, 10)][int]$Weirdness,

        [Parameter(Position = 1, ParameterSetName = 'search')]
        [Parameter(Position = 1, ParameterSetName = 'random')]
        [String]$Tag,

        #Search Trending Gifs
        [Parameter(Position = 0, Mandatory, ParameterSetName = 'trending')][Switch]$Trending,

        #Perform a gif translate, which will use the giphy "secret sauce" to make your phrase into a gif
        [Parameter(Position = 0, Mandatory, ParameterSetName = 'translate')][Switch]$Translate,

        #Fetch a random gif
        [Parameter(ParameterSetName = 'random')][Switch]$Random,

        #Specifying this switch will only return the original URI of a gif or gifs, which is easier to integrate into tools
        [Switch]$DirectURL,

        #Type of image (Gif or Sticker). Defaults to Gif.
        [ValidateSet('Gif', 'Sticker')]$ImageType = 'Gif',

        #Content rating of the gif. Specify G, PG, PG-13, or R. Searches PG gifs by default.
        [ValidateSet('G', 'PG', 'PG-13', 'R')][String]$Rating = 'PG',

        #API Key. Defaults to the Giphy Public Beta Key. It is recommended you register your own apikey at Giphy and use it
        [String]$APIKey = 'dc6zaTOxFJmzC'
    )

    function Join-Uri ([string]$uri, [string]$relativePath) {
        [uri]::new([uri]"$uri/", $relativePath)
    }

    $erroractionPreference = 'stop'
    $baseuri = "https://api.giphy.com/v1"
    $requestUri = Join-Uri -uri $baseuri -relativepath "${ImageType}s".toLower()
    $requestUri = Join-Uri $requestUri $PSCmdlet.ParameterSetName.toLower()

    $irmParams = @{
        UseBasicParsing = $true
        Method          = 'Get'
        URI             = $requestUri
        BODY            = [ordered]@{
            api_key = $APIKey
            rating  = $Rating
        }
    }

    $queryParams = $irmparams.body

    switch ($PSCmdlet.ParameterSetName) {
        'search' {
            $queryParams.q = $Filter
            if ($tag) { [string]$queryParams.q = "#$tag " + $queryParams.q }
            if ($channel) { [string]$queryParams.q = "@$channel " + $queryParams.q }
        }
        'translate' {
            $queryParams.s = $Phrase
            if ($Weirdness) { $queryParams.weirdness = $Weirdness }
        }
        'random' {
            if ($tag) { $queryParams.tag = $Tag }
        }
    }

    if ($PSCmdlet.PagingParameters.First -and $PSCmdlet.PagingParameters.First -ne 18446744073709551615) { $queryParams.limit = $PSCmdlet.PagingParameters.First }
    if ($PSCmdlet.PagingParameters.Skip) { $queryParams.body.offset = $PSCmdlet.PagingParameters.Skip }

    $GiphyResult = Invoke-RestMethod @irmParams -ErrorAction Stop
    $GiphyResultData = $GiphyResult.data

    if (-not $DirectUrl) {
        if (-not (Get-TypeData giphy.image)) { Update-TypeData -TypeName Giphy.Image -DefaultDisplayPropertySet title, bitly_url, username, source }
        $GiphyResultData | ForEach-Object {
            $PSItem.PSObject.TypeNames.Insert(0, 'Giphy.Image')
            $PSItem
        }
    } else {
        $GiphyResultData.images.original.url
    }
}

This is awesome! Did it break for you too with Terminal 0.4.2382.0?

Yep it broke on 0.4, I think it's because they moved the profiles.json from roamingstate to localstate. I'll look into it when I get a sec

Yup, looks like Get-MSTerminalProfile is looking in roaming state.

@arnydo it's dependent on this issue I just created: gpduck/MSTerminalSettings#35

Hi. I found amazing your work with PS and the whole idea, but it seems broken in v0.5.276.0 too. The command Search-Giphy works fine, but Invoke-TerminalGif on the first run does nothing, and when we run it a second time it returns a warning WARNING: Invoke Terminal Already Running

Try Get-MSTerminalProfile, if that throws an error then there's something in the config msterminalsettings doesn't like, so this is probably a downstream issue.

For me, I got this on 0.5 with Invalid JSON Primitive, I'll look into it when I have time.

It probably broke because of gpduck/MSTerminalSettings#42

…

On Wed, Oct 16, 2019 at 7:49 AM Vinícius Haga ***@***.***> wrote: Hi. I found amazing your work with PS and the whole idea, but it seems broken in v0.5.276.0 too. The command Search-Giphy works fine, but Invoke-TerminalGif on the first run does nothing, and when we run it a second time it returns a warning *WARNING: Invoke Terminal Already Running* — You are receiving this because you authored the thread. Reply to this email directly, view it on GitHub <https://gist.github.com/2fb8e60ce70b3a05a94debf6bfc6b057?email_source=notifications&email_token=ADUNKUV6ADFX3J2DTR2NGPTQO4SV3A5CNFSM4IT5P7V2YY3PNVWWK3TUL52HS4DFVNDWS43UINXW23LFNZ2KUY3PNVWWK3TUL5UWJTQAF2SXO#gistcomment-3057015>, or unsubscribe <https://github.com/notifications/unsubscribe-auth/ADUNKUVXJL7KJCDIWCWUSH3QO4SV3ANCNFSM4IT5P7VQ> .

Oh it just worked. It happens my Terminal wasn't with a Execution Policy set, so internally it was blocking execution from your ps, although IEX didn't complain at all (I'm not sure if it should). The down side is that I had to change the currentUser and localMachine execution policy to Unrestricted, which is something I don't desire in the long run.

RemoteSigned should be sufficient, when using IEX it is *technically* considered local.

…

On Wed, Oct 16, 2019, 11:09 AM Vinícius Haga ***@***.***> wrote: Oh it just worked. It happens my Terminal wasn't with a Execution Policy set, so internally it was blocking execution from your ps, although IEX didn't complain at all (I'm not sure if it should). The down side is that I had to change the currentUser and *localMachine* execution policy to *Unrestricted*, which is something I don't desire in the long run. — You are receiving this because you authored the thread. Reply to this email directly, view it on GitHub <https://gist.github.com/2fb8e60ce70b3a05a94debf6bfc6b057?email_source=notifications&email_token=ADUNKURSTII2GF44T7FV2NDQO5KHJA5CNFSM4IT5P7V2YY3PNVWWK3TUL52HS4DFVNDWS43UINXW23LFNZ2KUY3PNVWWK3TUL5UWJTQAF2THI#gistcomment-3057268>, or unsubscribe <https://github.com/notifications/unsubscribe-auth/ADUNKUTI3H3MQP7IQ5QQJQDQO5KHJANCNFSM4IT5P7VQ> .

I don't understand how to stop the terminal GIF. It just keeps looping and subsequent invocations say that a GIF is already running.

It's supposed to auto-stop, and it does that by editing the json settings again to remove the background. You can do it manually if it doesn't work. I will try to take a look at it and make it more robust, it was a fast and loose proof of concept :)

…

On Thu, Oct 17, 2019, 9:49 AM Anthony Mastrean ***@***.***> wrote: I don't understand how to *stop* the terminal GIF. It just keeps looping and subsequent invocations say that a GIF is already running. — You are receiving this because you authored the thread. Reply to this email directly, view it on GitHub <https://gist.github.com/2fb8e60ce70b3a05a94debf6bfc6b057?email_source=notifications&email_token=ADUNKUVR5BADNBUPDDDJ7Q3QPCJP5A5CNFSM4IT5P7V2YY3PNVWWK3TUL52HS4DFVNDWS43UINXW23LFNZ2KUY3PNVWWK3TUL5UWJTQAF2VI4#gistcomment-3058318>, or unsubscribe <https://github.com/notifications/unsubscribe-auth/ADUNKUTNOMHUVTUFKGPS5C3QPCJP5ANCNFSM4IT5P7VQ> .

Hanselman tweeted your script, so you're gonna blow up! This is an awesome idea and a good script. I think you should put it in a regular repo and let randos from the Internet send PRs until it's ready to publish on the PowerShell Gallery!

@AnthonyMastrean I plan to do a pull request to MSTerminalSettings module for it to live there. Stay tuned!

Just put this in my profile. Thanks for the work. Everything appears to work well in Core 7.3.1.

FYI, the public beta key ( e.g. dc6zaTOxFJmzC ) is BANNED so I had to make an account.

@mattcargile thanks, yeah I think they stopped allowing the public key so I'll probably have ot modify it to make the API key be required to be supplied.

Good deal, @JustinGrote . I just forked it and made some changes.

Just made it a Mandatory [securestring]. Then I removed the #Requires and moved the QUICKSTART to comment-based help Notes. Then I updated the example in the Notes

Good deal, @JustinGrote . I just forked it and made some changes.

Just made it a Mandatory [securestring]. Then I removed the #Requires and moved the QUICKSTART to comment-based help Notes. Then I updated the example in the Notes

Neat, I wrote this years ago so I'm sure if I looked at again I'd be like "ugh, what was I thinking" and completely rewrite it :)

Heard that! 💯 👍