contentful 0.2.0 → 0.3.0

data/spec/fixtures/vcr_cassettes/sync_page_2.yml

@@ -0,0 +1,71 @@
+---
+http_interactions:
+- request:
+    method: get
+    uri: https://cdn.contentful.com/spaces/cfexampleapi/sync?sync_token=w5ZGw6JFwqZmVcKsE8Kow4grw45QdybCr8Okw6AYwqbDksO3ehvDpUPCgcKsKXbCiAwPC8K2w4LDvsOkw6nCjhPDpcOQADElWsOoU8KGR3HCtsOAwqd6wp_Dulp8w6LDsF_CtsK7Kk05wrMvwrLClMOgG2_Dn2sGPg
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers:
+      User-Agent:
+      - RubyContentfulGem/0.1.3
+      Authorization:
+      - Bearer b4c0n73n7fu1
+      Content-Type:
+      - application/vnd.contentful.delivery.v1+json
+      Host:
+      - cdn.contentful.com
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Date:
+      - Fri, 25 Apr 2014 13:31:17 GMT
+      Server:
+      - nginx/1.1.19
+      Access-Control-Allow-Headers:
+      - Accept,Accept-Language,Authorization,Cache-Control,Content-Length,Content-Range,Content-Type,DNT,Destination,Expires,If-Match,If-Modified-Since,If-None-Match,Keep-Alive,Last-Modified,Origin,Pragma,Range,User-Agent,X-Http-Method-Override,X-Mx-ReqToken,X-Requested-With,X-Contentful-Version,X-Contentful-Content-Type,X-Contentful-Organization
+      Access-Control-Allow-Methods:
+      - GET,HEAD,OPTIONS
+      Access-Control-Allow-Origin:
+      - "*"
+      Access-Control-Max-Age:
+      - '86400'
+      Cache-Control:
+      - max-age=0
+      Content-Type:
+      - application/vnd.contentful.delivery.v1+json
+      Etag:
+      - '"382e4781b902b58d2edf3f10067167c7"'
+      X-Contentful-Request-Id:
+      - f1c-737770542
+      Content-Length:
+      - '300'
+      Accept-Ranges:
+      - bytes
+      Via:
+      - 1.1 varnish
+      Age:
+      - '0'
+      X-Served-By:
+      - cache-fra1229-FRA
+      X-Cache:
+      - MISS
+      X-Cache-Hits:
+      - '0'
+      Vary:
+      - Accept-Encoding
+    body:
+      encoding: UTF-8
+      string: |
+        {
+          "sys": {
+            "type": "Array"
+          },
+          "items": [],
+          "nextSyncUrl": "https://cdn.contentful.com/spaces/cfexampleapi/sync?sync_token=w5ZGw6JFwqZmVcKsE8Kow4grw45QdybCr8Okw6AYwqbDksO3ehvDpUPCgcKsKXbCiAwPC8K2w4LDvsOkw6nCjhPDpcOQADElWsOoU8KGR3HCtsOAwqd6wp_Dulp8w6LDsF_CtsK7Kk05wrMvwrLClMOgG2_Dn2sGPg"
+        }
+    http_version: 
+  recorded_at: Fri, 25 Apr 2014 13:31:18 GMT
+recorded_with: VCR 2.9.0

data/spec/spec_helper.rb

@@ -1,6 +1,3 @@
-require 'coveralls'
-Coveralls.wear!
-
 require 'rspec'
 require 'contentful'
 require 'securerandom'

data/spec/sync_page_spec.rb

