keycdn 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 72aba56da0aa2dc7d2c0a6d32b53c9426f9bf3c6
+  data.tar.gz: 1916a8382c19fcd77a1a18b6123feda4ce7ade83
+SHA512:
+  metadata.gz: a7af8dfdc66184ecda1aaac07769753693de24bb1556daae66b40ea86c0cd029c87075f9218a7736feb725e8da5bd7dfcf60390dfbcc3cc8ae6a0f19c0e068f0
+  data.tar.gz: e7feae3ab6cd50afea1f160870220fc347f5251fe77dc7af86ae07056e87f3bd6265657c1c70df2cb38b89f94d2856c44b37fe7bee8cb534b9fa67b620d47b5d

data/.gitignore

@@ -0,0 +1,9 @@
+# bundler
+.bundle
+vendor
+
+pkg
+*.gem
+*.lock
+.DS_Store
+npm-debug.log

data/Gemfile

@@ -0,0 +1,3 @@
+source "http://rubygems.org"
+
+gemspec

data/LICENSE

@@ -0,0 +1,20 @@
+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,98 @@
+# Ruby gem for the KeyCDN API
+
+
+## Installation
+
+``` bash
+gem install keycdn
+```
+
+> Requires Ruby 1.9.2+
+
+#### With Bundler
+
+```
+bundle init
+echo "gem 'keycdn'" >> Gemfile
+bundle install --path vendor/bundle
+```
+
+## Usage
+
+### Initial
+```ruby
+require 'keycdn'
+
+# $ export APIKEY=<your_api_key>
+keycdn = KeyCDN::Client.new(ENV["APIKEY"])
+```
+
+### Get all zones
+```ruby
+keycdn.get("zones.json")
+```
+
+### Get a specific zone
+```ruby
+keycdn.get("zones/<zoneId>.json")
+```
+
+### Generate reports
+```ruby
+time = Time.now.to_i
+
+report = {
+  :start => time-3600,
+  :end  => time
+}
+
+keycdn.get("reports/traffic.json", report)
+keycdn.get("reports/storage.json", report)
+keycdn.get("reports/credits.json", report)
+```
+
+### Add a new zone
+```ruby
+zone = {
+  :name => @time.to_s,
+  :expire  => 1234
+}
+
+keycdn.post("zones.json", zone)
+```
+
+### Edit a zone
+```ruby
+zone_id = '<zoneId>'
+
+zone = {
+  :name => '<name>',
+  :expire  => 4321
+}
+
+keycdn.put("zones/#{zone_id}.json", zone)
+```
+
+### Purge zone cache
+```ruby
+# purge zone cache
+zone_id = '<zoneId>'
+
+keycdn.get("zones/purge/#{zone_id}.json")
+```
+
+### Purge URLs
+```ruby
+zone_id = '<zoneId>'
+
+urls = {
+        'urls[0]' => 'demo-1.kxcdn.com/lorem.css',
+        'urls[1]' => 'demo-1.kxcdn.com/lorem.jpg'
+};
+
+keycdn.del("zones/purgeurl/#{zone_id}.json", urls)
+
+```
+
+
+For more details visit https://www.keycdn.com

data/Rakefile

@@ -0,0 +1,9 @@
+#!/usr/bin/env rake
+require 'rake/testtask'
+
+Rake::TestTask.new do |t|
+  t.libs << 'test'
+end
+
+desc "Run tests"
+task :default => :test

data/examples/purge.rb

@@ -0,0 +1,17 @@
+#!/usr/bin/env ruby
+require File.join("./", File.dirname(__FILE__), "..","lib","keycdn")
+
+if ENV["APIKEY"].nil?
+  puts '$ export APIKEY=<your_api_key>'
+end
+
+keycdn = KeyCDN::Client.new(ENV["APIKEY"])
+
+zone_id = '<zoneId>';
+
+urls = {
+        'urls[0]' => 'demo-1.kxcdn.com/lorem.css',
+        'urls[1]' => 'demo-1.kxcdn.com/lorem.jpg'
+};
+
+puts keycdn.del("zones/purgeurl/#{zone_id}.json", urls)

data/examples/simple.rb

@@ -0,0 +1,21 @@
+#!/usr/bin/env ruby
+require File.join('./', File.dirname(__FILE__), '..','lib','keycdn')
+#require "keycdn"
+
+keycdn = KeyCDN::Client.new(ENV["APIKEY"])
+
+puts 'GET /zones.json'
+puts keycdn.get("zones.json")
+
+puts 'GET /zones/<zoneId>.json'
+puts keycdn.get("zones/<zoneId>.json")
+
+time = Time.now.to_i
+
+report = {
+  :start => time-3600,
+  :end  => time
+}
+
+puts 'GET reports/credits.json'
+puts keycdn.get("reports/credits.json", report)

data/keycdn.gemspec

@@ -0,0 +1,16 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/keycdn/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.name = "keycdn"
+  gem.homepage = "https://www.keycdn.com"
+  gem.version = KeyCDN::VERSION
+  gem.license = "MIT"
+  gem.files = `git ls-files`.split($\)
+  gem.require_paths = ['lib']
+  gem.summary = %Q{A Ruby gem for the KeyCDN API}
+  gem.description = %Q{This Ruby gem helps you to interact with the KeyCDN API}
+  gem.email = "support@keycdn.com"
+  gem.authors = ["KeyCDN"]
+  gem.add_dependency 'json' if RUBY_VERSION.start_with? "1.8"
+end

