maxcdn 0.1.0 → 0.1.1

data/.travis.yml

@@ -1,5 +1,5 @@
 language: ruby
-script: bundle exec ruby ./test/test.rb
+script: bundle exec rake test
 rvm:
   - 1.9.2
   - 1.9.3

data/BENCHMARKS.md

@@ -0,0 +1,20 @@
+Running benchmarks as follows in order:
+ 
+ maxcdn.get('zones/pull.json')
+ maxcdn.get('reports/popularfiles.json')
+ maxcdn.post('zones/pull.json', { :name => 'NAM', :url => 'URL' })
+ maxcdn.put('account.json', { :name => 'NAME' })
+ maxcdn.delete('zones/pull.json/ZONEID')
+ maxcdn.purge('ZONEID')
+ maxcdn.purge('ZONEID', 'FILE')
+ maxcdn.purge('ZONEID', [ 'FILE1','FILE2' ])
+ 
+       user     system      total        real
+get   :  0.050000   0.070000   0.120000 (  1.004877)
+get   :  0.020000   0.000000   0.020000 (  0.534179)
+post  :  0.020000   0.000000   0.020000 ( 18.060298)
+put   :  0.030000   0.010000   0.040000 (  0.981422)
+delete:  0.020000   0.000000   0.020000 ( 11.770821)
+purge :  0.020000   0.000000   0.020000 ( 13.584882)
+purge :  0.020000   0.000000   0.020000 ( 17.310386)
+purge :  0.030000   0.010000   0.040000 ( 16.446759)

data/Gemfile

@@ -5,7 +5,10 @@ gem "curb-fu"
 gemspec
 
 group :development, :test do
+  gem "rake"
+  gem "pry"
   gem "minitest"
   gem "minitest-reporters"
+  gem "webmock"
 end
 

data/README.md

@@ -4,6 +4,8 @@ Do you like building cool stuff?  Do APIs keep you up at night? We're looking fo
 
 # MaxCDN REST Web Services Ruby Client
 
