maxcdn 0.1.2 → 0.1.3

data/README.md

@@ -96,6 +96,14 @@ bundle exec ruby ./test/integration.rb # requires host's IP be whitelisted
 
 # Change Log
 
+##### 0.1.3
+
+* Requested changes for debugging and development support. (See issue #2).
+
+##### 0.1.2
+
+* Fixing an issue with lib loading in `0.1.1`.
+
 ##### 0.1.1
 
 * Fixing POST, DELETE and PUT to send data via request body.

data/lib/ext/hash.rb

@@ -36,6 +36,27 @@ class Hash
     params
   end
 
+  def case_indifferent_delete key
+    existing_keys = self.keys.map { |k| k.downcase }
+    index = existing_keys.index(key.downcase)
+    unless index.nil?
+      self.delete(self.keys[index])
+    end
+  end
+
+  def case_indifferent_merge incoming_hash
+    existing_keys = self.keys.map { |k| k.downcase }
+
+    incoming_hash.each do |key, value|
+      index = existing_keys.index(key.downcase)
+      if index.nil?
+        self[key] = value
+      else
+        self[self.keys[index]] = value
+      end
+    end
+  end
+
   def self.from_array(array = [])
     h = Hash.new
     array.size.times do |t|

data/lib/maxcdn.rb

@@ -10,8 +10,9 @@ module MaxCDN
 
   class Client
     attr_accessor :client, :debug
-    def initialize(company_alias, key, secret, server="rws.maxcdn.com", _debug=false)
+    def initialize(company_alias, key, secret, server="rws.maxcdn.com", secure_connection=true, _debug=false)
       @debug = _debug
+      @secure_connection = secure_connection
       @company_alias = company_alias
       @server = server
       @request_signer = Signet::OAuth1::Client.new(
@@ -22,6 +23,7 @@ module MaxCDN
     end
 
     def _connection_type
+      return "http" unless @secure_connection
       "https"
     end
 
@@ -45,7 +47,17 @@ module MaxCDN
       req_opts[:body] = data.to_params if options[:body]
 
       request = @request_signer.generate_authenticated_request(req_opts)
-      request.headers["User-Agent"] = "Ruby MaxCDN API Client"
+
+      # crazyness for headers
+      headers = options.delete(:headers) || {}
+      headers["User-Agent"] = "Ruby MaxCDN API Client"
+
+      # because CurbFu overwrites 'content-type' header, strip it
+      # to set it later
+      content_type = headers.case_indifferent_delete("Content-Type") || (options[:body] ? "application/json" : "application/x-www-form-urlencoded")
+
+      # merge headers with request headers
+      request.headers.case_indifferent_merge(headers)
 
       begin
         curb_opts = {
@@ -58,15 +70,22 @@ module MaxCDN
         response = CurbFu.send method, curb_opts, request.body do |curb|
           curb.verbose = debug
 
-          # Because CurbFu overwrite the content-type header passed
-          # to it
-          curb.headers["Content-Type"] = "application/json" if request.body
+          # Because CurbFu overwrites the content-type header passed
+          # to it. so we'll be setting our own.
+          #
+          # First, remove any existing 'Content-Type' header.
+          curb.headers.case_indifferent_delete("Content-Type")
+
+          # Second, set 'Content-Type' to our desired value.
+          curb.headers["Content-Type"] = content_type
         end
 
+        return response if options[:debug_request]
         pp response if debug
 
         response_json = JSON.load(response.body)
 
+        return response_json if options[:debug_json]
         pp response_json if debug
 
         unless response.success? or response.redirect?
@@ -80,10 +99,10 @@ module MaxCDN
       response_json
     end
 
-    [ :post, :get, :put, :delete ].each do |meth|
-      define_method(meth) do |uri, data={}, options={}|
-        options[:body] ||= true if meth != :get
-        self._response_as_json meth.to_s, uri, options, data
+    [ :post, :get, :put, :delete ].each do |method|
+      define_method(method) do |uri, data={}, options={}|
+        options[:body] ||= true if method != :get
+        self._response_as_json method.to_s, uri, options, data
       end
     end
 

data/lib/maxcdn/version.rb

@@ -1,3 +1,3 @@
 module MaxCDN
-  VERSION = "0.1.2"
+  VERSION = "0.1.3"
 end

data/test/ext_hash_test.rb

@@ -29,4 +29,45 @@ class Client < Minitest::Test
       }.to_params
   end
 
+  def test_case_indifferent_delete
+    original_hash = {
+      # using realistic content types to test real use cases
+      "content-type"       => "1",
+      "X-Forwarded-For"    => "2",
+      "CACHE-CONTROL"      => "3"
+    }
+
+    assert_equal "1", original_hash.case_indifferent_delete("CONTENT-TYPE"), "delete 'CONTENT-TYPE'"
+    refute original_hash.has_key?("content-type"), "deleted 'content-type'"
+
+    assert_equal "3", original_hash.case_indifferent_delete("cache-control"), "delete 'cache-control'"
+    refute original_hash.has_key?("CACHE-CONTROL"), "delete 'CACHE-CONTROL'"
+  end
+
+  def test_case_indifferent_merge
+    original_hash = {
+      # using realistic content types to test real use cases
+      "content-type"       => "1",
+      "X-Forwarded-For"    => "2",
+      "CACHE-CONTROL"      => "3",
+      "unchanged-original" => "4"
+    }
+
+    new_hash = {
+      # using realistic content types to test real use cases
+      "Content-Type"      => "5",
+      "X-FORWARDED-FOR"   => "6",
+      "cache-control"     => "7",
+      "new-header"        => "8"
+    }
+
+    assert original_hash.case_indifferent_merge(new_hash)
+
+    assert_equal "4", original_hash["unchanged-original"] ,"unchanged-original"
+    assert_equal "5", original_hash["content-type"]       ,"content-type"
+    assert_equal "6", original_hash["X-Forwarded-For"]    ,"X-Forwarded-For"
+    assert_equal "7", original_hash["CACHE-CONTROL"]      ,"CACHE-CONTROL"
+    assert_equal "8", original_hash["new-header"]         ,"new-header"
+  end
+
 end

data/test/maxcdn_test.rb

@@ -11,45 +11,51 @@ include WebMock::API
 
 host = "https://rws.maxcdn.com/alias"
 
-headers = {
+expected_headers = {
   'Authorization' => /.+/,
   'Cache-Control' => /.+/,
-  'Content-Type'  => /application.+/,
+  'Content-Type'  => "application/json",
   'Expect'        => /.*/,
   'User-Agent'    => "Ruby MaxCDN API Client"
 }
 
+# requests with :body
 stub_request(:post, host+"/zones/pull.json")
-  .with(:body => 'foo=bar&bar=foo', :headers => headers)
-  .to_return(:body => '{"foo": "bar"}')
-
-stub_request(:post, host+"/zones/pull.json?foo=bar")
-  .with(:headers => headers)
+  .with(:body => "foo=bar&bar=foo", :headers => expected_headers)
   .to_return(:body => '{"foo": "bar"}')
 
 stub_request(:put, host+"/account.json")
-  .with(:body => "foo=bar", :headers => headers)
+  .with(:body => "foo=bar", :headers => expected_headers)
   .to_return(:body => '{"foo":"bar"}')
 
 stub_request(:delete, host+"/zones/pull.json/12345/cache")
-  .with(:body => "files=foo.txt", :headers => headers)
+  .with(:body => "files=foo.txt", :headers => expected_headers)
   .to_return(:body => '{"foo":"bar"}')
 
 stub_request(:delete, host+"/zones/pull.json/12345/cache")
-  .with(:body => "files[0]=foo.txt&files[1]=bar.txt", :headers => headers)
+  .with(:body => "files[0]=foo.txt&files[1]=bar.txt", :headers => expected_headers)
   .to_return(:body => '{"foo":"bar"}')
 
-# stubs below this don't send content-type header
-headers.delete('Content-Type')
+stub_request(:delete, host+"/zones/pull.json/12345/cache")
+  .with(:headers => expected_headers)
+  .to_return(:body => '{"foo":"bar"}')
 
+# requests without :body
+expected_headers['Content-Type'] = "application/x-www-form-urlencoded"
 stub_request(:get, host+"/account.json")
-  .with(:headers => headers)
+  .with(:headers => expected_headers)
   .to_return(:body => '{"foo":"bar"}')
 
-stub_request(:delete, host+"/zones/pull.json/12345/cache")
-  .with(:headers => headers)
+# test custom content-type
+expected_headers['Content-Type'] = "application/custom"
+stub_request(:get, host+"/account.json/address")
+  .with(:headers => expected_headers)
   .to_return(:body => '{"foo":"bar"}')
 
+# ingore headers
+stub_request(:post, host+"/zones/pull.json?foo=bar")
+  .to_return(:body => '{"foo": "bar"}')
+
 class Client < Minitest::Test
 
   def setup
@@ -63,6 +69,9 @@ class Client < Minitest::Test
 
   def test__connection_type
     assert_equal "https", @max._connection_type
+
+    max = MaxCDN::Client.new("alias", "key", "secret", "rws.maxcdn.com", false)
+    assert_equal "http", max._connection_type
   end
 
   def test__get_url
@@ -85,6 +94,20 @@ class Client < Minitest::Test
     assert_equal({ "foo" => "bar" }, res)
   end
 
+  def test__response_as_json_debug_json
+    res = @max._response_as_json("post", "zones/pull.json", { :body => true, :debug_json => true }, { "foo"=> "bar", "bar" => "foo" })
+    assert_equal({ "foo" => "bar" }, res)
+  end
+
+  def test__response_as_json_debug_request
+    res = @max._response_as_json("post", "zones/pull.json", { :body => true, :debug_request => true }, { "foo"=> "bar", "bar" => "foo" })
+    assert_equal(CurbFu::Response::Base, res.class)
+  end
+
+  def test_custom_header
+    assert_equal({ "foo" => "bar" }, @max.get("account.json/address", {}, { :headers => { 'content-type' => 'application/custom' }}))
+  end
+
   def test_get
     assert_equal({ "foo" => "bar" }, @max.get("account.json"))
   end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: maxcdn
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.1.3
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-02-13 00:00:00.000000000 Z
+date: 2014-02-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: signet
@@ -83,7 +83,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -869872735616605413
+      hash: -4324918256587917915
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -92,7 +92,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -869872735616605413
+      hash: -4324918256587917915
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.23