contentful 0.3.4 → 0.3.5

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 457f3ffcb4578d1cabdc27b4fca30123f4f55168
+  data.tar.gz: 7fda79c6a4f4a72cd741f98a60d12cbb176f69ae
+SHA512:
+  metadata.gz: 12180232bf6cf60187fc190c0ea0a31d87fd96fbe6358710dd892c19f0625ae9c485e196c201c95b9ae70a07bc22a5b34a1ecd4db1c83528912edbbe08dc2a4e
+  data.tar.gz: cac25970176537ea082e5747d63740d8a70ae24cc3f637c7b0dce225b38a47b5be6ac5e87ce5e12a34147eae8a0300aa39d20f1eb64b6f0ed9c0f8ebf49a7c72

data/.travis.yml

@@ -5,4 +5,4 @@ rvm:
   - 2.1
   - 2.0.0
   - 1.9.3
-  - jruby-19mode
+#  - jruby-19mode

data/CHANGELOG.md

@@ -1,45 +1,64 @@
-### 0.3.4
-* add optional gzip compression
+# Change Log
+## 0.3.5
+### Added
+* Logging of requests
 
-### 0.3.3
-* Fix: handle 503 errors from the api
+### Fixed
+* Cleaner and better error handling
 
-### 0.3.2
-* add default property to locale, #23
+### Other
+* Code cleanup
+* Remove encoding strings from the source code files
 
-### 0.3.1
-* return nil when a value is not supplied, fixes #18
-* do not parse empty responses
-* remove CGI dependency for http gem
+## 0.3.4
+### Added
+* Optional gzip compression
 
-### 0.3.0
+## 0.3.3
+### Fixed
+* Fix: handle 503 errors from the API
 
-* Support Synchronization
+## 0.3.2
+### Added
+* Default property to locale, #23
+
+## 0.3.1
+### Fixed
+* Return nil when a value is not supplied, fixes #18
+* Do not parse empty responses
 
+### Other
+* Remove CGI dependency for http Gem
 
-### 0.2.0
+## 0.3.0
+### Added
+* Support Synchronization
 
+## 0.2.0
+### Added
 * Introduce new :entry_mapping configuration to enable custom Entry classes based on ContentTypes
+
+### Other
 * Update HTTP gem dependency to 0.6
 * Convert arrays in query values to strings, separated by comma
 
 
-### 0.1.3
+## 0.1.3
+### Fixed
+* Better link inclusion processing, prevents "stack level to deep" errors
 
-* Better link inclusion processing, prevent "stack level to deep" errors
 
+## 0.1.2
+### Fixed
+* The way all content types are retrieved
 
-### 0.1.2
 
-* Fix the way all content types are retrieved
+## 0.1.1
+### Fixed
+* Bug that prevented fields with multiple resources to be parsed correctly
 
-
-### 0.1.1
-
-* Fix a bug that prevented fields with multiple resources to be parsed correctly
+### Other
 * Restrict HTTP gem dependency to < 0.6
 
-
-### 0.1.0
-
+## 0.1.0
 * Initial release.

data/README.md

@@ -172,6 +172,28 @@ See next paragraph for explanation
 
 Enables gzip response content encoding, default to: true
 
+### :logger
+
+Logging is disabled by default, it can be enabled by setting a logger instance and a logging severity.
+```ruby
+client = Contentful::Client.new(
+  access_token: 'b4c0n73n7fu1',
+  space: 'cfexampleapi',
+  logger: logger_instance,
+  log_level: Logger::DEBUG
+)
+```
+Example loggers:
+
+```ruby
+Rails.logger
+Logger.new('logfile.log')
+```
+
+### :log_level
+The default severity is set to INFO and logs only the request attributes (headers, parameters and url). Setting it to DEBUG will also log the raw JSON response.
+
+
 ## Advanced Usage
 ### Custom Resource Classes
 

data/RELEASE.md

@@ -0,0 +1,8 @@
+# Releasing new versions:
+
+Make sure all points are taken care of:
+
+- [ ] Make sure tests are green.
+- [ ] Update Changelog: http://keepachangelog.com/
+- [ ] Bump version number: http://semver.org/
+- [ ] Release gem and communicate updates

data/Rakefile

@@ -1,12 +1,10 @@
-# encoding: utf-8
-
 require 'rubygems'
 
 begin
   require 'bundler'
 rescue LoadError => e
   warn e.message
