Merge pull request #98 from contentful/update-readme

Add coverage comparison table to readme

.travis.yml

@@ -5,9 +5,6 @@ git:
 osx_image: xcode8.3
 rvm:
 - 2.4.1
-  #cache:
-  #- bundler
-  #- cocoapods
 before_install:
 - git submodule sync
 - git submodule update --init --recursive
@@ -24,7 +21,6 @@ notifications:
 env:
   matrix:
   - CONTENTFUL_SDK="CDA"
-  - CONTENTFUL_SDK="CMA"
   global:
   - IOS_SDK=iphonesimulator10.3 IOS_VERSION=10.3.1 DEVICE_NAME='iPhone 6s'
   - ARTIFACTS_S3_BUCKET=static.cdnorigin.contentful.com

Gemfile

@@ -1,14 +1,13 @@
 source 'http://rubygems.org'
 
-gem 'cocoapods', '~> 1.2.1'
+gem 'cocoapods', '~> 1.5.0'
 gem 'xcpretty'
 gem 'xcode-install'
-gem 'cocoapods-keys', '~> 2.0.0'
-gem 'cocoapods-packager', '~> 1.3.0'
+gem 'cocoapods-packager'
 gem 'cocoapods-docstats'
 gem 'cocoapods-deintegrate'
 gem 'cocoapods-clean'
-gem 'slather', '~> 2.1'
+gem 'slather', '~> 2.4'
 gem 'jazzy'
 gem 'dotenv'
 

Gemfile.lock

@@ -2,9 +2,6 @@ GEM
   remote: http://rubygems.org/
   specs:
     CFPropertyList (2.3.6)
-    RubyInline (3.12.4)
-      ZenTest (~> 4.3)
-    ZenTest (4.11.1)
     activesupport (4.2.10)
       i18n (~> 0.7)
       minitest (~> 5.1)
@@ -16,39 +13,36 @@ GEM
     babosa (1.0.2)
     claide (1.0.2)
     clamp (0.6.5)
-    cocoapods (1.2.1)
+    cocoapods (1.5.3)
       activesupport (>= 4.0.2, < 5)
-      claide (>= 1.0.1, < 2.0)
-      cocoapods-core (= 1.2.1)
-      cocoapods-deintegrate (>= 1.0.1, < 2.0)
-      cocoapods-downloader (>= 1.1.3, < 2.0)
+      claide (>= 1.0.2, < 2.0)
+      cocoapods-core (= 1.5.3)
+      cocoapods-deintegrate (>= 1.0.2, < 2.0)
+      cocoapods-downloader (>= 1.2.0, < 2.0)
       cocoapods-plugins (>= 1.0.0, < 2.0)
       cocoapods-search (>= 1.0.0, < 2.0)
       cocoapods-stats (>= 1.0.0, < 2.0)
-      cocoapods-trunk (>= 1.2.0, < 2.0)
+      cocoapods-trunk (>= 1.3.0, < 2.0)
       cocoapods-try (>= 1.1.0, < 2.0)
       colored2 (~> 3.1)
       escape (~> 0.0.4)
       fourflusher (~> 2.0.1)
       gh_inspector (~> 1.0)
-      molinillo (~> 0.5.7)
+      molinillo (~> 0.6.5)
       nap (~> 1.0)
       ruby-macho (~> 1.1)
-      xcodeproj (>= 1.4.4, < 2.0)
+      xcodeproj (>= 1.5.7, < 2.0)
     cocoapods-clean (0.0.1)
-    cocoapods-core (1.2.1)
-      activesupport (>= 4.0.2, < 5)
+    cocoapods-core (1.5.3)
+      activesupport (>= 4.0.2, < 6)
       fuzzy_match (~> 2.0.4)
       nap (~> 1.0)
     cocoapods-deintegrate (1.0.2)
     cocoapods-docstats (0.0.3)
       docstat
-    cocoapods-downloader (1.2.0)
-    cocoapods-keys (2.0.3)
-      dotenv
-      osx_keychain
-    cocoapods-packager (1.3.0)
-      cocoapods (>= 0.38.2)
+    cocoapods-downloader (1.2.1)
+    cocoapods-packager (1.5.0)
+      cocoapods (>= 1.1.1, < 2.0)
     cocoapods-plugins (1.0.0)
       nap
     cocoapods-search (1.0.0)
@@ -72,15 +66,15 @@ GEM
     emoji_regex (0.1.1)
     escape (0.0.4)
     excon (0.62.0)
-    faraday (0.15.1)
+    faraday (0.15.2)
       multipart-post (>= 1.2, < 3)
     faraday-cookie_jar (0.0.6)
       faraday (>= 0.7.4)
       http-cookie (~> 1.0.0)
     faraday_middleware (0.12.2)
       faraday (>= 0.7.4, < 1.0)
     fastimage (2.1.3)
-    fastlane (2.95.0)
+    fastlane (2.97.0)
       CFPropertyList (>= 2.3, < 4.0.0)
       addressable (>= 2.3, < 3.0.0)
       babosa (>= 1.0.2, < 2.0.0)