@@ -0,0 +1,109 @@
+require 'spec_helper'
+
+
+describe Contentful::SyncPage do
+  let(:page_with_more){ vcr('sync_page'){ create_client.sync(initial: true).first_page } }
+  let(:page){ vcr('sync_page_2'){ create_client.sync.get("https://cdn.contentful.com/spaces/cfexampleapi/sync?sync_token=w5ZGw6JFwqZmVcKsE8Kow4grw45QdybCr8Okw6AYwqbDksO3ehvDpUPCgcKsKXbCiAwPC8K2w4LDvsOkw6nCjhPDpcOQADElWsOoU8KGR3HCtsOAwqd6wp_Dulp8w6LDsF_CtsK7Kk05wrMvwrLClMOgG2_Dn2sGPg") } }
+
+  describe 'SystemProperties' do
+    it 'has a #sys getter returning a hash with symbol keys' do
+      expect( page.sys ).to be_a Hash
+      expect( page.sys.keys.sample ).to be_a Symbol
+    end
+
+    it 'has #type' do
+      expect( page.type ).to eq "Array"
+    end
+  end
+
+  describe 'Properties' do
+    it 'has a #properties getter returning a hash with symbol keys' do
+      expect( page.properties ).to be_a Hash
+      expect( page.properties.keys.sample ).to be_a Symbol
+    end
+
+    it 'has #items which contain resources' do
+      expect( page_with_more.items ).to be_a Array
+      expect( page_with_more.items.sample ).to be_a Contentful::Resource
+    end
+  end
+
+  describe 'Fields' do
+    it 'properly deals with nested locale fields' do
+      expect( page_with_more.items.first.fields[:name] ).to eq "London"
+    end
+  end
+
+  describe '#each' do
+    it 'is an Enumerator' do
+      expect( page.each ).to be_a Enumerator
+    end
+
+    it 'iterates over items' do
+      expect( page.each.to_a ).to eq page.items
+    end
+
+    it 'includes Enumerable' do
+      expect( page.map{ |r| r.type } ).to eq page.items.map{ |r| r.type }
+    end
+  end
+
+  describe '#next_sync_url' do
+    it 'will return the next_sync_url if there is one' do
+      expect( page.next_sync_url ).to be_a String
+    end
+
+    it 'will return nil if note last page, yet' do
+      expect( page_with_more.next_sync_url ).to be_nil
+    end
+  end
+
+  describe '#next_page_url' do
+    it 'will return the next_page_url if there is one' do
+      expect( page_with_more.next_page_url ).to be_a String
+    end
+
+    it 'will return nil if on last page' do
+      expect( page.next_page_url ).to be_nil
+    end
+  end
+
+  describe '#next_page' do
+    it 'requests the next page' do
+      next_page = vcr('sync_page_2'){
+        page_with_more.next_page
+      }
+      expect( next_page ).to be_a Contentful::SyncPage
+    end
+
+    it 'will return nil if last page' do
+      expect( page.next_page_url ).to be_nil
+    end
+  end
+
+  describe '#next_page?' do
+    it 'will return true if there is a next page' do
+      expect( page_with_more.next_page? ).to be_true
+    end
+
+    it 'will return false if last page' do
+      expect( page.next_page? ).to be_false
+    end
+  end
+
+  describe '#last_page?' do
+    it 'will return true if no more pages available' do
+      expect( page.last_page? ).to be_true
+    end
+
+    it 'will return false if more pages available' do
+      expect( page_with_more.last_page? ).to be_false
+    end
+  end
+
+  describe '#sync' do
+    it 'returns the sync that created the page' do
+      expect( page.sync ).to be_a Contentful::Sync
+    end
+  end
+end

data/spec/sync_spec.rb

