yesod-newsfeed-1.7.0.0/Yesod/0000755000000000000000000000000013545077026014060 5ustar0000000000000000yesod-newsfeed-1.7.0.0/Yesod/AtomFeed.hs0000644000000000000000000001015213545077026016077 0ustar0000000000000000{-# LANGUAGE QuasiQuotes #-} {-# LANGUAGE RecordWildCards #-} {-# LANGUAGE OverloadedStrings #-} {-# LANGUAGE CPP #-} {-# LANGUAGE GeneralizedNewtypeDeriving #-} --------------------------------------------------------- -- -- Module : Yesod.AtomFeed -- Copyright : Michael Snoyman -- License : BSD3 -- -- Maintainer : Michael Snoyman -- Stability : Stable -- Portability : portable -- -- Generating atom news feeds. -- --------------------------------------------------------- -- | Generation of Atom newsfeeds. module Yesod.AtomFeed ( atomFeed , atomFeedText , atomLink , RepAtom (..) , module Yesod.FeedTypes ) where import Yesod.Core import Yesod.FeedTypes import qualified Data.ByteString.Char8 as S8 import Data.Text (Text) import Data.Text.Lazy (toStrict) import Text.XML import Text.Blaze.Html.Renderer.Text (renderHtml) import qualified Data.Map as Map newtype RepAtom = RepAtom Content deriving ToContent instance HasContentType RepAtom where getContentType _ = typeAtom instance ToTypedContent RepAtom where toTypedContent = TypedContent typeAtom . toContent atomFeed :: MonadHandler m => Feed (Route (HandlerSite m)) -> m RepAtom atomFeed feed = do render <- getUrlRender return $ RepAtom $ toContent $ renderLBS def $ template feed render -- | Same as @'atomFeed'@ but for @'Feed Text'@. Useful for cases where you are -- generating a feed of external links. atomFeedText :: MonadHandler m => Feed Text -> m RepAtom atomFeedText feed = return $ RepAtom $ toContent $ renderLBS def $ template feed id template :: Feed url -> (url -> Text) -> Document template Feed {..} render = Document (Prologue [] Nothing []) (addNS root) [] where addNS (Element (Name ln _ _) as ns) = Element (Name ln (Just namespace) Nothing) as (map addNS' ns) addNS' (NodeElement e) = NodeElement $ addNS e addNS' n = n namespace = "http://www.w3.org/2005/Atom" root = Element "feed" Map.empty $ map NodeElement $ Element "title" Map.empty [NodeContent feedTitle] : Element "link" (Map.fromList [("rel", "self"), ("href", render feedLinkSelf)]) [] : Element "link" (Map.singleton "href" $ render feedLinkHome) [] : Element "updated" Map.empty [NodeContent $ formatW3 feedUpdated] : Element "id" Map.empty [NodeContent $ render feedLinkHome] : Element "author" Map.empty [NodeElement $ Element "name" Map.empty [NodeContent feedAuthor]] : map (flip entryTemplate render) feedEntries ++ case feedLogo of Nothing -> [] Just (route, _) -> [Element "logo" Map.empty [NodeContent $ render route]] entryCategoryTemplate :: EntryCategory -> Element entryCategoryTemplate (EntryCategory mdomain mlabel category) = Element "category" (Map.fromList ([("term",category)] ++ (maybe [] (\d -> [("scheme",d)]) mdomain) ++ (maybe [] (\l -> [("label",l)]) mlabel) ) ) [] entryTemplate :: FeedEntry url -> (url -> Text) -> Element entryTemplate FeedEntry {..} render = Element "entry" Map.empty $ map NodeElement $ [ Element "id" Map.empty [NodeContent $ render feedEntryLink] , Element "link" (Map.singleton "href" $ render feedEntryLink) [] , Element "updated" Map.empty [NodeContent $ formatW3 feedEntryUpdated] , Element "title" Map.empty [NodeContent feedEntryTitle] , Element "content" (Map.singleton "type" "html") [NodeContent $ toStrict $ renderHtml feedEntryContent] ] ++ map entryCategoryTemplate feedEntryCategories ++ case feedEntryEnclosure of Nothing -> [] Just (EntryEnclosure{..}) -> [Element "link" (Map.fromList [("rel", "enclosure") ,("href", render enclosedUrl)]) []] -- | Generates a link tag in the head of a widget. atomLink :: MonadWidget m => Route (HandlerSite m) -> Text -- ^ title -> m () atomLink r title = toWidgetHead [hamlet| |] yesod-newsfeed-1.7.0.0/Yesod/RssFeed.hs0000644000000000000000000001036013545077026015747 0ustar0000000000000000{-# LANGUAGE QuasiQuotes #-} {-# LANGUAGE RecordWildCards #-} {-# LANGUAGE OverloadedStrings #-} {-# LANGUAGE CPP #-} {-# LANGUAGE GeneralizedNewtypeDeriving #-} ------------------------------------------------------------------------------- -- -- Module : Yesod.RssFeed -- Copyright : Patrick Brisbin -- License : as-is -- -- Maintainer : Patrick Brisbin -- Stability : Stable -- Portability : Portable -- ------------------------------------------------------------------------------- module Yesod.RssFeed ( rssFeed , rssFeedText , rssLink , RepRss (..) , module Yesod.FeedTypes ) where import Yesod.Core import Yesod.FeedTypes import qualified Data.ByteString.Char8 as S8 import Data.Text (Text, pack) import Data.Text.Lazy (toStrict) import Text.XML import Text.Blaze.Html.Renderer.Text (renderHtml) import qualified Data.Map as Map newtype RepRss = RepRss Content deriving ToContent instance HasContentType RepRss where getContentType _ = typeRss instance ToTypedContent RepRss where toTypedContent = TypedContent typeRss . toContent -- | Generate the feed rssFeed :: MonadHandler m => Feed (Route (HandlerSite m)) -> m RepRss rssFeed feed = do render <- getUrlRender return $ RepRss $ toContent $ renderLBS def $ template feed render -- | Same as @'rssFeed'@ but for @'Feed Text'@. Useful for cases where you are -- generating a feed of external links. rssFeedText :: MonadHandler m => Feed Text -> m RepRss rssFeedText feed = return $ RepRss $ toContent $ renderLBS def $ template feed id template :: Feed url -> (url -> Text) -> Document template Feed {..} render = Document (Prologue [] Nothing []) root [] where root = Element "rss" (Map.singleton "version" "2.0") $ return $ NodeElement $ Element "channel" Map.empty $ map NodeElement $ Element "{http://www.w3.org/2005/Atom}link" (Map.fromList [ ("href", render feedLinkSelf) , ("rel", "self") , ("type", pack $ S8.unpack typeRss) ]) [] : Element "title" Map.empty [NodeContent feedTitle] : Element "link" Map.empty [NodeContent $ render feedLinkHome] : Element "description" Map.empty [NodeContent $ toStrict $ renderHtml feedDescription] : Element "lastBuildDate" Map.empty [NodeContent $ formatRFC822 feedUpdated] : Element "language" Map.empty [NodeContent feedLanguage] : map (flip entryTemplate render) feedEntries ++ case feedLogo of Nothing -> [] Just (route, desc) -> [Element "image" Map.empty [ NodeElement $ Element "url" Map.empty [NodeContent $ render route] , NodeElement $ Element "title" Map.empty [NodeContent desc] , NodeElement $ Element "link" Map.empty [NodeContent $ render feedLinkHome] ] ] entryTemplate :: FeedEntry url -> (url -> Text) -> Element entryTemplate FeedEntry {..} render = Element "item" Map.empty $ map NodeElement $ [ Element "title" Map.empty [NodeContent feedEntryTitle] , Element "link" Map.empty [NodeContent $ render feedEntryLink] , Element "guid" Map.empty [NodeContent $ render feedEntryLink] , Element "pubDate" Map.empty [NodeContent $ formatRFC822 feedEntryUpdated] , Element "description" Map.empty [NodeContent $ toStrict $ renderHtml feedEntryContent] ] ++ map entryCategoryTemplate feedEntryCategories ++ case feedEntryEnclosure of Nothing -> [] Just (EntryEnclosure{..}) -> [ Element "enclosure" (Map.fromList [("type", enclosedMimeType) ,("length", pack $ show enclosedSize) ,("url", render enclosedUrl)]) []] entryCategoryTemplate :: EntryCategory -> Element entryCategoryTemplate (EntryCategory mdomain _ category) = Element "category" prop [NodeContent category] where prop = maybe Map.empty (\domain -> Map.fromList [("domain",domain)]) mdomain -- | Generates a link tag in the head of a widget. rssLink :: MonadWidget m => Route (HandlerSite m) -> Text -- ^ title -> m () rssLink r title = toWidgetHead [hamlet| |] yesod-newsfeed-1.7.0.0/Yesod/Feed.hs0000644000000000000000000000234113514057040015245 0ustar0000000000000000------------------------------------------------------------------------------- -- -- Module : Yesod.Feed -- Copyright : Patrick Brisbin -- License : as-is -- -- Maintainer : Patrick Brisbin -- Stability : Stable -- Portability : Portable -- -- Generic Feed and Feed Entry data types that can be used as either an -- Rss feed or an Atom feed (or both, or other). -- -- Atom spec: -- Rss spec: -- ------------------------------------------------------------------------------- module Yesod.Feed ( newsFeed , newsFeedText , module Yesod.FeedTypes ) where import Yesod.FeedTypes import Yesod.AtomFeed import Yesod.RssFeed import Yesod.Core import Data.Text newsFeed :: MonadHandler m => Feed (Route (HandlerSite m)) -> m TypedContent newsFeed f = selectRep $ do provideRep $ atomFeed f provideRep $ rssFeed f -- | Same as @'newsFeed'@ but for @'Feed Text'@. Useful for cases where you are -- generating a feed of external links. newsFeedText :: MonadHandler m => Feed Text -> m TypedContent newsFeedText f = selectRep $ do provideRep $ atomFeedText f provideRep $ rssFeedText f yesod-newsfeed-1.7.0.0/Yesod/FeedTypes.hs0000644000000000000000000000410713545077026016306 0ustar0000000000000000module Yesod.FeedTypes ( Feed (..) , FeedEntry (..) , EntryEnclosure (..) , EntryCategory (..) ) where import Text.Hamlet (Html) import Data.Time.Clock (UTCTime) import Data.Text (Text) -- | The overall feed data Feed url = Feed { feedTitle :: Text , feedLinkSelf :: url , feedLinkHome :: url , feedAuthor :: Text -- | note: currently only used for Rss , feedDescription :: Html -- | note: currently only used for Rss, possible values: -- , feedLanguage :: Text , feedUpdated :: UTCTime , feedLogo :: Maybe (url, Text) , feedEntries :: [FeedEntry url] } -- | RSS and Atom allow for linked content to be enclosed in a feed entry. -- This represents the enclosed content. -- -- Atom feeds ignore 'enclosedSize' and 'enclosedMimeType'. -- -- @since 1.6 data EntryEnclosure url = EntryEnclosure { enclosedUrl :: url , enclosedSize :: Int -- ^ Specified in bytes , enclosedMimeType :: Text } -- | RSS 2.0 and Atom allow category in a feed entry. -- -- * [RSS category](http://www.rssboard.org/rss-specification#ltcategorygtSubelementOfLtitemgt) -- * [Atom category](https://tools.ietf.org/html/rfc4287#section-4.2.2) -- -- RSS feeds ignore 'categoryLabel' -- -- @since 1.7 data EntryCategory = EntryCategory { categoryDomain :: Maybe Text -- ^ category identifier , categoryLabel :: Maybe Text -- ^ Human-readable label Atom only , categoryValue :: Text -- ^ identified categorization scheme via URI } -- | Each feed entry data FeedEntry url = FeedEntry { feedEntryLink :: url , feedEntryUpdated :: UTCTime , feedEntryTitle :: Text , feedEntryContent :: Html , feedEntryEnclosure :: Maybe (EntryEnclosure url) -- ^ Allows enclosed data: RSS \ or Atom \ -- -- @since 1.5 , feedEntryCategories :: [EntryCategory] -- ^ Allows categories data: RSS \ -- or Atom \ -- -- @since 1.7 } yesod-newsfeed-1.7.0.0/LICENSE0000644000000000000000000000207513514057040013774 0ustar0000000000000000Copyright (c) 2012 Michael Snoyman, http://www.yesodweb.com/ Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. yesod-newsfeed-1.7.0.0/Setup.lhs0000755000000000000000000000016213514057040014575 0ustar0000000000000000#!/usr/bin/env runhaskell > module Main where > import Distribution.Simple > main :: IO () > main = defaultMain yesod-newsfeed-1.7.0.0/yesod-newsfeed.cabal0000644000000000000000000000250113545077026016700 0ustar0000000000000000name: yesod-newsfeed version: 1.7.0.0 license: MIT license-file: LICENSE author: Michael Snoyman, Patrick Brisbin maintainer: Michael Snoyman synopsis: Helper functions and data types for producing News feeds. category: Web, Yesod stability: Stable cabal-version: >= 1.6 build-type: Simple homepage: http://www.yesodweb.com/ description: API docs and the README are available at extra-source-files: README.md ChangeLog.md library build-depends: base >= 4 && < 5 , yesod-core >= 1.6 && < 1.7 , time >= 1.1.4 , shakespeare >= 2.0 , bytestring >= 0.9.1.4 , text >= 0.9 , xml-conduit >= 1.0 , blaze-html >= 0.5 , blaze-markup >= 0.5.1 , containers exposed-modules: Yesod.AtomFeed , Yesod.RssFeed , Yesod.Feed other-modules: Yesod.FeedTypes ghc-options: -Wall source-repository head type: git location: https://github.com/yesodweb/yesod yesod-newsfeed-1.7.0.0/README.md0000644000000000000000000000011513514057040014237 0ustar0000000000000000## yesod-newsfeed Helper functions and data types for producing News feeds. yesod-newsfeed-1.7.0.0/ChangeLog.md0000644000000000000000000000322613545077026015151 0ustar0000000000000000# Changelog ## 1.7 * Add support for Feed Categories * RSS: http://www.rssboard.org/rss-specification#ltcategorygtSubelementOfLtitemgt * Atom: https://tools.ietf.org/html/rfc4287#section-4.2.2 * Create the `EntryCategory` datatype ## 1.6.1 * Upgrade to yesod-core 1.6.0 ## 1.6 * Create new datatype `EntryEnclosure` for self-documentation of `feedEntryEnclosure`. ## 1.5 ### Yesod/FeedTypes.hs * added `feedLogo` field to `Feed` type as `Maybe (url, Text)`. Should this field result in `Nothing`, nothing will be added to the feed. * `url`: Defines the URL to the logi image * `Text`: Is the description of the logo image. Will only be used for RSS feeds * added `feedEntryEnclosure` field to `FeedEntry` type as `Maybe (url, Int, Text)`. Should this field result in `Nothing`, no data will be added to the feed entry. * `url`: Defines the URL to the enclosed data * `Int`: Is the content size in bytes. RSS requires this. * `Text`: Is the MIME-type of the enclosed file. RSS requires this ### Yesod/AtomFeed.hs * modified `template` function to append an `url` tag at the end of the feed, when the provided `feedLogo` is not `Nothing`. This might look awkward, since it will be appended *after* the entries. * modified `entryTemplate` to append an `` to the feed entry. ### Yesod/RssFeed.hs * modified `template` function to append an `` tag with its three required components ``, `` and `<link>`. `<url>` and `<title>` will be filled from `feedLogo`, `<link>` will be `feedLinkHome`. * modified `entryTemplate` function to append an `<enclosure type=mime length=length url=url>` to the feed entry ������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������