+[![Build Status](https://travis-ci.org/MaxCDN/ruby-maxcdn.png?branch=master)](https://travis-ci.org/MaxCDN/ruby-maxcdn)   [![Gem Version](https://badge.fury.io/rb/maxcdn.png)](http://badge.fury.io/rb/maxcdn)
+
 ## Installation
 
 ``` bash
@@ -24,6 +26,11 @@ require 'maxcdn'
 
 api = MaxCDN::Client.new("myalias", "consumer_key", "consumer_secret")
 
+####
+# Turn on debugging for underlying Curl::Easy and CurbFu modules
+#
+# api.debug = true
+
 api.get("/account.json")
 ```
 
@@ -58,6 +65,14 @@ api.purge(zone_id, '/some_file')
 api.purge(zone_id, ['/some_file', '/another_file'])
 ```
 
+#### Example: SSL Upload
+
+```
+max = MaxCDN::Client.new(alias, key, secret)
+max.post("zones/pull/12345/ssl.json", {
+  :ssl_crt => File.read("/path/to/server.crt").strip,
+  :ssl_key  => File.read("/path/to/server.key").strip })
+```
 
 ## Development Quick Start
 
@@ -79,3 +94,17 @@ export SECRET=<your secret>
 bundle exec ruby ./test/integration.rb # requires host's IP be whitelisted
 ```
 
+# Change Log
+
+##### 0.1.1
+
+* Fixing POST, DELETE and PUT to send data via request body.
+* Adding debugging for CurbFu and Curl::Easy.
+* Fixing/enhancing unit tests.
+* Removing `secure_connection` handling, as all connections should be secure.
+* Fixing [414 Request-URI Too Large](https://github.com/netdna/netdnarws-ruby/issues/10) from old [netdnarws-ruby](https://github.com/netdna/netdnarws-ruby) client.
+
+
+##### 0.1.0
+
+* Initial Release

data/Rakefile

@@ -1,2 +1,21 @@
 #!/usr/bin/env rake
 require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.test_files = FileList['test/*_test.rb']
+  t.verbose = true
+end
+
+Rake::TestTask.new(:integration) do |t|
+  t.libs << "test"
+  t.test_files = FileList['test/integration.rb']
+  t.verbose = true
+end
+
+desc "Run benchmarks"
+task :benchmark do
+  require "./test/benchmark"
+end
+

data/lib/ext/hash.rb

@@ -0,0 +1,47 @@
+class Hash
+  RESERVED_CHARACTERS = /[^a-zA-Z0-9\-\.\_\~]/
+
+  def _escape(value)
+    URI::escape(value.to_s, RESERVED_CHARACTERS)
+  rescue ArgumentError
+    URI::escape(value.to_s.force_encoding(Encoding::UTF_8), RESERVED_CHARACTERS)
+  end
+
+  def to_params
+    params = ''
+    stack = []
+
+    each do |k, v|
+      if v.is_a?(Hash)
+        stack << [k,v]
+      elsif v.is_a?(Array)
+        stack << [k,Hash.from_array(v)]
+      else
+        params << "#{_escape(k)}=#{_escape(v)}&"
+      end
+    end
+
+    stack.each do |parent, hash|
+      parent = _escape(parent) if parent.is_a? String
+      hash.each do |k, v|
+        if v.is_a?(Hash)
+          stack << ["#{parent}[#{k}]", v]
+        else
+          params << "#{parent}[#{k}]=#{_escape(v)}&"
+        end
+      end
+    end
+
+    params.chop!
+    params
+  end
+
+  def self.from_array(array = [])
+    h = Hash.new
+    array.size.times do |t|
+      h[t] = array[t]
+    end
+    h
+  end
+end
+

data/lib/maxcdn.rb

@@ -1,33 +1,19 @@
 require "signet/oauth_1/client"
 require "curb-fu"
 require "json"
+require "./lib/ext/hash"
+require "pp" # for debug
 
 module MaxCDN
-  module Utils
-    RESERVED_CHARACTERS = /[^a-zA-Z0-9\-\.\_\~]/
-
-    def escape(value)
-      URI::escape(value.to_s, MaxCDN::Utils::RESERVED_CHARACTERS)
-    rescue ArgumentError
-      URI::escape(value.to_s.force_encoding(Encoding::UTF_8), MaxCDN::Utils::RESERVED_CHARACTERS)
-    end
-
-    def encode_params params={}
-      Hash[params.map { |k, v| [escape(k), escape(v)] }]
-    end
-  end
-
   class APIException < Exception
   end
 
   class Client
-    include MaxCDN::Utils
-
-    attr_accessor :client
-    def initialize(company_alias, key, secret, server="rws.maxcdn.com", secure_connection=true)
+    attr_accessor :client, :debug
+    def initialize(company_alias, key, secret, server="rws.maxcdn.com", _debug=false)
+      @debug = _debug
       @company_alias = company_alias
       @server = server
-      @secure_connection = secure_connection
       @request_signer = Signet::OAuth1::Client.new(
         :client_credential_key => key,
         :client_credential_secret => secret,
@@ -36,84 +22,75 @@ module MaxCDN
     end
 
     def _connection_type
-      return "http" unless @secure_connection
       "https"
     end
 
-    def _encode_params params={}
-      encode_params(params).map { |k, v|
-        "#{k}=#{v}"
-      }.join "&"
-    end
-
     def _get_url uri, params={}
-
       url = "#{_connection_type}://#{@server}/#{@company_alias}/#{uri.gsub(/^\//, "")}"
-      if not params.empty?
-        url += "?#{_encode_params(params)}"
+      if params and not params.empty?
+        url += "?#{params.to_params}"
       end
 
       url
     end
 
-    def _response_as_json method, uri, options={}, *attributes
-      if options.delete(:debug)
-        puts "Making #{method.upcase} request to #{_get_url uri}"
-      end
+    def _response_as_json method, uri, options={}, data={}
+      puts "Making #{method.upcase} request to #{_get_url uri}" if debug
 
-      request_options = {
-        :uri => _get_url(uri, options[:body] ? attributes[0] : {}),
+      req_opts = {
         :method => method
       }
 
-      request_options[:body] = _encode_params(attributes[0]) if options[:body]
-      request = @request_signer.generate_authenticated_request(request_options)
+      req_opts[:uri]  = _get_url(uri, (options[:body] ? {} : data))
+      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"
 
       begin
-        curb_options = {}
-        curb_options[:url] = request_options[:uri]
-        curb_options[:headers] = request.headers
-
-        if not options[:body]
-          response = CurbFu.send method, curb_options
-        else
-          response = CurbFu.send method, curb_options, request.body
+        curb_opts = {
+          :url => req_opts[:uri],
+          :headers => request.headers
+        }
+
+        CurbFu.debug = debug
+
+        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
         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
 
-        if not (response.success? or response.redirect?)
+        unless response.success? or response.redirect?
           error_message = response_json["error"]["message"]
           raise MaxCDN::APIException.new("#{response.status}: #{error_message}")
         end
       rescue TypeError
-        raise MaxCDN::APIException.new(
-          "#{response.status}: No information supplied by the server"
-        )
+        raise MaxCDN::APIException.new("#{response.status}: No information supplied by the server")
       end
 
       response_json
     end
 
-    [ :get, :post, :put, :delete ].each do |meth|
+    [ :post, :get, :put, :delete ].each do |meth|
       define_method(meth) do |uri, data={}, options={}|
-        options[:body] = (meth == :post || meth == :put)
+        options[:body] ||= true if meth != :get
         self._response_as_json meth.to_s, uri, options, data
       end
     end
 
     def purge zone_id, file_or_files=nil, options={}
       unless file_or_files.nil?
-        return self.delete(
-          "/zones/pull.json/#{zone_id}/cache",
-          {"file" => file_or_files},
-            options
-        )
+        return self.delete("/zones/pull.json/#{zone_id}/cache",
+                 { "files" => file_or_files }, options)
       end
 
       self.delete("/zones/pull.json/#{zone_id}/cache", {}, options)

data/lib/maxcdn/version.rb

@@ -1,3 +1,3 @@
 module MaxCDN
-  VERSION = "0.1.0"
+  VERSION = "0.1.1"
 end

data/test/ext_hash_test.rb

@@ -0,0 +1,32 @@
+#!/usr/bin/env ruby
+require "minitest/autorun"
+require "minitest/reporters"
+
+require "./lib/ext/hash"
+
+class Client < Minitest::Test
+  def test_to_params_basic
+    assert_equal "foo=bar", { "foo" => "bar" }.to_params
+    assert_equal "foo=bar&bar=foo", { :foo => "bar", :bar => "foo" }.to_params
+  end
+
+  def test_to_params_escape
+    assert_equal "foo%20bar=bar%20boo", { "foo bar" => "bar boo" }.to_params
+  end
+
+  def test_to_params_array
+    assert_equal "foo[0]=bar&foo[1]=boo", { "foo" => [ "bar", "boo" ] }.to_params
+    assert_equal "foo[0]=bar&foo[1]=boo", { :foo => [ :bar, :boo ] }.to_params
+  end
+
+  def test_to_params_crazy
+    assert_equal "a=1&c=%40%24%5E%24%23%25%26%23%26&%3F%21=asdf&1=FDAS&b[0]=a&b[1]=b&b[2]=c", {
+        :a => 1,
+        :b => [ :a, :b, :c ],
+        :c => "@$^$#%&#&",
+        "?!" => "asdf",
+        1 => "FDAS"
+      }.to_params
+  end
+
+end

data/test/integration.rb

@@ -14,6 +14,8 @@ class Client < Minitest::Test
 
   def setup
     @max  = MaxCDN::Client.new(ENV["ALIAS"], ENV["KEY"], ENV["SECRET"])
+    @max.debug = true if ENV['DEBUG']
+
     @time = Time.now.to_i.to_s
   end
 
@@ -37,7 +39,7 @@ class Client < Minitest::Test
     }
 
     zid = @max.post("zones/pull.json", zone)["data"]["pullzone"]["id"]
-    assert zid, "post"
+    assert zid, "post id"
 
     assert_equal 200, @max.delete("zones/pull.json/#{zid}")["code"], "delete (warning: manually delete zone #{zid} at https://cp.maxcdn.com/zones/pull)."
   end

data/test/maxcdn_test.rb

@@ -0,0 +1,121 @@
+#!/usr/bin/env ruby
+require "minitest/autorun"
+require "minitest/reporters"
+
+require "./lib/maxcdn"
+
+Minitest::Reporters.use! Minitest::Reporters::SpecReporter.new
+
+require "webmock"
+include WebMock::API
+
+host = "https://rws.maxcdn.com/alias"
+
+headers = {
+  'Authorization' => /.+/,
+  'Cache-Control' => /.+/,
+  'Content-Type'  => /application.+/,
+  'Expect'        => /.*/,
+  'User-Agent'    => "Ruby MaxCDN API Client"
+}
+
+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)
+  .to_return(:body => '{"foo": "bar"}')
+
+stub_request(:put, host+"/account.json")
+  .with(:body => "foo=bar", :headers => headers)
+  .to_return(:body => '{"foo":"bar"}')
+
+stub_request(:delete, host+"/zones/pull.json/12345/cache")
+  .with(:body => "files=foo.txt", :headers => 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)
+  .to_return(:body => '{"foo":"bar"}')
+
+# stubs below this don't send content-type header
+headers.delete('Content-Type')
+
+stub_request(:get, host+"/account.json")
+  .with(:headers => headers)
+  .to_return(:body => '{"foo":"bar"}')
+
+stub_request(:delete, host+"/zones/pull.json/12345/cache")
+  .with(:headers => headers)
+  .to_return(:body => '{"foo":"bar"}')
+
+class Client < Minitest::Test
+
+  def setup
+    @max = MaxCDN::Client.new("alias", "key", "secret")
+    @max.debug = true if ENV['DEBUG']
+  end
+
+  def test_initialize
+    assert_equal "alias", @max.instance_variable_get(:@company_alias)
+  end
+
+  def test__connection_type
+    assert_equal "https", @max._connection_type
+  end
+
+  def test__get_url
+    assert_equal "https://rws.maxcdn.com/alias/foo",
+      @max._get_url("/foo")
+    assert_equal "https://rws.maxcdn.com/alias/foo?foo=foo%20bar",
+      @max._get_url("/foo", { :foo => "foo bar" })
+  end
+
+  def test__response_as_json_standard
+    res = @max._response_as_json("get", "account.json")
+    assert_equal({ "foo" => "bar" }, res)
+
+    res = @max._response_as_json("post", "zones/pull.json?foo=bar")
+    assert_equal({ "foo" => "bar" }, res)
+  end
+
+  def test__response_as_json_body
+    res = @max._response_as_json("post", "zones/pull.json", { :body => true }, { "foo"=> "bar", "bar" => "foo" })
+    assert_equal({ "foo" => "bar" }, res)
+  end
+
+  def test_get
+    assert_equal({ "foo" => "bar" }, @max.get("account.json"))
+  end
+
+  def test_post
+      assert_equal({ "foo" => "bar" }, @max.post("zones/pull.json", {"foo" => "bar", "bar" => "foo"}))
+      assert_equal({ "foo" => "bar" }, @max.post("zones/pull.json?foo=bar"))
+  end
+
+  def test_put
+    assert_equal({ "foo" => "bar" }, @max.put("account.json", {"foo"=>"bar"}))
+  end
+
+  def test_delete_cache
+    assert_equal({ "foo" => "bar" }, @max.delete("zones/pull.json/12345/cache"))
+  end
+
+  def test_delete_cache_w_files
+    assert_equal({ "foo" => "bar" }, @max.delete("zones/pull.json/12345/cache", { :files => "foo.txt" }))
+  end
+
+  def test_purge
+    assert_equal({ "foo" => "bar" }, @max.purge(12345))
+  end
+
+  def test_purge_file
+    assert_equal({ "foo" => "bar" }, @max.purge(12345, "foo.txt"))
+  end
+
+  def test_purge_files
+    assert_equal({ "foo" => "bar" }, @max.purge(12345, [ "foo.txt", "bar.txt" ]))
+  end
+end
+

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: maxcdn
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-02-10 00:00:00.000000000 Z
+date: 2014-02-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: signet
@@ -51,6 +51,7 @@ extra_rdoc_files: []
 files:
 - .gitignore
 - .travis.yml
+- BENCHMARKS.md
 - Gemfile
 - LICENSE
 - README.md
@@ -59,12 +60,14 @@ files:
 - examples/cache.rb
 - examples/report.rb
 - examples/simple.rb
+- lib/ext/hash.rb
 - lib/maxcdn.rb
 - lib/maxcdn/version.rb
 - maxcdn.gemspec
 - test/benchmark.rb
+- test/ext_hash_test.rb
 - test/integration.rb
-- test/test.rb
+- test/maxcdn_test.rb
 homepage: http://www.maxcdn.com
 licenses:
 - MIT
@@ -78,12 +81,18 @@ required_ruby_version: !ruby/object:Gem::Requirement
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
+      segments:
+      - 0
+      hash: -4596852110847613603
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
+      segments:
+      - 0
+      hash: -4596852110847613603
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.23
@@ -91,4 +100,3 @@ signing_key:
 specification_version: 3
 summary: A Rest Client For MaxCDN Rest Web Services
 test_files: []
-has_rdoc: 

data/test/test.rb

@@ -1,130 +0,0 @@
-require "curb-fu"
-
-require "minitest/autorun"
-require "minitest/mock"
-require "minitest/reporters"
-
-#require "signet/oauth_1/client"
-require "./lib/maxcdn"
-
-Minitest::Reporters.use! Minitest::Reporters::SpecReporter.new
-
-class Client < Minitest::Test
-
-  def new_response
-    response = Minitest::Mock.new
-    response.expect(:body, '{ "foo": "bar" }')
-    response.expect(:success?, true)
-    response
-  end
-
-  def setup
-    @max = MaxCDN::Client.new("alias", "key", "secret")
-  end
-
-  def test_initialize
-    assert_equal "alias", @max.instance_variable_get(:@company_alias)
-  end
-
-  def test__connection_type
-    assert_equal "https", @max._connection_type
-
-    m = MaxCDN::Client.new("alias", "key", "secret", "foo", false)
-    assert_equal "http", m._connection_type
-  end
-
-  def test__encode_params
-    assert_equal "foo=foo%20bar&bah=boo",
-      @max._encode_params({ :foo => "foo bar", :bah => "boo" })
-  end
-
-  def test__get_url
-    assert_equal "https://rws.maxcdn.com/alias/foo",
-      @max._get_url("/foo")
-    assert_equal "https://rws.maxcdn.com/alias/foo?foo=foo%20bar",
-      @max._get_url("/foo", { :foo => "foo bar" })
-  end
-
-  def test__response_as_json_standard
-    response = new_response
-    CurbFu::Request.stub :get, response do
-      res = @max._response_as_json("get", "http://example.com")
-      assert res
-      assert response.verify
-    end
-  end
-
-  def test__response_as_json_standard
-    response = new_response
-    CurbFu::Request.stub :get, response do
-      res = @max._response_as_json("get", "http://example.com",
-                                   { :debug_request => true })
-      assert res.body
-    end
-  end
-
-  def test_get
-    response = new_response
-    CurbFu::Request.stub :get, response do
-      assert_equal({ "foo" => "bar" }, @max.get("/account.json"))
-    end
-    assert response.verify
-  end
-
-  def test_post
-    response = new_response
-    CurbFu::Request.stub :post, response do
-      assert_equal({ "foo" => "bar" }, @max.post("/zones/pull.json", {'name' => 'test_zone', 'url' => 'http://my-test-site.com'}))
-    end
-    assert response.verify
-  end
-
-  def test_put
-    response = new_response
-    CurbFu::Request.stub :put, response do
-      assert_equal({ "foo" => "bar" }, @max.put("/zones/pull.json/1234", {'name' => 'i_didnt_like_test'}))
-    end
-    assert response.verify
-  end
-
-  def test_delete
-    response = new_response
-    CurbFu::Request.stub :delete, response do
-      assert_equal({ "foo" => "bar" }, @max.delete("/zones/pull.json/1234"))
-    end
-    assert response.verify
-  end
-
-  def test_delete_file
-    response = new_response
-    CurbFu::Request.stub :delete, response do
-      assert_equal({ "foo" => "bar" }, @max.delete("/zones/pull.json/1234/cache", {"file" => "/robots.txt"}))
-    end
-    assert response.verify
-  end
-
-  def test_purge
-    response = new_response
-    CurbFu::Request.stub :delete, response do
-      assert_equal({ "foo" => "bar" }, @max.purge(12345))
-    end
-    assert response.verify
-  end
-
-  def test_purge_file
-    response = new_response
-    CurbFu::Request.stub :delete, response do
-      assert_equal({ "foo" => "bar" }, @max.purge(12345, "/foo.txt"))
-    end
-    assert response.verify
-  end
-
-  def test_purge_files
-    response = new_response
-    CurbFu::Request.stub :delete, response do
-      assert_equal({ "foo" => "bar" }, @max.purge(12345, [ "/foo.txt", "/bar.txt" ]))
-    end
-    assert response.verify
-  end
-end
-