-  warn "Run `gem install bundler` to install Bundler."
+  warn 'Run `gem install bundler` to install Bundler.'
   exit -1
 end
 
@@ -14,7 +12,7 @@ begin
   Bundler.setup(:development)
 rescue Bundler::BundlerError => e
   warn e.message
-  warn "Run `bundle install` to install missing gems."
+  warn 'Run `bundle install` to install missing gems.'
   exit e.status_code
 end
 
@@ -26,5 +24,5 @@ Gem::Tasks.new
 require 'rspec/core/rake_task'
 RSpec::Core::RakeTask.new
 
-task :test    => :spec
-task :default => :spec
+task test: :spec
+task default: :spec

data/contentful.gemspec

@@ -1,19 +1,17 @@
-# -*- encoding: utf-8 -*-
-
 require File.expand_path('../lib/contentful/version', __FILE__)
 
 Gem::Specification.new do |gem|
-  gem.name          = "contentful"
+  gem.name          = 'contentful'
   gem.version       = Contentful::VERSION
   gem.summary       = 'contentful'
   gem.description   = 'Ruby client for the https://www.contentful.com Content Delivery API'
-  gem.license       = "MIT"
-  gem.authors       = ["Contentful GmbH (Jan Lelis)",'Contentful GmbH (Andreas Tiefenthaler)']
-  gem.email         = "rubygems@contentful.com"
-  gem.homepage      = "https://github.com/contentful/contentful.rb"
+  gem.license       = 'MIT'
+  gem.authors       = ['Contentful GmbH (Jan Lelis)', 'Contentful GmbH (Andreas Tiefenthaler)']
+  gem.email         = 'rubygems@contentful.com'
+  gem.homepage      = 'https://github.com/contentful/contentful.rb'
 
-  gem.files         = Dir['{**/}{.*,*}'].select { |path| File.file?(path) && !path.start_with?("pkg") }
-  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.files         = Dir['{**/}{.*,*}'].select { |path| File.file?(path) && !path.start_with?('pkg') }
+  gem.executables   = gem.files.grep(%r{^bin/}).map { |f| File.basename(f) }
   gem.test_files    = gem.files.grep(%r{^spec/})
   gem.require_paths = ['lib']
 

data/examples/custom_classes.rb

@@ -20,7 +20,7 @@ end
 res = MyResource.new(
   'some' => 'value',
   'age' => '25',
-  'country' => {'code' => 'de', 'name' => 'Deutschland'},
+  'country' => { 'code' => 'de', 'name' => 'Deutschland' },
   'unknown_property' => 'ignored'
 )
 
@@ -29,7 +29,6 @@ p res.age # => 25
 p res.country # #<Contentful::Locale: ...
 p res.unknown_property # NoMethodError
 
-
 # Another possibility to create customized resources is to just inherit from an
 # existing one:
 

data/examples/dynamic_entries.rb

@@ -6,7 +6,7 @@ require 'contentful'
 
 client = Contentful::Client.new(
   space: 'cfexampleapi',
-  access_token: "b4c0n73n7fu1",
+  access_token: 'b4c0n73n7fu1',
   dynamic_entries: :manual,
 )
 
@@ -22,7 +22,6 @@ p nyancat.is_a? CatEntry # => true
 p nyancat.fields[:name] # => "Nyan Cat" # This would also be possible with a non-dynamic entry
 p nyancat.name # => "Nyan Cat"
 
-
 # You don't need to initialize a ContentType resource to create a DynamicEntry
 # You could also pass the content type's JSON representation:
 
@@ -112,12 +111,11 @@ SuperCatEntry = Contentful::DynamicEntry.create <<JSON
 }
 JSON
 
-
 # AUTO MODE - All entries will be converted to dynamic entries
 
 client = Contentful::Client.new(
   space: 'cfexampleapi',
-  access_token: "b4c0n73n7fu1",
+  access_token: 'b4c0n73n7fu1',
   dynamic_entries: :auto,
 )
 

data/examples/example_queries.rb

@@ -1,9 +1,8 @@
 require 'contentful'
 
-
 client = Contentful::Client.new(
   space: 'cfexampleapi',
-  access_token: "b4c0n73n7fu1",
+  access_token: 'b4c0n73n7fu1',
 )
 
 p client.space
@@ -24,4 +23,4 @@ p client.entries(
 p client.content_types(
   order: '-sys.updatedAt',
   limit: 3,
-)
+)

data/examples/raise_errors.rb

@@ -1,9 +1,8 @@
 require 'contentful'
 