data/lib/keycdn/version.rb

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

data/lib/keycdn.rb

@@ -0,0 +1,77 @@
+require "uri"
+require "net/http"
+require "json"
+
+module KeyCDN
+
+    class Client
+
+        ENDPOINT = 'https://www.keycdn.com/'
+
+        METHOD_MAP = {
+          :get    => Net::HTTP::Get,
+          :post   => Net::HTTP::Post,
+          :put    => Net::HTTP::Put,
+          :delete => Net::HTTP::Delete
+        }
+
+        def initialize(api_key)
+            @api_key = api_key
+        end
+
+        def get(url, params = {})
+            call url, :get, params
+        end
+
+        def post(url, params = {})
+            call url, :post, params
+        end
+
+        def put(url, params = {})
+            call url, :put, params
+        end
+
+        def del(url, params = {})
+            call url, :delete, params
+        end
+
+        private
+
+        def call(url, method, params = {})
+            raise ArgumentError, "URL could not be empty" if url.nil? || url.empty?
+
+            url = ENDPOINT + url
+            uri = URI(url)
+
+            request = Net::HTTP.new(uri.host, uri.port)
+            request.use_ssl = true
+
+            case method
+            when :get
+                full_url = encode_path_params(url, params)
+                request_header = METHOD_MAP[method].new(full_url)
+            else
+                request_header = METHOD_MAP[method].new(uri.path)
+                request_header.set_form_data(params)
+            end
+
+            request_header.basic_auth @api_key, ''
+            response = request.start {|http| http.request(request_header) }
+
+            parse_response(response)
+        end
+
+        def encode_path_params(path, params)
+            encoded = URI.encode_www_form(params)
+            [path, encoded].join("?")
+        end
+
+        def parse_response(response)
+            body = response.body
+            json = JSON.parse(body, :symbolize_names => false)
+            json
+        end
+
+    end
+
+end

data/test/test_keycdn.rb

@@ -0,0 +1,81 @@
+require 'minitest/autorun'
+require 'json'
+require './lib/keycdn'
+
+if (ENV["APIKEY"].nil?)
+  abort "Please export your APIKEY."
+end
+
+class ClientTest < Minitest::Unit::TestCase
+
+    def setup
+      @keycdn  = KeyCDN::Client.new(ENV["APIKEY"])
+      @time = Time.now.to_i
+      @zone_id = '<zoneId>'
+    end
+
+    def test_get
+
+      [ "zonealiases.json",
+        "zonereferrers.json",
+        "zones.json"
+      ].each do |end_point|
+        key = end_point.include?("/") ? end_point.split("/")[1] : end_point.gsub(/\.json/, "")
+
+        assert @keycdn.get(end_point)["data"][key], "get #{key} with data"
+      end
+
+    end
+
+    def test_report
+
+        report = {
+          :start => @time-3600,
+          :end  => @time
+        }
+
+        assert @keycdn.get("reports/credits.json", report)["data"]["stats"], "get credit stats"
+
+    end
+
+    def test_purge_zone
+
+        assert_equal "success", @keycdn.get("zones/purge/#{@zone_id}.json")["status"], "purge zone cache"
+
+    end
+
+    def test_purge_urls
+
+        urls = {
+                'urls[0]' => 'demo-1.kxcdn.com/lorem.css',
+                'urls[1]' => 'demo-1.kxcdn.com/lorem.jpg'
+        };
+
+        assert_equal "success", @keycdn.del("zones/purgeurl/#{@zone_id}.json", urls)["status"], "purge urls"
+
+    end
+
+    def test_post_and_del
+
+      zone = {
+        :name => @time.to_s,
+        :expire  => 9999
+      }
+
+      zone_id = @keycdn.post("zones.json", zone)["data"]["zone"]["id"]
+      assert zone_id, "post/add zone"
+
+      assert_equal "success", @keycdn.del("zones/#{zone_id}.json")["status"], "delete zone"
+    end
+
+    def test_put
+
+      zone = {
+        :name => 'demo',
+        :expire  => 8888
+      }
+
+      assert_equal @zone_id, @keycdn.put("zones/#{@zone_id}.json", zone)["data"]["zone"]["id"], "put/edit"
+    end
+
+end

metadata

@@ -0,0 +1,54 @@
+--- !ruby/object:Gem::Specification
+name: keycdn
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- KeyCDN
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-04-15 00:00:00.000000000 Z
+dependencies: []
+description: This Ruby gem helps you to interact with the KeyCDN API
+email: support@keycdn.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- examples/purge.rb
+- examples/simple.rb
+- keycdn.gemspec
+- lib/keycdn.rb
+- lib/keycdn/version.rb
+- test/test_keycdn.rb
+homepage: https://www.keycdn.com
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.0.14
+signing_key: 
+specification_version: 4
+summary: A Ruby gem for the KeyCDN API
+test_files: []