URLEmbeddedView automatically caches the object that is confirmed the Open Graph Protocol.
Clone or download
Latest commit 5c28b40 Nov 9, 2018
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
Example support swift4.2 #75 Nov 7, 2018
Images fix directory structure Aug 15, 2017
Resources support tvOS Jul 14, 2018
URLEmbeddedView.xcodeproj support swift4.2 #75 Nov 7, 2018
URLEmbeddedView.xcworkspace support swift4.1 #56 Apr 2, 2018
URLEmbeddedView fix #73 Nov 9, 2018
.gitignore add submodules Aug 15, 2017
.gitmodules fix example Jul 14, 2018
.swift-version support swift4 Oct 8, 2017
.travis.yml Initial commit Mar 6, 2016
LICENSE Initial commit Mar 6, 2016
README.md update README and podspec Nov 7, 2018
URLEmbeddedView.podspec fix #73 Nov 9, 2018

README.md

URLEmbeddedView

Platform Language Carthage compatible Version CocoaPods License

Features

  • Simple interface for fetching Open Graph Data
  • Be able to display Open Graph Data
  • Automatically caching Open Graph Data
  • Automatically caching Open Graph Image
  • Tap handleable
  • Clearable image cache
  • Clearable data cache
  • Support Swift3.2 (until 0.11.x)
  • Support Swift4
  • Support Carthage since 0.11.1
  • Supprot Swift4.1 since 0.15.0
  • Supprot Swift4.2 since 0.17.0
  • Support tvOS since 0.16.0
  • Custom implementation of OGData cache

Usage

To run the example project, clone the repo, and run carthage update from the Example directory first.

let embeddedView = URLEmbeddedView()
embeddedView.loadURL(urlString)

Layouts

  • Default

  • No Image

  • No response

Customization

embeddedView.textProvider[.Title].font = .boldSystemFontOfSize(18)
embeddedView.textProvider[.Title].fontColor = .lightGrayColor()
embeddedView.textProvider[.Title].numberOfLines = 2
//You can use ".Title", ".Description", ".Domain" and ".NoDataTitle"

Data and Image Cache

You can get Open Graph Data with OGDataProvider.

OGDataProvider.shared.fetchOGData(urlString: String, completion: ((OpenGraph.Data, Error?) -> Void)? = nil) -> String?
OGDataProvider.shared.deleteOGData(urlString: String, completion: ((Error?) -> Void)? = nil)
OGDataProvider.shared.deleteOGData(_ ogData: OpenGraph.Data, completion: ((Error?) -> Void)? = nil)

You can configure time interval for next updating of OGData. Default is 10 days.

OGDataProvider.shared.updateInterval = 10.days

You can get UIImage with OGImageProvider.

OGImageProvider.shared.loadImage(urlString: String, completion: ((UIImage?, Error?) -> Void)? = nil) -> NSURLSessionDataTask?
OGImageProvider.shared.clearMemoryCache()
OGImageProvider.shared.clearAllCache()

Custom Data Cache implementation

Default cache feature is using Core Data. If you want to use other cache features, please implement cache manager with OGDataCacheManagerProtocol. For example, URLEmbeddedView has OGDataNoCacheManager that feature is not using cache. If you want to use that feature, you can use like this.

OGDataProvider.shared.cacheManager = OGDataNoCacheManager()

You can implement custom cache feature and use it like this.

class MemoryCacheManager: OGDataCacheManagerProtocol {
    // implementation of required methods
}

OGDataProvider.shared.cacheManager = MemoryCacheManager()

OpenGraph.Data Properties

public let imageUrl: URL?
public let pageDescription: String?
public let pageTitle: String?
public let pageType: String?
public let siteName: String?
public let sourceUrl: URL?
public let url: URL?

OpenGraphDataDownloader

You can only use download feature of OGData with OpenGraphDataDownloader like this.

let urlString = ...
OpenGraphDataDownloader.shared.fetchOGData(urlString: urlString) { result in
    switch result {
    case let .success(data, isExpired):
        // do something
    case let .failure(error, isExpired):
        // do something
    }
}

If you use OGDataProvider with OGDataNoCacheManager, it is almost same process.

OGDataProvider.shared.cacheManager = OGDataNoCacheManager()
let urlString = ...
OGDataProvider.shared.fetchOGData(urlString: urlString) { ogData, error in
    // do something
}

Installation

CocoaPods

URLEmbeddedView is available through CocoaPods. To install it, simply add the following line to your Podfile:

# Uncomment the next line to define a global platform for your project
# platform :ios, '8.0'

target 'Your Project Name' do
  # Comment the next line if you're not using Swift and don't want to use dynamic frameworks
  use_frameworks!

  # Pods for URLEmbeddedViewSample
  pod "URLEmbeddedView"
end

Carthage

If you’re using Carthage, simply add NoticeObserveKit to your Cartfile:

github "marty-suzuki/URLEmbeddedView"

Use in Objective-C

#import <URLEmbeddedView/URLEmbeddedView-Swift.h>

- (void)viewDidLoad {
    [super viewDidLoad];
    URLEmbeddedView *embeddedView = [[URLEmbeddedView alloc] init];
    [self.view addSubView:embeddedView];
    [embeddedView loadURL:@"https://github.com/" completion:nil];
}

- (void)setUpdateInterval {
  [OGDataProvider sharedInstance].updateInterval = [NSNumber days:10];
}

- (void)fetchOpenGraphData {
  [[OGDataProvider sharedInstance] fetchOGDataWithUrlString:self.textView.text
                                            completion:^(OpenGraphData *data, NSError *error) {
      NSLog(@"OpenGraphData = %@", data);
  }];
}

Here is Objective-C sample.

Special Thanks

Requirements

  • Xcode 9 or greater
  • iOS 8.0 or greater
  • tvOS 10.0 or greater
  • UIKit
  • CoreData
  • CoreGraphics

Other

Author

Taiki Suzuki, s1180183@gmail.com

License

URLEmbeddedView is available under the MIT license. See the LICENSE file for more info.