@@ -0,0 +1,86 @@
+require 'spec_helper'
+
+
+describe Contentful::Sync do
+  let(:first_page) do
+    vcr('sync_page'){
+      create_client.sync(initial: true).first_page
+    }
+  end
+
+  let(:last_page) do
+    vcr('sync_page'){
+      vcr('sync_page_2'){
+        create_client.sync(initial: true).first_page.next_page
+      }
+    }
+  end
+
+
+  describe '#initialize' do
+    it 'takes an options hash on initialization' do
+      expect{
+        vcr('sync_deletion'){ create_client.sync(initial: true, type: 'Deletion').first_page }
+      }.not_to raise_exception
+    end
+
+    it 'takes a next_sync_url on initialization' do
+      expect{
+        vcr('sync_page_2'){ create_client.sync("https://cdn.contentful.com/spaces/cfexampleapi/sync?sync_token=w5ZGw6JFwqZmVcKsE8Kow4grw45QdybCr8Okw6AYwqbDksO3ehvDpUPCgcKsKXbCiAwPC8K2w4LDvsOkw6nCjhPDpcOQADElWsOoU8KGR3HCtsOAwqd6wp_Dulp8w6LDsF_CtsK7Kk05wrMvwrLClMOgG2_Dn2sGPg").first_page }
+      }.not_to raise_exception
+    end
+  end
+
+  describe '#first_page' do
+    it 'returns only the first page of a new sync' do
+      vcr('sync_page'){
+        expect( create_client.sync(initial: true).first_page ).to be_a Contentful::SyncPage
+      }
+    end
+  end
+
+  describe '#each_page' do
+    it 'iterates through sync pages' do
+      sync = create_client.sync(initial: true)
+      vcr('sync_page'){ vcr('sync_page_2'){
+        count = 0
+        sync.each_page do |page|
+          expect( page ).to be_a Contentful::SyncPage
+          count += 1
+        end
+        expect( count ).to eq 2
+      }}
+    end
+  end
+
+  describe '#next_sync_url' do
+    it 'is empty if there are still more pages to request in the current sync' do
+      expect( first_page.next_sync_url ).to be_nil
+    end
+
+    it 'returns the url to continue the sync next time' do
+      expect( last_page.next_sync_url ).to be_a String
+    end
+  end
+
+  describe '#completed?' do
+    it 'will return true if no more pages to request in the current sync' do
+      expect( first_page.next_sync_url ).to be_false
+    end
+
+    it 'will return true if not all pages requested, yet' do
+      expect( last_page.next_sync_url ).to be_true
+    end
+  end
+
+  describe '#each_item' do
+    it 'will directly iterate through all resources' do
+      sync = create_client.sync(initial: true)
+      vcr('sync_page'){ vcr('sync_page_2'){
+        sync.each_item do |item|
+          expect( item ).to be_a Contentful::Resource
+        end
+      }}
+    end
+  end
+end

metadata

@@ -1,145 +1,164 @@
 --- !ruby/object:Gem::Specification
 name: contentful
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
+  prerelease: 
 platform: ruby
 authors:
 - Contentful GmbH (Jan Lelis)
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-04-22 00:00:00.000000000 Z
+date: 2014-05-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: http
   requirement: !ruby/object:Gem::Requirement
+    none: false
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: '0.6'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
+    none: false
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: '0.6'
 - !ruby/object:Gem::Dependency
   name: multi_json
   requirement: !ruby/object:Gem::Requirement
+    none: false
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: '1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
+    none: false
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: '1'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
+    none: false
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: '1.5'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
+    none: false
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: '1.5'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
+    none: false
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: '10'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
+    none: false
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: '10'
 - !ruby/object:Gem::Dependency
   name: rubygems-tasks
   requirement: !ruby/object:Gem::Requirement
+    none: false
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: '0.2'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
+    none: false
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: '0.2'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
+    none: false
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: '2'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
+    none: false
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: '2'
 - !ruby/object:Gem::Dependency
   name: rr
   requirement: !ruby/object:Gem::Requirement
+    none: false
     requirements:
-    - - ">="
+    - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
+    none: false
     requirements:
-    - - ">="
+    - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: vcr
   requirement: !ruby/object:Gem::Requirement
+    none: false
     requirements:
-    - - ">="
+    - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
+    none: false
     requirements:
-    - - ">="
+    - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: webmock
   requirement: !ruby/object:Gem::Requirement
+    none: false
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: '1'
-    - - ">="
+    - - ! '>='
       - !ruby/object:Gem::Version
         version: 1.17.3
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
+    none: false
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: '1'
-    - - ">="
+    - - ! '>='
       - !ruby/object:Gem::Version
         version: 1.17.3
 description: Ruby client for the https://www.contentful.com Content Delivery API
@@ -148,29 +167,27 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".gitignore"
-- ".rspec"
-- ".travis.yml"
-- CHANGELOG.md
-- Gemfile
-- Gemfile.lock
-- LICENSE.txt
-- README.md
-- Rakefile
-- contentful.gemspec
+- .gitignore
+- .rspec
+- .travis.yml
 - coverage/.last_run.json
 - coverage/.resultset.json
+- CHANGELOG.md
+- contentful.gemspec
 - examples/custom_classes.rb
 - examples/dynamic_entries.rb
 - examples/example_queries.rb
 - examples/raise_errors.rb
 - examples/raw_mode.rb
 - examples/resource_mapping.rb
-- lib/contentful.rb
+- Gemfile
+- Gemfile.lock
 - lib/contentful/array.rb
 - lib/contentful/asset.rb
 - lib/contentful/client.rb
 - lib/contentful/content_type.rb