@@ -95,7 +89,7 @@ GEM
       faraday_middleware (~> 0.9)
       fastimage (>= 2.1.0, < 3.0.0)
       gh_inspector (>= 1.1.2, < 2.0.0)
-      google-api-client (>= 0.13.1, < 0.14.0)
+      google-api-client (>= 0.21.2, < 0.22.0)
       highline (>= 1.7.2, < 2.0.0)
       json (< 3.0.0)
       mini_magick (~> 4.5.1)
@@ -104,7 +98,7 @@ GEM
       multipart-post (~> 2.0.0)
       plist (>= 3.1.0, < 4.0.0)
       public_suffix (~> 2.0.0)
-      rubyzip (>= 1.1.0, < 2.0.0)
+      rubyzip (>= 1.2.1, < 2.0.0)
       security (= 0.1.3)
       simctl (~> 1.6.3)
       slack-notifier (>= 2.0.0, < 3.0.0)
@@ -116,13 +110,13 @@ GEM
       xcodeproj (>= 1.5.7, < 2.0.0)
       xcpretty (>= 0.2.4, < 1.0.0)
       xcpretty-travis-formatter (>= 0.0.3)
-    ffi (1.9.23)
+    ffi (1.9.25)
     fourflusher (2.0.1)
     fuzzy_match (2.0.4)
     gh_inspector (1.1.3)
-    google-api-client (0.13.6)
+    google-api-client (0.21.2)
       addressable (~> 2.5, >= 2.5.1)
-      googleauth (~> 0.5)
+      googleauth (>= 0.5, < 0.7.0)
       httpclient (>= 2.8.1, < 3.0)
       mime-types (~> 3.0)
       representable (~> 3.0)
@@ -164,21 +158,19 @@ GEM
     mini_magick (4.5.1)
     mini_portile2 (2.3.0)
     minitest (5.11.3)
-    molinillo (0.5.7)
+    molinillo (0.6.5)
     multi_json (1.13.1)
     multi_xml (0.6.0)
     multipart-post (2.0.0)
     mustache (0.99.8)
     nanaimo (0.2.5)
     nap (1.1.0)
-    naturally (2.1.0)
+    naturally (2.2.0)
     netrc (0.11.0)
     nokogiri (1.8.2)
       mini_portile2 (~> 2.3.0)
     open4 (1.3.4)
     os (0.9.6)
-    osx_keychain (1.0.2)
-      RubyInline (~> 3)
     plist (3.4.0)
     public_suffix (2.0.5)
     rb-fsevent (0.10.3)
@@ -189,9 +181,9 @@ GEM
       declarative (< 0.1.0)
       declarative-option (< 0.2.0)
       uber (< 0.2.0)
-    retriable (3.1.1)
+    retriable (3.1.2)
     rouge (2.0.7)
-    ruby-macho (1.1.0)
+    ruby-macho (1.2.0)
     rubyzip (1.2.1)
     sass (3.5.6)
       sass-listen (~> 4.0.0)
@@ -229,14 +221,14 @@ GEM
     unf (0.1.4)
       unf_ext
     unf_ext (0.0.7.5)
-    unicode-display_width (1.3.2)
+    unicode-display_width (1.4.0)
     word_wrap (1.0.0)
     xcinvoke (0.3.0)
       liferaft (~> 0.0.6)
-    xcode-install (2.3.1)
+    xcode-install (2.4.1)
       claide (>= 0.9.1, < 1.1.0)
       fastlane (>= 2.1.0, < 3.0.0)
-    xcodeproj (1.5.8)
+    xcodeproj (1.5.9)
       CFPropertyList (>= 2.3.3, < 4.0)
       atomos (~> 0.1.2)
       claide (>= 1.0.2, < 2.0)
@@ -251,15 +243,14 @@ PLATFORMS
   ruby
 
 DEPENDENCIES
-  cocoapods (~> 1.2.1)
+  cocoapods (~> 1.5.0)
   cocoapods-clean
   cocoapods-deintegrate
   cocoapods-docstats
-  cocoapods-keys (~> 2.0.0)
-  cocoapods-packager (~> 1.3.0)
+  cocoapods-packager
   dotenv
   jazzy
-  slather (~> 2.1)
+  slather (~> 2.4)
   xcode-install
   xcpretty
 

Podfile

@@ -24,8 +24,6 @@ target 'ContentfulDeliveryAPI' do
 end
 
 
-
-
 # Cocoapods docs are wrong and don't work for 
 target 'DeliveryTests' do
   platform :ios, "8.0"
@@ -38,28 +36,6 @@ target 'DeliveryTests' do
 end
 
 
-
-plugin 'cocoapods-keys', {
-  :project => 'ContentfulSDK',
-  :target => 'ManagementTests',
-  :keys => [ 'ManagementAPIAccessToken' ]
-}
-
-
-## Management API
-target 'ContentfulManagementAPI' do
-  platform :ios, "8.0"
-  podspec :path => 'ContentfulManagementAPI.podspec'
-end
-
-target 'ManagementTests' do
-  platform :ios, "8.0"
-  pod 'Specta'
-  pod 'Expecta', '= 1.0.5'
-  pod 'VCRURLConnection', '= 0.2.2', :inhibit_warnings => true
-end
-
-
 ## Post install
 post_install do |installer|
 

