maxcdn 0.1.0

data/.gitignore

@@ -0,0 +1,19 @@
+# rcov generated
+coverage
+
+# rdoc generated
+rdoc
+
+# yard generated
+doc
+.yardoc
+
+# bundler
+.bundle
+vendor
+
+# jeweler generated
+pkg
+*.gem
+*.lock
+.DS_Store

data/.travis.yml

@@ -0,0 +1,8 @@
+language: ruby
+script: bundle exec ruby ./test/test.rb
+rvm:
+  - 1.9.2
+  - 1.9.3
+  - 2.0.0
+  - 2.1.0
+

data/Gemfile

@@ -0,0 +1,11 @@
+source "http://rubygems.org"
+
+gem "signet"
+gem "curb-fu"
+gemspec
+
+group :development, :test do
+  gem "minitest"
+  gem "minitest-reporters"
+end
+

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2012 David Litvak Bruno
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,81 @@
+# MaxCDN is Hiring!
+
+Do you like building cool stuff?  Do APIs keep you up at night? We're looking for our next superstar hacker and you could be it. Interested? Check out our job posting on [stackoverflow](http://careers.stackoverflow.com/jobs/37078/senior-web-engineer-for-fun-growing-la-startup-maxcdn&a=JdFbT4OY).
+
+# MaxCDN REST Web Services Ruby Client
+
+## Installation
+
+``` bash
+gem install maxcdn
+```
+
+#### With Bundler
+
+```
+bundle init
+echo "gem 'maxcdn'" >> Gemfile
+bundle install --path vendor/bundle
+```
+
+## Usage
+```ruby
+require 'maxcdn'
+
+api = MaxCDN::Client.new("myalias", "consumer_key", "consumer_secret")
+
+api.get("/account.json")
+```
+
+## Methods
+It has support for `GET`, `POST`, `PUT` and `DELETE` OAuth 1.0a signed requests.
+
+```ruby
+# To create a new Pull Zone
+api.post("/zones/pull.json", {'name' => 'test_zone', 'url' => 'http://my-test-site.com'})
+
+# To update an existing zone
+api.put("/zones/pull.json/1234", {'name' => 'i_didnt_like_test'})
+
+# To delete a zone
+api.delete("/zones/pull.json/1234")
+
+# To purge a file (robots.txt) from cache
+api.delete("/zones/pull.json/1234/cache", {"file" => "/robots.txt"})
+```
+
+### We now have a shortcut for Purge Calls!
+```ruby
+zone_id = 12345
+
+# Purge Zone
+api.purge(zone_id)
+
+# Purge File
+api.purge(zone_id, '/some_file')
+
+# Purge Files
+api.purge(zone_id, ['/some_file', '/another_file'])
+```
+
+
+## Development Quick Start
+
+``` bash
+# get it
+git clone git@github.com:<fork repo>/ruby-maxcdn.git
+
+# setup
+cd ruby-maxcdn
+bundle install --path vendor/bundle
+
+# unit tests
+bundle exec ruby ./test/test.rb
+
+# integration tests
+export ALIAS=<your alias>
+export KEY=<your key>
+export SECRET=<your secret>
+bundle exec ruby ./test/integration.rb # requires host's IP be whitelisted
+```
+

data/Rakefile

@@ -0,0 +1,2 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"

data/VERSION

@@ -0,0 +1 @@
+0.0.1

data/examples/cache.rb

@@ -0,0 +1,44 @@
+#!/usr/bin/env ruby
+require "pp"
+require File.join("./", File.dirname(__FILE__), "..","lib","maxcdn")
+
+zoneid = ARGV.shift
+files  = ARGV.clone
+
+if ENV["ALIAS"].nil? or ENV["KEY"].nil? or ENV["SECRET"].nil?
+  puts <<-EOU
+Usage: cache.rb zoneid [files...]
+
+  Add credentials to your environment like so:
+
+  $ export ALIAS=<alias>
+  $ export KEY=<key>
+  $ export SECRET=<secret>
+  $ bundle exec ruby cache.rb 12345 ./master.css ./another.css
+
+  Or by adding to the script call:
+
+  $ ALIAS=<alias> KEY=<key> SECRET=<secret> bundle exec ruby cache.rb \
+        12345 ./master.css ./another.css
+EOU
+end
+
+maxcdn = MaxCDN::Client.new(ENV["ALIAS"], ENV["KEY"], ENV["SECRET"])
+
+if zoneid.nil?
+
+  maxcdn.get("/zones/pull.json")["data"]["pullzones"].map { |z| z["id"] }.each do |zid|
+    puts "Purging zone #{zid}"
+    pp maxcdn.purge(zid)
+  end
+
+else
+
+  puts "Purging zone #{zoneid}"
+  if files.empty?
+    pp maxcdn.purge(zoneid)
+  else
+    pp maxcdn.purge(zoneid, files)
+  end
+
+end

data/examples/report.rb