+- lib/contentful/deleted_asset.rb
+- lib/contentful/deleted_entry.rb
 - lib/contentful/dynamic_entry.rb
 - lib/contentful/entry.rb
 - lib/contentful/error.rb
@@ -180,15 +197,22 @@ files:
 - lib/contentful/locale.rb
 - lib/contentful/location.rb
 - lib/contentful/request.rb
-- lib/contentful/resource.rb
+- lib/contentful/resource/array_like.rb
 - lib/contentful/resource/asset_fields.rb
 - lib/contentful/resource/fields.rb
 - lib/contentful/resource/system_properties.rb
+- lib/contentful/resource.rb
 - lib/contentful/resource_builder.rb
 - lib/contentful/response.rb
 - lib/contentful/space.rb
 - lib/contentful/support.rb
+- lib/contentful/sync.rb
+- lib/contentful/sync_page.rb
 - lib/contentful/version.rb
+- lib/contentful.rb
+- LICENSE.txt
+- Rakefile
+- README.md
 - spec/array_spec.rb
 - spec/asset_spec.rb
 - spec/auto_includes_spec.rb
@@ -196,6 +220,8 @@ files:
 - spec/client_configuration_spec.rb
 - spec/coercions_spec.rb
 - spec/content_type_spec.rb
+- spec/deleted_asset_spec.rb
+- spec/deleted_entry_spec.rb
 - spec/dynamic_entry_spec.rb
 - spec/entry_spec.rb
 - spec/error_class_spec.rb
@@ -226,6 +252,11 @@ files:
 - spec/fixtures/vcr_cassettes/nyancat.yml
 - spec/fixtures/vcr_cassettes/reloaded_entry.yml
 - spec/fixtures/vcr_cassettes/space.yml
+- spec/fixtures/vcr_cassettes/sync_deleted_asset.yml
+- spec/fixtures/vcr_cassettes/sync_deleted_entry.yml
+- spec/fixtures/vcr_cassettes/sync_deletion.yml
+- spec/fixtures/vcr_cassettes/sync_page.yml
+- spec/fixtures/vcr_cassettes/sync_page_2.yml
 - spec/fixtures/vcr_cassettes/unauthorized.yml
 - spec/link_spec.rb
 - spec/locale_spec.rb
@@ -239,29 +270,39 @@ files:
 - spec/support/client.rb
 - spec/support/json_responses.rb
 - spec/support/vcr.rb
+- spec/sync_page_spec.rb
+- spec/sync_spec.rb
+- TAGS
 homepage: https://github.com/contentful/contentful.rb
 licenses:
 - MIT
-metadata: {}
 post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
   requirements:
-  - - ">="
+  - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
+      segments:
+      - 0
+      hash: -620049112391953740
 required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
   requirements:
-  - - ">="
+  - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
+      segments:
+      - 0
+      hash: -620049112391953740
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.0
+rubygems_version: 1.8.23.2
 signing_key: 
-specification_version: 4
+specification_version: 3
 summary: contentful
 test_files:
 - spec/array_spec.rb
@@ -271,6 +312,8 @@ test_files:
 - spec/client_configuration_spec.rb
 - spec/coercions_spec.rb
 - spec/content_type_spec.rb
+- spec/deleted_asset_spec.rb
+- spec/deleted_entry_spec.rb
 - spec/dynamic_entry_spec.rb
 - spec/entry_spec.rb
 - spec/error_class_spec.rb
@@ -301,6 +344,11 @@ test_files:
 - spec/fixtures/vcr_cassettes/nyancat.yml
 - spec/fixtures/vcr_cassettes/reloaded_entry.yml
 - spec/fixtures/vcr_cassettes/space.yml
+- spec/fixtures/vcr_cassettes/sync_deleted_asset.yml
+- spec/fixtures/vcr_cassettes/sync_deleted_entry.yml
+- spec/fixtures/vcr_cassettes/sync_deletion.yml
+- spec/fixtures/vcr_cassettes/sync_page.yml
+- spec/fixtures/vcr_cassettes/sync_page_2.yml
 - spec/fixtures/vcr_cassettes/unauthorized.yml
 - spec/link_spec.rb
 - spec/locale_spec.rb
@@ -314,3 +362,5 @@ test_files:
 - spec/support/client.rb
 - spec/support/json_responses.rb
 - spec/support/vcr.rb
+- spec/sync_page_spec.rb
+- spec/sync_spec.rb