contentful 0.1.0

data/spec/link_spec.rb

@@ -0,0 +1,40 @@
+require 'spec_helper'
+
+describe Contentful::Link do
+  let(:entry){ vcr('entry'){ create_client.entry('nyancat') } }
+  let(:link){ entry.space }
+  let(:content_type_link){ entry.content_type }
+
+  describe 'SystemProperties' do
+    it 'has a #sys getter returning a hash with symbol keys' do
+      expect( link.sys ).to be_a Hash
+      expect( link.sys.keys.sample ).to be_a Symbol
+    end
+
+    it 'has #id' do
+      expect( link.id ).to eq "cfexampleapi"
+    end
+
+    it 'has #type' do
+      expect( link.type ).to eq "Link"
+    end
+
+    it 'has #link_type' do
+      expect( link.link_type ).to eq "Space"
+    end
+  end
+
+  describe '#resolve' do
+    it 'queries the api for the resource' do
+      vcr('space'){
+        expect( link.resolve ).to be_a Contentful::Space
+      }
+    end
+
+    it 'queries the api for the resource (different link object)' do
+      vcr('content_type'){
+        expect( content_type_link.resolve ).to be_a Contentful::ContentType
+      }
+    end
+  end
+end

data/spec/locale_spec.rb

@@ -0,0 +1,20 @@
+require 'spec_helper'
+
+describe Contentful::Locale do
+  let(:locale){ vcr('locale'){ create_client.space.locales.first } }
+
+  describe 'Properties' do
+    it 'has a #properties getter returning a hash with symbol keys' do
+      expect( locale.properties ).to be_a Hash
+      expect( locale.properties.keys.sample ).to be_a Symbol
+    end
+
+    it 'has #code' do
+      expect( locale.code ).to eq "en-US"
+    end
+
+    it 'has #name' do
+      expect( locale.name ).to eq "English"
+    end
+  end
+end

data/spec/location_spec.rb

@@ -0,0 +1,30 @@
+require 'spec_helper'
+
+describe Contentful::Location do
+  let(:location){
+    vcr('location'){
+      Contentful::Client.new(
+        space: 'lzjz8hygvfgu',
+        access_token: '0c6ef483524b5e46b3bafda1bf355f38f5f40b4830f7599f790a410860c7c271',
+        dynamic_entries: :auto,
+      ).entry('3f6fq5ylFCi4kIYAQKsAYG').location
+    }
+  }
+
+  describe 'Properties' do
+    it 'has a #properties getter returning a hash with symbol keys' do
+      expect( location.properties ).to be_a Hash
+      expect( location.properties.keys.sample ).to be_a Symbol
+    end
+
+    it 'has #lat' do
+      expect( location.lat ).to be_a Float
+      expect( location.lat.to_i ).to eq 36
+    end
+
+    it 'has #lon' do
+      expect( location.lon ).to be_a Float
+      expect( location.lon.to_i ).to eq -94
+    end
+  end
+end

data/spec/request_spec.rb

@@ -0,0 +1,48 @@
+require 'spec_helper'
+
+describe Contentful::Request do
+  describe '#get' do
+    it 'calls client' do
+      client = create_client
+      stub(client).get
+      request = Contentful::Request.new(client, '/content_types', nil, 'nyancat')
+      request.get
+      expect( client ).to have_received.get(request)
+    end
+  end
+
+  context '[single resource]' do
+    let(:request){
+      Contentful::Request.new(create_client, '/content_types', nil, 'nyancat')
+    }
+
+    describe '#url' do
+      it 'contais endpoint' do
+        expect( request.url ).to include 'content_types'
+      end
+
+      it 'contains id' do
+        expect( request.url ).to include 'nyancat'
+      end
+    end
+  end
+
+  context '[multi resource]' do
+    let(:request){
+      Contentful::Request.new(create_client, '/content_types', {"something" => 'requested'})
+    }
+
+    describe '#query' do
+      it 'contains query' do
+        expect( request.query ).not_to be_empty
+        expect( request.query[:something] ).to eq 'requested'
+      end
+    end
+
+    describe '#url' do
+      it 'contais endpoint' do
+        expect( request.url ).to include 'content_types'
+      end
+    end
+  end
+end

data/spec/resource_spec.rb