-
 client = Contentful::Client.new(
   space: 'cfexampleapi',
-  access_token: "b4c0n73n7fu1",
+  access_token: 'b4c0n73n7fu1',
 )
 
 begin
@@ -12,11 +11,10 @@ rescue => error
   p error
 end
 
-
 client2 = Contentful::Client.new(
   space: 'cfexampleapi',
-  access_token: "b4c0n73n7fu1",
+  access_token: 'b4c0n73n7fu1',
   raise_errors: false,
 )
 
-p client2.entry 'not found'
+p client2.entry 'not found'

data/examples/raw_mode.rb

@@ -1,9 +1,8 @@
 require 'contentful'
 
-
 client = Contentful::Client.new(
   space: 'cfexampleapi',
-  access_token: "b4c0n73n7fu1",
+  access_token: 'b4c0n73n7fu1',
   raw_mode: true,
 )
 
@@ -12,4 +11,4 @@ p entry.is_a? Contentful::Resource # false
 p entry.is_a? Contentful::Response # true
 p entry.status
 p entry
-puts entry.raw
+puts entry.raw

data/examples/resource_mapping.rb

@@ -6,7 +6,6 @@
 # - a Proc, that returns the Class to use
 # - a Symbol for a method of the ResourceBuilder object
 
-
 require 'contentful'
 
 class MyBetterArray < Contentful::Array
@@ -18,13 +17,13 @@ end
 
 client = Contentful::Client.new(
   space: 'cfexampleapi',
-  access_token: "b4c0n73n7fu1",
+  access_token: 'b4c0n73n7fu1',
   resource_mapping: {
     'Array' => MyBetterArray,
-    'Asset' => ->(json_object){
+    'Asset' => ->(_json_object)do
       # might return different class if some criteria is matched
       Contentful::Asset
-    },
+    end,
   }
 )
 

data/lib/contentful/array.rb

@@ -28,6 +28,5 @@ module Contentful
         false
       end
     end
-
   end
 end

data/lib/contentful/asset.rb

@@ -22,7 +22,7 @@ module Contentful
         h:  options[:h]  || options[:height],
         fm: options[:fm] || options[:format],
         q:  options[:q]  || options[:quality]
-      }.reject { |k, v| v.nil? }
+      }.reject { |_k, v| v.nil? }
 
       if query.empty?
         file.url

data/lib/contentful/client.rb

@@ -4,6 +4,7 @@ require_relative 'resource_builder'
 require_relative 'sync'
 
 require 'http'
+require 'logger'
 
 module Contentful
   # The client object is initialized with a space and a key and then used
@@ -11,21 +12,23 @@ module Contentful
   # See README for details
   class Client
     DEFAULT_CONFIGURATION = {
-      secure: true,
-      raise_errors: true,
-      dynamic_entries: :manual,
-      api_url: 'cdn.contentful.com',
-      api_version: 1,
-      authentication_mechanism: :header,
-      resource_builder: ResourceBuilder,
-      resource_mapping: {},
-      entry_mapping: {},
-      default_locale: 'en-US',
-      raw_mode: false,
-      gzip_encoded: false
+        secure: true,
+        raise_errors: true,
+        dynamic_entries: :manual,
+        api_url: 'cdn.contentful.com',
+        api_version: 1,
+        authentication_mechanism: :header,
+        resource_builder: ResourceBuilder,
+        resource_mapping: {},
+        entry_mapping: {},
+        default_locale: 'en-US',
+        raw_mode: false,
+        gzip_encoded: false,
+        logger: false,
+        log_level: Logger::INFO
     }
 
-    attr_reader :configuration, :dynamic_entry_cache
+    attr_reader :configuration, :dynamic_entry_cache, :logger
 
     # Wraps the actual HTTP request
     def self.get_http(url, query, headers = {})
@@ -36,6 +39,7 @@ module Contentful
       @configuration = default_configuration.merge(given_configuration)
       normalize_configuration!
       validate_configuration!
+      setup_logger
 
       if configuration[:dynamic_entries] == :auto
         update_dynamic_entry_cache!
@@ -44,6 +48,11 @@ module Contentful
       end
     end
 
+    def setup_logger
+      @logger = configuration[:logger]
+      logger.level = configuration[:log_level] if logger
+    end
+
     # Returns the default configuration
     def default_configuration
       DEFAULT_CONFIGURATION.dup
@@ -105,9 +114,9 @@ module Contentful
 
     # Returns the headers used for the HTTP requests
     def request_headers