Podfile.lock

@@ -25,36 +25,38 @@ PODS:
   - CCLRequestReplay/Manager (0.9.0)
   - CCLRequestReplay/Record (0.9.0)
   - CCLRequestReplay/Replay (0.9.0)
-  - Expecta (1.0.5)
   - FBSnapshotTestCase/Core (2.1.4)
   - ISO8601 (0.6.0)
-  - Keys (1.0.1)
-  - OCMock (3.4)
+  - OCMock (3.4.1)
   - PDKTCollectionViewWaterfallLayout (0.1)
   - Realm (2.5.1):
     - Realm/Headers (= 2.5.1)
   - Realm/Headers (2.5.1)
-  - Specta (1.0.6)
   - VCRURLConnection (0.2.2)
 
 DEPENDENCIES:
   - AFNetworking (~> 3.1.0)
   - CCLRequestReplay (from `https://github.com/neonichu/CCLRequestReplay.git`)
-  - Expecta (= 1.0.5)
   - FBSnapshotTestCase/Core
   - ISO8601 (~> 0.6.0)
-  - Keys (from `Pods/CocoaPodsKeys`)
   - OCMock
   - PDKTCollectionViewWaterfallLayout
   - Realm (~> 2.5.0)
-  - Specta
   - VCRURLConnection (= 0.2.2)
 
+SPEC REPOS:
+  https://github.com/cocoapods/specs.git:
+    - AFNetworking
+    - FBSnapshotTestCase
+    - ISO8601
+    - OCMock
+    - PDKTCollectionViewWaterfallLayout
+    - Realm
+    - VCRURLConnection
+
 EXTERNAL SOURCES:
   CCLRequestReplay:
     :git: https://github.com/neonichu/CCLRequestReplay.git
-  Keys:
-    :path: Pods/CocoaPodsKeys
 
 CHECKOUT OPTIONS:
   CCLRequestReplay:
@@ -64,16 +66,13 @@ CHECKOUT OPTIONS:
 SPEC CHECKSUMS:
   AFNetworking: 5e0e199f73d8626b11e79750991f5d173d1f8b67
   CCLRequestReplay: a472e52da260c28d7a41df76697b8e518625a44f
-  Expecta: e1c022fcd33910b6be89c291d2775b3fe27a89fe
-  FBSnapshotTestCase: '094f9f314decbabe373b87cc339bea235a63e07a'
+  FBSnapshotTestCase: 094f9f314decbabe373b87cc339bea235a63e07a
   ISO8601: d3ea3ba9b752820cf92c6b47a9ee327e9f0e13fc
-  Keys: a576f4c9c1c641ca913a959a9c62ed3f215a8de9
-  OCMock: 35ae71d6a8fcc1b59434d561d1520b9dd4f15765
+  OCMock: 2cd0716969bab32a2283ff3a46fd26a8c8b4c5e3
   PDKTCollectionViewWaterfallLayout: a246de22e843bdb2677ab2fe5d6c1fb0a623f93e
   Realm: 32f86104d37c8521f864d4274050b38ba6190733
-  Specta: f506f3a8361de16bc0dcf3b17b75e269072ba465
   VCRURLConnection: 1b14489604ca90b7b144b50dab6f9845d8931a45
 
-PODFILE CHECKSUM: a4eee46bb912bcb0d1b1e1cb3aeaa75aaab8e69e
+PODFILE CHECKSUM: df5e1b9b1737f4a118a22a5fa4e663dab8ce3f9b
 
-COCOAPODS: 1.2.1
+COCOAPODS: 1.5.3

README.md

@@ -14,6 +14,20 @@
 
 #### It is recommended to use [contentful.swift](https://github.com/contentful/contentful.swift) over contentful.objc as future development at Contentful will focus on Swift rather than Objective-C.
 
+#### Full feature comparison of contentful.swift & contentful.objc
+
+| CDA Features | contentful.swift | contentful.objc |
+| -----------  | ----------- | ----------- |
+| API coverage* | :white_check_mark: | :white_check_mark: |
+| Images API | :white_check_mark: | :white_check_mark: |
+| Search Parameters | :white_check_mark: | :no_entry_sign: |
+| Fallback locales for sync api | :white_check_mark: | :no_entry_sign: |
+| Rate limit handling | :white_check_mark: | :no_entry_sign: |
+| Space environments | :white_check_mark: | :no_entry_sign: |
+
+*API Coverage definition: all endpoints can be interfaced with and complex queries can be constructed by passing in dictionaries of http parameter/argument pairs. Note that the Swift SDK provides much more comprehensive coverage and takes advantage of type system, outdoing the "stringly typed" interface that the Objective-C SDK offers.
+
+
 Objective-C SDK's for [Contentful's][1] Content Delivery API.
 
 [Contentful][1] provides a content infrastructure for digital teams to power content in websites, apps, and devices. Unlike a CMS, Contentful was built to integrate with the modern software stack. It offers a central hub for structured content, powerful management and delivery APIs, and a customizable web app that enable developers and content creators to ship digital products faster.