@@ -0,0 +1,52 @@
+require 'spec_helper'
+
+describe Contentful::Resource do
+  it 'must be included to get functionality' do
+    c = Class.new
+    c.send :include, Contentful::Resource
+    expect( c ).to respond_to :property_coercions
+  end
+
+  describe 'creation' do
+    it 'must be initialized with a (hash) object' do
+      expect{
+        Contentful::ContentType.new json_fixture('nyancat')
+      }.not_to raise_error
+    end
+
+    it 'can deal with invalid objects' do
+      expect{
+        Contentful::ContentType.new({})
+      }.not_to raise_error
+    end
+  end
+
+  describe '#request' do
+    it 'will return a request object, if it has been initialized with one' do
+      request  = Contentful::Request.new(nil, 'content_types')
+      resource = Contentful::ContentType.new({}, request)
+      expect( resource.request ).to eq request
+    end
+  end
+
+  describe '#reload' do
+    let(:client){ create_client }
+    let(:entry){ vcr('entry'){ client.entry 'nyancat' } }
+
+    it 'triggers the request connected to the resource (again)' do
+      stub(entry.request).get
+      entry.reload
+      expect( entry.request ).to have_received.get
+    end
+
+    it 'the reloaded resource is different from the original one' do
+      reloaded_entry = vcr('reloaded_entry'){ entry.reload }
+      expect( reloaded_entry ).to be_a Contentful::Entry
+      expect( reloaded_entry ).not_to be entry
+    end
+
+    it 'will return false if #request not available' do
+      expect( Contentful::ContentType.new({}).reload ).to be_false
+    end
+  end
+end

data/spec/response_spec.rb

@@ -0,0 +1,50 @@
+require 'spec_helper'
+
+describe Contentful::Response do
+  let(:successful_response){ Contentful::Response.new raw_fixture('nyancat'), Contentful::Request.new(nil, '/entries', nil, 'nyancat') }
+  let(:error_response){ Contentful::Response.new raw_fixture('not_found') }
+  let(:unparsable_response){ Contentful::Response.new raw_fixture('unparsable') }
+
+  describe "#raw" do
+    it "returns the raw response it has been initalized with" do
+      expect( successful_response.raw ).to eq raw_fixture('nyancat')
+    end
+  end
+
+  describe "#object" do
+    it "returns the repsonse's parsed json" do
+      expect( successful_response.object ).to eq json_fixture('nyancat')
+    end
+  end
+
+  describe "#request" do
+    it "returns the request the response has been initalized with" do
+      expect( successful_response.request ).to be_a Contentful::Request
+    end
+  end
+
+  describe "#status" do
+    it 'returns :ok for normal responses' do
+      expect( successful_response.status ).to eq :ok
+    end
+
+    it 'returns :contentful_error for error responses' do
+      expect( error_response.status ).to eq :contentful_error
+    end
+
+    it 'returns :unparsable_json for unparsable json responses' do
+      expect( unparsable_response.status ).to eq :unparsable_json
+    end
+  end
+
+  describe "#error_message" do
+    it 'returns contentful error message for contentful errors' do
+      expect( error_response.error_message ).to eq "The resource could not be found."
+    end
+
+    it 'returns json parser error message for json parse errors' do
+      expect( unparsable_response.error_message ).to include "unexpected token"
+    end
+  end
+
+end

data/spec/space_spec.rb

@@ -0,0 +1,36 @@
+require 'spec_helper'
+
+describe Contentful::Space do
+  let(:space){ vcr('space'){ create_client.space } }
+
+  describe 'SystemProperties' do
+    it 'has a #sys getter returning a hash with symbol keys' do
+      expect( space.sys ).to be_a Hash
+      expect( space.sys.keys.sample ).to be_a Symbol
+    end
+
+    it 'has #id' do
+      expect( space.id ).to eq "cfexampleapi"
+    end
+
+    it 'has #type' do
+      expect( space.type ).to eq "Space"
+    end
+  end
+
+  describe 'Properties' do
+    it 'has a #properties getter returning a hash with symbol keys' do
+      expect( space.properties ).to be_a Hash
+      expect( space.properties.keys.sample ).to be_a Symbol
+    end
+
+    it 'has #name' do
+      expect( space.name ).to eq "Contentful Example API"
+    end
+
+    it 'has #locales' do
+      expect( space.locales ).to be_a Array
+      expect( space.locales.first ).to be_a Contentful::Locale
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,6 @@
+require 'rspec'
+require 'contentful'
+require 'securerandom'
+require 'rr'
+
+Dir[File.dirname(__FILE__) + '/support/**/*.rb'].each{ |f| require f }

data/spec/support/client.rb

@@ -0,0 +1,6 @@
+def create_client(options = {})
+  Contentful::Client.new({
+    space: 'cfexampleapi',
+    access_token: 'b4c0n73n7fu1',
+  }.merge(options))
+end

data/spec/support/json_responses.rb