-      headers = { 'User-Agent' => "RubyContentfulGem/#{Contentful::VERSION}" }
+      headers = {'User-Agent' => "RubyContentfulGem/#{Contentful::VERSION}"}
       headers['Authorization'] = "Bearer #{configuration[:access_token]}" if configuration[:authentication_mechanism] == :header
-      headers['Content-Type']  = "application/vnd.contentful.delivery.v#{configuration[:api_version].to_i}+json" if configuration[:api_version]
+      headers['Content-Type'] = "application/vnd.contentful.delivery.v#{configuration[:api_version].to_i}+json" if configuration[:api_version]
       headers['Accept-Encoding'] = 'gzip' if configuration[:gzip_encoded]
       headers
     end
@@ -115,7 +124,7 @@ module Contentful
     # Patches a query hash with the client configurations for queries
     def request_query(query)
       if configuration[:authentication_mechanism] == :query_string
-        query["access_token"] = configuration[:access_token]
+        query['access_token'] = configuration[:access_token]
       end
 
       query
@@ -126,16 +135,17 @@ module Contentful
     # return Response objects instead
     def get(request, build_resource = true)
       url = request.absolute? ? request.url : base_url + request.url
+      logger.info(request: {url: url, query: request.query, header: request_headers}) if logger
       response = Response.new(
-        self.class.get_http(
-          url,
-          request_query(request.query),
-          request_headers
-        ), request
+          self.class.get_http(
+              url,
+              request_query(request.query),
+              request_headers
+          ), request
       )
 
       return response if !build_resource || configuration[:raw_mode]
-
+      logger.debug(response: response) if logger
       result = configuration[:resource_builder].new(
           self,
           response,
@@ -144,7 +154,7 @@ module Contentful
           configuration[:default_locale]
       ).run
 
-      raise result if result.is_a?(Error) && configuration[:raise_errors]
+      fail result if result.is_a?(Error) && configuration[:raise_errors]
       result
     end
 
@@ -152,12 +162,12 @@ module Contentful
     # See README for details.
     def update_dynamic_entry_cache!
       @dynamic_entry_cache = Hash[
-        content_types(limit: 1000).map do |ct|
-          [
-            ct.id.to_sym,
-            DynamicEntry.create(ct)
-          ]
-        end
+          content_types(limit: 1000).map do |ct|
+            [
+                ct.id.to_sym,
+                DynamicEntry.create(ct)
+            ]
+          end
       ]
     end
 
@@ -170,11 +180,10 @@ module Contentful
     # Create a new synchronisation object
     # Takes sync options or a sync_url
     # You will need to call #each_page or #first_page on it
-    def sync(options = { initial: true })
+    def sync(options = {initial: true})
       Sync.new(self, options)
     end
 
-
     private
 
     def normalize_configuration!
@@ -184,31 +193,31 @@ module Contentful
 
     def validate_configuration!
       if configuration[:space].empty?
-        raise ArgumentError, 'You will need to initialize a client with a :space'
+        fail ArgumentError, 'You will need to initialize a client with a :space'
       end
 
       if configuration[:access_token].empty?
-        raise ArgumentError, 'You will need to initialize a client with an :access_token'
+        fail ArgumentError, 'You will need to initialize a client with an :access_token'
       end
 
       if configuration[:api_url].empty?
-        raise ArgumentError, 'The client configuration needs to contain an :api_url'
+        fail ArgumentError, 'The client configuration needs to contain an :api_url'
       end
 
       if configuration[:default_locale].empty?
-        raise ArgumentError, 'The client configuration needs to contain a :default_locale'
+        fail ArgumentError, 'The client configuration needs to contain a :default_locale'
       end
 
       unless configuration[:api_version].to_i >= 0
-        raise ArgumentError, 'The :api_version must be a positive number or nil'
+        fail ArgumentError, 'The :api_version must be a positive number or nil'
       end
 
       unless [:header, :query_string].include? configuration[:authentication_mechanism]
-        raise ArgumentError, 'The authentication mechanism must be :header or :query_string'
+        fail ArgumentError, 'The authentication mechanism must be :header or :query_string'
       end
 
       unless [:auto, :manual].include? configuration[:dynamic_entries]
-        raise ArgumentError, 'The :dynamic_entries mode must be :auto or :manual'
+        fail ArgumentError, 'The :dynamic_entries mode must be :auto or :manual'
       end
     end
   end