@@ -0,0 +1,50 @@
+#!/usr/bin/env ruby
+require "pp"
+require File.join("./", File.dirname(__FILE__), "..","lib","maxcdn")
+
+arg = ARGV.shift
+
+if ENV["ALIAS"].nil? or ENV["KEY"].nil? or ENV["SECRET"].nil? or (!arg.nil? and !arg.match(/hourly|daily|monthly/))
+  puts <<-EOU
+Usage: report.rb [hourly|daily|monthly]
+
+  Report types only cover summary.
+
+  Add credentials to your environment like so:
+
+  $ export ALIAS=<alias>
+  $ export KEY=<key>
+  $ export SECRET=<secret>
+  $ ./report.rb
+
+  Or by adding to the script call:
+
+  $ ALIAS=<alias> KEY=<key> SECRET=<secret> ./report.rb
+EOU
+end
+
+maxcdn = MaxCDN::Client.new(ENV["ALIAS"], ENV["KEY"], ENV["SECRET"])
+
+report = arg.nil? ? "" : "/#{arg}"
+
+maxcdn.get("/zones/pull.json")["data"]["pullzones"].each do |zone|
+  # title
+  puts "Zone report for: #{zone["name"]} (#{zone["url"]})"
+
+  # summary
+  maxcdn.get("/reports/#{zone["id"]}/stats.json#{report}")["data"]["summary"].each do |k, v|
+    puts " - #{k}: #{v}"
+  end
+
+  # popularfiles
+  puts " "
+  puts "Popular Files:"
+  maxcdn.get("/reports/#{zone["id"]}/popularfiles.json?page_size=10")["data"]["popularfiles"].each do |file|
+    puts " - url: #{file["uri"]}"
+    puts "   - hits: #{file["hit"]}"
+    puts "   - size: #{file["size"]}"
+  end
+
+  puts " "
+end
+

data/examples/simple.rb

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+require 'pp'
+require File.join('./', File.dirname(__FILE__), '..','lib','maxcdn')
+
+maxcdn = MaxCDN::Client.new(ENV['ALIAS'], ENV['KEY'], ENV['SECRET'])
+
+puts 'GET /account.json'
+pp maxcdn.get('/account.json')
+
+puts 'GET /account.json/address'
+pp maxcdn.get('/account.json/address')
+
+puts 'GET /reports/stats.json/hourly'
+pp maxcdn.get('/reports/stats.json/hourly')
+

data/lib/maxcdn.rb

@@ -0,0 +1,122 @@
+require "signet/oauth_1/client"
+require "curb-fu"
+require "json"
+
+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)
+      @company_alias = company_alias
+      @server = server
+      @secure_connection = secure_connection
+      @request_signer = Signet::OAuth1::Client.new(
+        :client_credential_key => key,
+        :client_credential_secret => secret,
+        :two_legged => true
+      )
+    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)}"
+      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
+
+      request_options = {
+        :uri => _get_url(uri, options[:body] ? attributes[0] : {}),
+        :method => method
+      }
+
+      request_options[:body] = _encode_params(attributes[0]) if options[:body]
+      request = @request_signer.generate_authenticated_request(request_options)
+      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
+        end
+
+        return response if options[:debug_request]
+
+        response_json = JSON.load(response.body)
+
+        return response_json if options[:debug_json]
+
+        if not (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"
+        )
+      end
+
+      response_json
+    end
+
+    [ :get, :post, :put, :delete ].each do |meth|
+      define_method(meth) do |uri, data={}, options={}|
+        options[:body] = (meth == :post || meth == :put)
+        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
+        )
+      end
+
+      self.delete("/zones/pull.json/#{zone_id}/cache", {}, options)
+    end
+  end
+end

data/lib/maxcdn/version.rb

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

data/maxcdn.gemspec

@@ -0,0 +1,18 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/maxcdn/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.name = "maxcdn"
+  gem.homepage = "http://www.maxcdn.com"
+  gem.version = MaxCDN::VERSION
+  gem.license = "MIT"
+  gem.files = `git ls-files`.split($\)
+  gem.require_paths = ['lib']
+  gem.summary = %Q{A Rest Client For MaxCDN Rest Web Services}
+  gem.description = %Q{A Rest Client For MaxCDN Rest Web Services}
+  gem.email = "joshua@mervine.net"
+  gem.authors = ["Joshua P. Mervine"]
+  gem.add_dependency 'json' if RUBY_VERSION.start_with? "1.8"
+  gem.add_dependency 'signet'
+  gem.add_dependency 'curb-fu'
+end

data/test/benchmark.rb