@@ -0,0 +1,11 @@
+require 'multi_json'
+
+def raw_fixture(which, as_json = false)
+  File.read File.dirname(__FILE__) + "/../fixtures/json_responses/#{which}.json"
+end
+
+def json_fixture(which, as_json = false)
+  MultiJson.load(
+    File.read File.dirname(__FILE__) + "/../fixtures/json_responses/#{which}.json"
+  )
+end

data/spec/support/vcr.rb

@@ -0,0 +1,16 @@
+require 'vcr'
+
+VCR.configure do |c|
+  c.cassette_library_dir = 'spec/fixtures/vcr_cassettes'
+  c.ignore_localhost = true
+  c.hook_into :webmock
+  c.default_cassette_options = { :record => :once }
+end
+
+def vcr(name, &block)
+  VCR.use_cassette(name, &block)
+end
+
+def expect_vcr(name, &block)
+  expect{ VCR.use_cassette(name, &block) }
+end

metadata

@@ -0,0 +1,374 @@
+--- !ruby/object:Gem::Specification
+name: contentful
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+  prerelease: 
+platform: ruby
+authors:
+- Contentful GmbH (Jan Lelis)
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-03-14 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'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0'
+- !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
+email: rubygems@contentful.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .travis.yml
+- .rspec
+- .README.md.swp
+- doc/js/full_list.js
+- doc/js/app.js
+- doc/js/jquery.js
+- doc/css/style.css
+- doc/css/full_list.css
+- doc/css/common.css
+- doc/Contentful.html
+- doc/file_list.html
+- doc/Contentful/Field.html
+- doc/Contentful/Locale.html
+- doc/Contentful/ResourceBuilder.html
+- doc/Contentful/Asset.html
+- doc/Contentful/NotFound.html
+- doc/Contentful/Unauthorized.html
+- doc/Contentful/Request.html
+- doc/Contentful/Link.html
+- doc/Contentful/Response.html
+- doc/Contentful/Error.html
+- doc/Contentful/Array.html
+- doc/Contentful/ContentType.html
+- doc/Contentful/File.html
+- doc/Contentful/UnparsableResource.html
+- doc/Contentful/ServerError.html
+- doc/Contentful/AccessDenied.html
+- doc/Contentful/Space.html
+- doc/Contentful/Resource.html
+- doc/Contentful/DynamicEntry.html
+- doc/Contentful/Support.html
+- doc/Contentful/Entry.html
+- doc/Contentful/UnparsableJson.html
+- doc/Contentful/BadRequest.html
+- doc/Contentful/Resource/SystemProperties.html
+- doc/Contentful/Resource/Fields/ClassMethods.html
+- doc/Contentful/Resource/SystemProperties/ClassMethods.html
+- doc/Contentful/Resource/ClassMethods.html
+- doc/Contentful/Resource/AssetFields/ClassMethods.html
+- doc/Contentful/Resource/AssetFields.html
+- doc/Contentful/Resource/Fields.html
+- doc/Contentful/Client.html
+- doc/index.html
+- doc/class_list.html
+- doc/top-level-namespace.html
+- doc/_index.html
+- doc/file.README.html
+- doc/method_list.html
+- doc/frames.html
+- lib/contentful/dynamic_entry.rb
+- lib/contentful/response.rb
+- lib/contentful/space.rb
+- lib/contentful/resource/fields.rb
+- lib/contentful/resource/system_properties.rb
+- lib/contentful/resource/asset_fields.rb
+- lib/contentful/error.rb
+- lib/contentful/link.rb
+- lib/contentful/field.rb
+- lib/contentful/resource.rb
+- lib/contentful/resource_builder.rb
+- lib/contentful/file.rb
+- lib/contentful/content_type.rb
+- lib/contentful/request.rb
+- lib/contentful/entry.rb
+- lib/contentful/locale.rb
+- lib/contentful/location.rb
+- lib/contentful/client.rb
+- lib/contentful/array.rb
+- lib/contentful/support.rb
+- lib/contentful/asset.rb
+- lib/contentful/version.rb
+- lib/contentful.rb
+- spec/request_spec.rb
+- spec/space_spec.rb
+- spec/entry_spec.rb
+- spec/error_class_spec.rb
+- spec/spec_helper.rb
+- spec/array_spec.rb
+- spec/asset_spec.rb
+- spec/coercions_spec.rb
+- spec/link_spec.rb
+- spec/field_spec.rb
+- spec/resource_spec.rb
+- spec/location_spec.rb
+- spec/dynamic_entry_spec.rb
+- spec/locale_spec.rb
+- spec/support/json_responses.rb
+- spec/support/vcr.rb
+- spec/support/client.rb
+- spec/auto_includes_spec.rb
+- spec/fixtures/vcr_cassettes/array_page_1.yml
+- spec/fixtures/vcr_cassettes/array_page_2.yml
+- spec/fixtures/vcr_cassettes/field.yml
+- spec/fixtures/vcr_cassettes/space.yml
+- spec/fixtures/vcr_cassettes/content_type.yml
+- spec/fixtures/vcr_cassettes/asset.yml
+- spec/fixtures/vcr_cassettes/unauthorized.yml
+- spec/fixtures/vcr_cassettes/locale.yml
+- spec/fixtures/vcr_cassettes/array.yml
+- spec/fixtures/vcr_cassettes/location.yml
+- spec/fixtures/vcr_cassettes/entries.yml
+- spec/fixtures/vcr_cassettes/not_found.yml
+- spec/fixtures/vcr_cassettes/bad_request.yml
+- spec/fixtures/vcr_cassettes/nyancat.yml
+- spec/fixtures/vcr_cassettes/entry.yml
+- spec/fixtures/vcr_cassettes/entry_cache.yml
+- spec/fixtures/vcr_cassettes/reloaded_entry.yml
+- spec/fixtures/vcr_cassettes/nyancat_include.yml
+- spec/fixtures/json_responses/unparsable.json
+- spec/fixtures/json_responses/not_found.json
+- spec/fixtures/json_responses/nyancat.json
+- spec/fixtures/json_responses/content_type.json
+- spec/client_configuration_spec.rb
+- spec/content_type_spec.rb
+- spec/response_spec.rb
+- spec/client_class_spec.rb
+- spec/file_spec.rb
+- spec/error_requests_spec.rb
+- README.md
+- Rakefile
+- contentful.gemspec
+- do_request.sh
+- LICENSE.txt
+- examples/dynamic_entries.rb
+- examples/resource_mapping.rb
+- examples/raise_errors.rb
+- examples/example_queries.rb
+- examples/raw_mode.rb
+- examples/custom_classes.rb
+- Gemfile
+- ChangeLog.md
+homepage: https://github.com/contentful/contentful.rb
+licenses:
+- MIT
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: contentful
+test_files:
+- spec/request_spec.rb
+- spec/space_spec.rb
+- spec/entry_spec.rb
+- spec/error_class_spec.rb
+- spec/spec_helper.rb
+- spec/array_spec.rb
+- spec/asset_spec.rb
+- spec/coercions_spec.rb
+- spec/link_spec.rb
+- spec/field_spec.rb
+- spec/resource_spec.rb
+- spec/location_spec.rb
+- spec/dynamic_entry_spec.rb
+- spec/locale_spec.rb
+- spec/support/json_responses.rb
+- spec/support/vcr.rb
+- spec/support/client.rb
+- spec/auto_includes_spec.rb
+- spec/fixtures/vcr_cassettes/array_page_1.yml
+- spec/fixtures/vcr_cassettes/array_page_2.yml
+- spec/fixtures/vcr_cassettes/field.yml
+- spec/fixtures/vcr_cassettes/space.yml
+- spec/fixtures/vcr_cassettes/content_type.yml
+- spec/fixtures/vcr_cassettes/asset.yml
+- spec/fixtures/vcr_cassettes/unauthorized.yml
+- spec/fixtures/vcr_cassettes/locale.yml
+- spec/fixtures/vcr_cassettes/array.yml
+- spec/fixtures/vcr_cassettes/location.yml
+- spec/fixtures/vcr_cassettes/entries.yml
+- spec/fixtures/vcr_cassettes/not_found.yml
+- spec/fixtures/vcr_cassettes/bad_request.yml
+- spec/fixtures/vcr_cassettes/nyancat.yml
+- spec/fixtures/vcr_cassettes/entry.yml
+- spec/fixtures/vcr_cassettes/entry_cache.yml
+- spec/fixtures/vcr_cassettes/reloaded_entry.yml
+- spec/fixtures/vcr_cassettes/nyancat_include.yml
+- spec/fixtures/json_responses/unparsable.json
+- spec/fixtures/json_responses/not_found.json
+- spec/fixtures/json_responses/nyancat.json
+- spec/fixtures/json_responses/content_type.json
+- spec/client_configuration_spec.rb
+- spec/content_type_spec.rb
+- spec/response_spec.rb
+- spec/client_class_spec.rb
+- spec/file_spec.rb
+- spec/error_requests_spec.rb
+has_rdoc: