contentful 0.3.5 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 457f3ffcb4578d1cabdc27b4fca30123f4f55168
-  data.tar.gz: 7fda79c6a4f4a72cd741f98a60d12cbb176f69ae
+  metadata.gz: ca7aa5d86409ba09e10e10ad5056804799157b03
+  data.tar.gz: e8a7314fea96f4053656adaa1c88b1a0264f203d
 SHA512:
-  metadata.gz: 12180232bf6cf60187fc190c0ea0a31d87fd96fbe6358710dd892c19f0625ae9c485e196c201c95b9ae70a07bc22a5b34a1ecd4db1c83528912edbbe08dc2a4e
-  data.tar.gz: cac25970176537ea082e5747d63740d8a70ae24cc3f637c7b0dce225b38a47b5be6ac5e87ce5e12a34147eae8a0300aa39d20f1eb64b6f0ed9c0f8ebf49a7c72
+  metadata.gz: 2f36a0f4e0bdef6bc0740a697f6b055eb4df6846af106695daf7dc9f54f47b9cdf914ed4ea0a5037591804920a81202c616b358779ff45826edfef168ffed596
+  data.tar.gz: d019ae9b609ae364304b4057dabab58e736e3233c90ba2685e97ebbb39d371097d68fea725f8b485d5974519ec8ef6ff6a679ed765ac340e8d58c1e46aba95e4

data/CHANGELOG.md

@@ -1,4 +1,8 @@
 # Change Log
+## 0.4.0
+### Added
+* Proxy support
+
 ## 0.3.5
 ### Added
 * Logging of requests

data/README.md

@@ -193,6 +193,32 @@ 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.
 
+### :proxy_host
+
+To be able to perform a request behind a proxy, you need to specify a ```:proxy_host```.  This can be a domain or IP address of the proxy server.
+
+### :proxy_port
+
+Specify the port number that is used by the proxy server for client connections.
+
+### :port_password, :port_username
+
+To use the proxy with authentication, you need to specify ```port_username``` and ```port_password```.
+
+
+
+### Proxy example
+
+```ruby
+client = Contentful::Client.new(
+  access_token: 'b4c0n73n7fu1',
+  space: 'cfexampleapi',
+  proxy_host: '127.0.0.1',
+  proxy_port: 8080,
+  proxy_username: 'username',
+  proxy_password: 'secret_password',
+)
+```
 
 ## Advanced Usage
 ### Custom Resource Classes
@@ -289,7 +315,7 @@ first_entry = client.sync(initial: true, type: 'Entry').first_page.items.first
 first_entry.fields('de-DE') # Returns German localizations
 ```
 
-## Ratelimit
+## Rate-limit
 The library does not make assumptions on the rate limit but reacts to `HTTP 429` by returning an error object.
 You should handle this within your code and either do the delay calculation naive (fixed amount of seconds) or more elaborated (exponential increase) depending by the structure of your code.
 

data/lib/contentful/client.rb

@@ -25,14 +25,22 @@ module Contentful
         raw_mode: false,
         gzip_encoded: false,
         logger: false,
-        log_level: Logger::INFO
+        log_level: Logger::INFO,
+        proxy_host: nil,
+        proxy_username: nil,
+        proxy_password: nil,
+        proxy_port: nil
     }
 
-    attr_reader :configuration, :dynamic_entry_cache, :logger
+    attr_reader :configuration, :dynamic_entry_cache, :logger, :proxy
 
-    # Wraps the actual HTTP request
-    def self.get_http(url, query, headers = {})
-      HTTP[headers].get(url, params: query)
+    # Wraps the actual HTTP request via proxy
+    def self.get_http(url, query, headers = {}, proxy = {})
+      if proxy[:host]
+        HTTP[headers].via(proxy[:host], proxy[:port], proxy[:username], proxy[:password]).get(url, params: query)
+      else
+        HTTP[headers].get(url, params: query)
+      end
     end
 
     def initialize(given_configuration = {})
@@ -53,6 +61,15 @@ module Contentful
       logger.level = configuration[:log_level] if logger
     end
 
+    def proxy_params
+      {
+          host: configuration[:proxy_host],
+          port: configuration[:proxy_port],
+          username: configuration[:proxy_username],
+          password: configuration[:proxy_password]
+      }
+    end
+
     # Returns the default configuration
     def default_configuration
       DEFAULT_CONFIGURATION.dup
@@ -126,7 +143,6 @@ module Contentful
       if configuration[:authentication_mechanism] == :query_string
         query['access_token'] = configuration[:access_token]
       end
-
       query
     end
 
@@ -140,7 +156,8 @@ module Contentful
           self.class.get_http(
               url,
               request_query(request.query),
-              request_headers
+              request_headers,
+              proxy_params
           ), request
       )
 

data/lib/contentful/version.rb

@@ -1,3 +1,3 @@
 module Contentful
-  VERSION = '0.3.5'
+  VERSION = '0.4.0'
 end

data/spec/client_class_spec.rb

@@ -3,7 +3,10 @@ require 'spec_helper'
 describe Contentful::Client do
   describe '#get' do
     let(:client) { create_client }
-    let(:request)do
+    let(:proxy_client) { create_client(proxy_host: '183.207.232.194',
+                                       proxy_port: 8080,
+                                       secure: false) }
+    let(:request) do
       Contentful::Request.new(nil, '/content_types', nil, 'cat')
     end
 
@@ -14,11 +17,13 @@ describe Contentful::Client do
     end
 
     it 'uses #request_headers' do
-      stub(client).request_headers do{
-        'User-Agent' => 'RubyContentfulGem/0.1.0',
-        'Authorization' => 'Bearer b4c0n73n7fu1',
-        'Content-Type' => 'application/vnd.contentful.delivery.v1+json',
-      }end
+      stub(client).request_headers do
+        {
+            'User-Agent' => 'RubyContentfulGem/0.1.0',
+            'Authorization' => 'Bearer b4c0n73n7fu1',
+            'Content-Type' => 'application/vnd.contentful.delivery.v1+json',
+        }
+      end
       vcr('content_type') { client.get(request) }
       expect(client).to have_received.request_headers
     end
@@ -38,7 +43,15 @@ describe Contentful::Client do
     it 'calls #get_http' do
       stub(client.class).get_http { raw_fixture('content_type') }
       client.get(request)
-      expect(client.class).to have_received.get_http(client.base_url + request.url, request.query, client.request_headers)
+      expect(client.class).to have_received.get_http(client.base_url + request.url, request.query, client.request_headers, client.proxy_params)
+    end
+
+    it 'calls #get_http via proxy' do
+      stub(proxy_client.class).get_http { raw_fixture('content_type') }
+      proxy_client.get(request)
+      expect(proxy_client.class).to have_received.get_http(proxy_client.base_url + request.url, request.query, proxy_client.request_headers, proxy_client.proxy_params)
+      expect(proxy_client.proxy_params[:host]).to eq '183.207.232.194'
+      expect(proxy_client.proxy_params[:port]).to eq 8080
     end
 
     describe 'build_resources parameter' do

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: contentful
 version: !ruby/object:Gem::Version
-  version: 0.3.5
+  version: 0.4.0
 platform: ruby
 authors:
 - Contentful GmbH (Jan Lelis)
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-10-07 00:00:00.000000000 Z
+date: 2014-10-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: http