@@ -0,0 +1,64 @@
+#!/usr/bin/env ruby
+if (ENV["ALIAS"].nil? or ENV["KEY"].nil? or ENV["SECRET"].nil?)
+  abort "Please export ALIAS, KEY and SECRET with your credentials and ensure that you're test host's IP is whitelisted."
+end
+
+require 'benchmark'
+require "./lib/maxcdn"
+
+@time = Time.now.to_i.to_s
+
+puts "Running benchmarks as follows in order:"
+puts " "
+puts " maxcdn.get('zones/pull.json')"
+puts " maxcdn.get('reports/popularfiles.json')"
+puts " maxcdn.post('zones/pull.json', { :name => 'NAM', :url => 'URL' })"
+puts " maxcdn.put('account.json', { :name => 'NAME' })"
+puts " maxcdn.delete('zones/pull.json/ZONEID')"
+puts " maxcdn.purge('ZONEID')"
+puts " maxcdn.purge('ZONEID', 'FILE')"
+puts " maxcdn.purge('ZONEID', [ 'FILE1','FILE2' ])"
+puts " "
+
+Benchmark.bm do |mark|
+
+  maxcdn = MaxCDN::Client.new(ENV["ALIAS"], ENV["KEY"], ENV["SECRET"])
+  time = Time.now.to_i.to_s
+
+  mark.report("get   :") do
+    @pullzone = maxcdn.get("zones/pull.json")["data"]["pullzones"][0]["id"]
+  end
+
+  mark.report("get   :") do
+    @popularfiles = maxcdn.get("reports/popularfiles.json")["data"]["popularfiles"]
+  end
+
+  @zone = {
+    :name => @time,
+    :url  => "http://www.example.com"
+  }
+
+  mark.report("post  :") do
+    @zoneid = maxcdn.post("zones/pull.json", @zone)["data"]["pullzone"]["id"]
+  end
+
+  mark.report("put   :") do
+    maxcdn.put("account.json", { :name => @time })
+  end
+
+  mark.report("delete:") do
+    maxcdn.delete("zones/pull.json/#{@zoneid}")
+  end
+
+  mark.report("purge :") do
+    maxcdn.purge(@pullzone)
+  end
+
+  mark.report("purge :") do
+    maxcdn.purge(@pullzone, @popularfiles[0]["uri"])
+  end
+
+  mark.report("purge :") do
+    maxcdn.purge(@pullzone, [ @popularfiles[0]["uri"], @popularfiles[1]["uri"] ])
+  end
+end

data/test/integration.rb

@@ -0,0 +1,60 @@
+#!/usr/bin/env ruby
+require "json"
+require "minitest/autorun"
+require "minitest/reporters"
+require "./lib/maxcdn"
+
+Minitest::Reporters.use! Minitest::Reporters::SpecReporter.new
+
+if (ENV["ALIAS"].nil? or ENV["KEY"].nil? or ENV["SECRET"].nil?)
+  abort "Please export ALIAS, KEY and SECRET with your credentials and ensure that you're test host's IP is whitelisted."
+end
+
+class Client < Minitest::Test
+
+  def setup
+    @max  = MaxCDN::Client.new(ENV["ALIAS"], ENV["KEY"], ENV["SECRET"])
+    @time = Time.now.to_i.to_s
+  end
+
+  def test_get
+    [ "account.json",
+      "account.json/address",
+      "users.json",
+      "zones.json"
+    ].each do |end_point|
+      key = end_point.include?("/") ? end_point.split("/")[1] : end_point.gsub(/\.json/, "")
+
+      assert @max.get(end_point)["data"][key], "get #{key} with data"
+    end
+  end
+
+  def test_post_and_delete
+
+    zone = {
+      :name => @time,
+      :url  => "http://www.example.com"
+    }
+
+    zid = @max.post("zones/pull.json", zone)["data"]["pullzone"]["id"]
+    assert zid, "post"
+
+    assert_equal 200, @max.delete("zones/pull.json/#{zid}")["code"], "delete (warning: manually delete zone #{zid} at https://cp.maxcdn.com/zones/pull)."
+  end
+
+  def test_put
+    name = @time + "_put"
+    assert_equal name, @max.put("account.json", { :name => name })["data"]["account"]["name"], "put"
+  end
+
+  def test_purge
+    zone = @max.get("zones/pull.json")["data"]["pullzones"][0]["id"]
+    assert_equal 200, @max.purge(zone)["code"], "purge"
+
+    popularfiles = @max.get("reports/popularfiles.json")["data"]["popularfiles"]
+    assert_equal 200, @max.purge(zone, popularfiles[0]["uri"])["code"], "purge file"
+
+    assert_equal 200, @max.purge(zone, [ popularfiles[0]["uri"], popularfiles[1]["uri"]])["code"], "purge files"
+  end
+end
+

data/test/test.rb

@@ -0,0 +1,130 @@
+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
+

metadata

@@ -0,0 +1,94 @@
+--- !ruby/object:Gem::Specification
+name: maxcdn
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+  prerelease: 
+platform: ruby
+authors:
+- Joshua P. Mervine
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-02-10 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: signet
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: curb-fu
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: A Rest Client For MaxCDN Rest Web Services
+email: joshua@mervine.net
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .travis.yml
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- VERSION
+- examples/cache.rb
+- examples/report.rb
+- examples/simple.rb
+- lib/maxcdn.rb
+- lib/maxcdn/version.rb
+- maxcdn.gemspec
+- test/benchmark.rb
+- test/integration.rb
+- test/test.rb
+homepage: http://www.maxcdn.com
+licenses:
+- MIT
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.23
+signing_key: 
+specification_version: 3
+summary: A Rest Client For MaxCDN Rest Web Services
+test_files: []
+has_rdoc: