chuckle 1.0.5 → 1.0.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 370d11531835cb5e2c6a06e947f0e7270195c2d2
-  data.tar.gz: 49457ddedf721927e9cdce13c96b6ab311356a60
+  metadata.gz: 5bec6990bc8d2c6749e8f14ecc609ed1fff3356d
+  data.tar.gz: c0ce0de38ab143ba264b935418056ea33f7e2d84
 SHA512:
-  metadata.gz: 9ba2f917cde22f73987f312c98ddc619eade4e2d265cfe10dda2a1a184519d36eafe1b21d7c150cd850108330df2bc7786a7661661d80c905653efba7009c45d
-  data.tar.gz: 40b4f8ad2c3d918fd5fbaee7ec31a494d394dd2c4118ce51e35f787f6dc7d8f822e152b719228ba0e95868dd191fc5cc26a61910ccaa29465914ce65c11fcf01
+  metadata.gz: 2866b58b2815ebe262f41537627db7828ff195f9c49f5a92b3b16efc939685aa7fc07b62380fc212ee7324e4186e10943cda36c7a0daf3cc7fbbcab0e14fdd9a
+  data.tar.gz: fc35467053e1203c3ee31e50e7b134e6a6110297bd919b04e519948332fac57f91ffe5f536b80aa1bb6abddbe81ec2015b248149b1b872b6b8455ce315582a7b

data/README.md

@@ -48,8 +48,10 @@ Pass these `Chuckle::Client.new`:
 * **cacert** (nil) - cacert option to pass to curl
 * **capath** (nil) - capath option to pass to curl
 * **cookies** (false) - true to turn on cookie support
+* **content_type** (application/x-www-form-urlencoded) - default content type for POST
 * **expires_in** (:never) - time in seconds after which cache files should expire, or `:never` to never expire
 * **insecure** (false) - true to allow insecure SSL connections
+* **headers** (nil) - optional hash of headers to include for all requests.  Content-Type is overwritten by the :content_type option.  example: {"Referer" => "http://foo.com"}
 * **nretries** (2) - number of times to retry a failing request
 * **rate_limit** (1) - number of seconds between requests
 * **timeout** (30) - timeout per request. Note that if `nretries` is 2 and `timeout` is 30, a failing request could take 90 seconds to truly fail.
@@ -58,6 +60,8 @@ Pass these `Chuckle::Client.new`:
 
 ## Changelog
 
+* 1.0.6 (May 15, 2015) - added support for setting arbitrary headers (@pattymac)
+* 1.0.5 (Jan 30, 2015) - added support for setting content type (@pattymac)
 * 1.0.4 (Dec 6, 2014) - added support for --cacert, --capath and --insecure (@nkriege)
 
 

data/lib/chuckle/curl.rb

@@ -70,7 +70,15 @@ module Chuckle
 
       if request.body
         command += ["--data-binary", request.body]
-        command += ["--header", "Content-Type: #{client.content_type}"]
+      end
+
+      # maintain backwards compatibility for content type
+      client.headers.each do |key,value|
+        if key == "Content-Type"
+          command += ["--header", "#{key}: #{value}"] if request.body
+        else
+          command += ["--header", "#{key}: #{value}"]
+        end
       end
 
       if client.cookies?

data/lib/chuckle/options.rb

@@ -8,6 +8,7 @@ module Chuckle
       content_type: "application/x-www-form-urlencoded",
       cookies: false,
       expires_in: :never,
+      headers: nil,
       insecure: false,
       nretries: 2,
       rate_limit: 1,
@@ -61,6 +62,15 @@ module Chuckle
       options[:expires_in]
     end
 
+    # maintain backwards compatibility for content_type
+    def headers
+      @headers ||= begin
+        headers = options[:headers] || {}
+        headers["Content-Type"] = options[:content_type] if options[:content_type]
+        headers
+      end
+    end
+
     # allow insecure SSL connections?
     def insecure?
       options[:insecure]

data/lib/chuckle/version.rb

@@ -1,4 +1,4 @@
 module Chuckle
   # Gem version
-  VERSION = "1.0.5"
+  VERSION = "1.0.6"
 end

data/test/test_headers.rb

@@ -0,0 +1,74 @@
+require "helper"
+
+# these actually use the network, and get skipped unless ENV["NETWORK"].
+class TestHeaders < Minitest::Test
+  include Helper
+
+  def test_default_headers
+    test_client = client(verbose: true)
+    assert_equal({"Content-Type"=>"application/x-www-form-urlencoded"}, test_client.headers)
+  end
+
+  def test_content_type
+    test_client = client(content_type: "text/json")
+    assert_equal({"Content-Type"=>"text/json"}, test_client.headers)
+  end
+
+  def test_arbitrary_headers
+    test_client = client(headers: {"Referer" => "http://foo.com"})
+    assert_equal test_client.headers["Referer"], "http://foo.com"
+    assert_equal test_client.headers["Content-Type"], "application/x-www-form-urlencoded"
+
+  end
+
+  def test_basic_get
+    test_client = client(verbose: true)
+    request = test_client.create_request("http://httpbin.org/get")
+    headers = command_headers(request)
+    assert_equal headers, []
+  end
+
+
+  def test_basic_post
+    request = client(verbose: true).create_request("http://httpbin.org/post", "foo")
+    headers = command_headers(request)
+    assert_equal headers, ["Content-Type: application/x-www-form-urlencoded"]
+  end
+
+  def test_get_headers
+    request = client(headers: {"Referer" => "http://foo.com"}).create_request("http://httpbin.org/get")
+    headers = command_headers(request)
+    assert_equal headers, ["Referer: http://foo.com"]
+  end
+
+  def test_post_headers
+    request = client(headers: {"Referer" => "http://foo.com"}).create_request("http://httpbin.org/post", "foo")
+    headers = command_headers(request)
+    assert_equal headers.sort, ["Content-Type: application/x-www-form-urlencoded", "Referer: http://foo.com"]
+  end
+
+  private
+
+  def command(request)
+    curler = CurlStub.new(request)
+    curler.test_command
+  end
+
+  def command_headers(request)
+    headers = []
+    test_command = command(request)
+    test_command.each_with_index do |item, i|
+      if item == "--header"
+        headers << test_command[i+1]
+      end
+    end
+    headers
+  end
+
+  class CurlStub < Chuckle::Curl
+    def test_command
+      command(@request)
+    end
+  end
+
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: chuckle
 version: !ruby/object:Gem::Version
-  version: 1.0.5
+  version: 1.0.6
 platform: ruby
 authors:
 - Adam Doppelt
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-01-30 00:00:00.000000000 Z
+date: 2015-05-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: trollop
@@ -123,6 +123,7 @@ files:
 - lib/chuckle/version.rb
 - test/helper.rb
 - test/test_cache.rb
+- test/test_headers.rb
 - test/test_network.rb
 - test/test_requests.rb
 - test/url_file.txt
@@ -145,13 +146,14 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: chuckle
-rubygems_version: 2.4.1
+rubygems_version: 2.4.5
 signing_key: 
 specification_version: 4
 summary: Chuckle - an http client that caches on disk.
 test_files:
 - test/helper.rb
 - test/test_cache.rb
+- test/test_headers.rb
 - test/test_network.rb
 - test/test_requests.rb
 - test/url_file.txt