cdnetworks-client 1.0.0 → 1.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 6bd4a440e05f7d4b6ef2660939e4bafbb0240170
+  data.tar.gz: 1420de6d854c4480b60253d76bf3dd74713bc5f8
+SHA512:
+  metadata.gz: 028b8c3c57295fac38fd27b6c06646e49b4c4c5a17f919df5777ad7a4e506a7a87907dd9ea47d06a41be93b6b65cb8f4488561a4890a4f417e538667290d6272
+  data.tar.gz: d8b48ae6f09eba38d32c1b3dd422f2583d33cf0695053863e692b0b9644226329efc2627052073b2586657a98c397ead590b02abc89204039221b79795d418c6

data/LICENSE

@@ -186,7 +186,7 @@ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
   same "printed page" as the copyright notice for easier
   identification within third-party archives.
 
-  Copyright [yyyy] [name of copyright owner]
+  Copyright [2013] [Blue Box, Inc., Nell Shamrell]
 
   Licensed under the Apache License, Version 2.0 (the "License");
   you may not use this file except in compliance with the License.

data/README.md

@@ -4,6 +4,7 @@ The Cdnetworks Client is a simple wrapper for three [Cdnetworks](http://www.cdne
 * Config Open API v1.0
 * Cache Purge Open API v2.0 (older cache flushing API)
 * Cache Flush Open API v2.3.2 (most current cache flushing API)
+* Statistics Open API v2
 
 This gem allows a user to call methods from either of these APIs using the same syntax.
 

data/lib/cdnetworks-client.rb

@@ -1,56 +1,114 @@
+require "json"
+
+require_relative "patches"
+
 require "cdnetworks-client/version"
 require "cdnetworks-client/cache_purge_api"
 require "cdnetworks-client/config_open_api"
 require "cdnetworks-client/cache_flush_open_api"
+require "cdnetworks-client/open_api_error"
+require "cdnetworks-client/auth_open_api"
+require "cdnetworks-client/open_api_keys"
+require "cdnetworks-client/statistics_open_api"
 
 class CdnetworksClient
   include ConfigOpenApi
   include CachePurgeApi
   include CacheFlushOpenApi
+  include StatisticsOpenApi
+  attr_accessor :user, :password, :location
 
+  MAX_SESSION_RETRIES = 2
 
   def initialize(credentials={})
-    @user       = credentials[:user]
-    @password   = credentials[:pass]
-    @location   = credentials[:location]
+    self.user       = credentials[:user]
+    self.password   = credentials[:pass]
+    self.location   = credentials[:location]
   end
 
   def compose_request(path,options)
-    request = Net::HTTP::Post.new("#{base_url(@location)}#{path}")
+    request = Net::HTTP::Post.new("#{base_url(location)}#{path}")
     request.set_form_data(options)
     request
   end
 
-  def call(path,options)
-    begin
-      response = http.request(compose_request(path,options))
+  def call(path,options,session_retries=0)
+    response = http.request(compose_request(path,options))
+
+    if location == "Beta"
+      process_beta_response(path, options, response, session_retries)
+    else
       response_hash = { code: response.code, body: response.body }
-    rescue StandardError=>e
-      "An error has occurred connecting to the CDNetworks API (#{e})"
     end
   end
 
   private
 
-  def base_url(location=nil)
+  def base_url(loc=nil)
     case
-    when location == "Korea"
+    when loc == "Korea"
       "https://openapi.kr.cdnetworks.com"
-    when location == "Japan"
+    when loc == "Japan"
       "https://openapi.jp.cdnetworks.com"
-    when location == "China"
+    when loc == "China"
       "https://openapi.txnetworks.cn"
+    when loc == "Beta"
+      "https://openapi-beta.cdnetworks.com"
     else
       "https://openapi.us.cdnetworks.com"
     end
   end
 
+  def process_beta_response(path, options, response, session_retries)
+    if expired_session_response?(response)
+      if session_retries <= MAX_SESSION_RETRIES
+        new_session_token = get_session_token(true)
+        options[:sessionToken] = new_session_token
+        return call(path, options, session_retries + 1)
+      else
+        raise OpenApiError::CriticalApiError.new("Session expired and failed to be re-established after #{session_retries} tries")
+      end
+    end
+
+    begin
+      data = JSON.parse(response.body)
+
+      result_code = data.values.first['resultCode'] || data.values.first['returnCode']
+
+      if !%w{0 200 404}.include?(result_code.to_s)
+        OpenApiError::ErrorHandler.handle_error_response(result_code, response.body)
+      else
+        {code: result_code, body: data}
+      end
+    rescue JSON::ParserError
+      raise OpenApiError::CriticalApiError.new("Unparseable body: #{response.body}")
+    end
+  end
+
   def http
-    uri = URI.parse(base_url)
+    uri = URI.parse(base_url(location))
 
     http = Net::HTTP.new(uri.host, uri.port)
     http.use_ssl = true
 
     http
   end
+
+  def expired_session_response?(response)
+    if response.code.to_s == "200"
+      begin
+        parsed = JSON.parse(response.body.to_s)
+        if parsed.values.first
+          parsed.values.first['returnCode'] == 102 ||
+            parsed.values.first['resultCode'] == 102
+        else
+          false
+        end
+      rescue JSON::ParserError
+        false
+      end
+    else
+      false
+    end
+  end
 end

data/lib/cdnetworks-client/auth_open_api.rb

@@ -0,0 +1,56 @@
+module AuthOpenApi
+  LOGIN_URL = "/api/rest/login"
+  LOGOUT_URL = "/api/rest/logout"
+
+  class AuthSession
+    def raise_handled_error(code, desc)
+      raise OpenApiError::ApiError.new("Auth error: #{code} - #{desc}")
+    end
+
+    def initialize(user, pass, client)
+      @user = user
+      @pass = pass
+      @client = client
+    end
+
+    def session
+      @session ||= login
+    end
+
+    def login
+      params = {
+        user: @user,
+        pass: @pass,
+        output: "json"
+      }
+      resp = @client.call(LOGIN_URL, params)
+
+      resp[:body]['loginResponse']['session']
+    end
+
+    def logout
+      params = {
+        user: @user,
+        pass: @pass,
+        output: "json"
+      }
+
+      resp = @client.call(LOGOUT_URL, params)
+      resp[:body]['logoutResponse']
+    end
+  end
+
+  def get_session_token(reset_session = false, keynum = 0)
+    if !@auth_session || reset_session
+      @auth_session = AuthSession.new(@user, @password, self)
+    end
+
+    session = Array.wrap(@auth_session.session)[keynum]
+
+    if session.is_a?(Hash)
+      session['sessionToken']
+    else
+      nil
+    end
+  end
+end

data/lib/cdnetworks-client/config_open_api.rb

@@ -1,7 +1,11 @@
 module ConfigOpenApi
-
   def list(options={})
-    call(config_open_path("list"),add_config_credentials(options))
+    response = call(config_open_path("list"), add_config_credentials(options))
+    if location == "Beta"
+      response[:body]["PadConfigResponse"]["data"]["data"]
+    else
+      response
+    end
   end
 
   def view(options={})
@@ -17,12 +21,25 @@ module ConfigOpenApi
   end
 
   def config_open_path(command)
-    "/config/rest/pan/site/#{command}"
+    if location == "Beta"
+      "/api/rest/pan/site/#{command}"
+    else
+      "/config/rest/pan/site/#{command}"
+    end
   end
 
   def add_config_credentials(options)
-    options[:user]     = @user
-    options[:pass] = @password
+    if location == "Beta"
+      session_token = get_session_token
+      keys = get_api_key_list(session_token)
+      api_key = keys.find{|k| k["type"] == 0}["apiKey"]
+
+      options[:sessionToken] = session_token
+      options[:apiKey] = api_key
+    else
+      options[:user]     = @user
+      options[:pass] = @password
+    end
 
     options
   end

data/lib/cdnetworks-client/open_api_error.rb

@@ -0,0 +1,31 @@
+module OpenApiError
+  ERROR_CODES = {
+    "101" => "User login information error",
+    "102" => "Invalid session",
+    "103" => "Logout failure",
+    "104" => "Input parameter error (no entry is made or invalid value)",
+    "202" => "Inaccessible menu (Setting can be modified via Customer Portal)",
+    "203" => "Inaccessible service (Setting can be modified via Customer Portal)",
+    "204" => "Inaccessible Request (See Table-1. The Scope of CDNetworks Statistics Open API)",
+    "301" => "Unregistered API key (Registration information is provided in Customer Portal)",
+    "999" => "Temporary error"
+  }
+
+  class ApiError < StandardError
+
+  end
+
+  class CriticalApiError < StandardError
+
+  end
+
+  class ErrorHandler
+    def self.handle_error_response(code, body)
+      if desc = ERROR_CODES[code.to_s]
+        raise ApiError.new("Open API Error #{code}: #{desc}")
+      else
+        raise ApiError.new("Unknown Open API Response Code #{code} (body: #{body})")
+      end
+    end
+  end
+end

data/lib/cdnetworks-client/open_api_keys.rb

@@ -0,0 +1,29 @@
+module OpenApiKeys
+  GET_KEY_PATH = "/api/rest/getApiKeyList"
+
+  def get_api_key_list(session_token)
+    params = {
+      output: "json",
+      sessionToken: session_token
+    }
+    uri = URI("#{base_url(@location)}/#{GET_KEY_PATH}")
+    uri.query = URI.encode_www_form(params)
+
+    response = call(GET_KEY_PATH, params)
+
+    response[:body]['apiKeyInfo']['apiKeyInfoItem']
+  end
+
+  def get_api_key(session_token, service_name)
+
+    key_for_service = (get_api_key_list(session_token) || []).find do |service|
+      service['serviceName'] == service_name
+    end
+
+    unless key_for_service
+      raise "No key found for #{service_name}"
+    end
+
+    return key_for_service['apiKey']
+  end
+end

data/lib/cdnetworks-client/statistics_open_api.rb

@@ -0,0 +1,29 @@
+module StatisticsOpenApi
+  include AuthOpenApi
+  include OpenApiKeys
+
+  BANDWIDTH_PATH = "/api/rest/traffic/edge"
+
+  def bandwidth_usage(service_name, from, to, time_interval = 2)
+    session_token = get_session_token
+
+    api_key = get_api_key(session_token, service_name)
+
+    opts = {
+      sessionToken: session_token,
+      apiKey: api_key,
+      fromDate: from.strftime("%Y%m%d"),
+      toDate: to.strftime("%Y%m%d"),
+      timeInterval: time_interval,
+      output: "json"
+    }
+
+    response = call(BANDWIDTH_PATH, opts)
+
+    if response[:code].to_s == "404"
+      nil
+    else
+      Array.wrap(response[:body]['trafficResponse']['trafficItem']).map{|i| i['dataTransferred']}.inject(&:+)
+    end
+  end
+end

data/lib/cdnetworks-client/version.rb

@@ -1,5 +1,5 @@
 module Cdnetworks
   module Client
-    VERSION = "1.0.0"
+    VERSION = "1.1.0"
   end
 end

data/lib/patches.rb

@@ -0,0 +1,11 @@
+class Array
+  def self.wrap(object)
+    if object.nil?
+      []
+    elsif object.respond_to?(:to_ary)
+      object.to_ary || [object]
+    else
+      [object]
+    end
+  end
+end

data/spec/integration_spec.rb

@@ -0,0 +1,37 @@
+require_relative 'spec_helper'
+
+describe CdnetworksClient do
+  before(:all) do
+    @user = ENV['CDN_USER']
+    @pass = ENV['CDN_PASS']
+
+    unless @user && @pass
+      skip "either CDN_USER or CDN_PASS env var not set. skipping"
+    end
+
+    WebMock.allow_net_connect!
+
+    @client = CdnetworksClient.new(user: @user, pass: @pass, location: "Beta")
+  end
+
+  after(:all) do
+    WebMock.disable_net_connect!
+  end
+
+  it 'gets a session' do
+    expect(@client.get_session_token).not_to be_nil
+  end
+
+  it 'gets bandwidth usage' do
+    pad = ENV['CDN_PAD']
+    skip "must set CDN_PAD env var" unless pad
+    usage = @client.bandwidth_usage(pad, Date.today - 2, Date.today - 1)
+    expect(usage).to be > 0
+  end
+
+  it 'lists pads for a session' do
+    pads = @client.list
+
+    expect(pads.length).to be > 0
+  end
+end

data/spec/lib/cdnetworks-client/cdnetworks_client_spec.rb

@@ -21,25 +21,25 @@ describe CdnetworksClient do
     it "calls the list method of the cdnetworks api" do
       @cdn_api.list
 
-      a_request(:post, "#{@url}/config/rest/pan/site/list").
+      expect(a_request(:post, "#{@url}/config/rest/pan/site/list").
         with(:body    => 'user=user%40user.com&pass=secret',
              :headers => {
                            'Accept'      =>'*/*',
                            'Content-Type'=>'application/x-www-form-urlencoded',
-                           'User-Agent'  =>'Ruby'}).
-        should have_been_made
+                           'User-Agent'  =>'Ruby'})).
+        to have_been_made
     end
 
     it "includes options passed as a hash" do
       @cdn_api.list(:prod => true)
 
-      a_request(:post, "#{@url}/config/rest/pan/site/list").
+      expect(a_request(:post, "#{@url}/config/rest/pan/site/list").
         with(:body    => 'prod=true&user=user%40user.com&pass=secret',
              :headers => {
                            'Accept'      =>'*/*',
                            'Content-Type'=>'application/x-www-form-urlencoded',
-                           'User-Agent'  =>'Ruby'}).
-        should have_been_made
+                           'User-Agent'  =>'Ruby'})).
+        to have_been_made
     end
   end
 
@@ -52,25 +52,25 @@ describe CdnetworksClient do
     it "calls the view method of the cdnetworks api" do
       @cdn_api.view
 
-      a_request(:post, "#{@url}/config/rest/pan/site/view").
+      expect(a_request(:post, "#{@url}/config/rest/pan/site/view").
         with(:body    => 'user=user%40user.com&pass=secret',
              :headers => {
                            'Accept'      =>'*/*',
                            'Content-Type'=>'application/x-www-form-urlencoded',
-                           'User-Agent'  =>'Ruby'}).
-      should have_been_made
+                           'User-Agent'  =>'Ruby'})).
+      to have_been_made
     end
 
     it "includes options passed as a hash" do
       @cdn_api.view(:pad => "cache.foo.com")
 
-      a_request(:post, "#{@url}/config/rest/pan/site/view").
+      expect(a_request(:post, "#{@url}/config/rest/pan/site/view").
         with(:body    => 'pad=cache.foo.com&user=user%40user.com&pass=secret',
              :headers => {
                            'Accept'      =>'*/*',
                            'Content-Type'=>'application/x-www-form-urlencoded',
-                           'User-Agent'  =>'Ruby'}).
-      should have_been_made
+                           'User-Agent'  =>'Ruby'})).
+      to have_been_made
     end
 
   end
@@ -84,25 +84,25 @@ describe CdnetworksClient do
     it "calls the add method of the cdnetworks api" do
       @cdn_api.add
 
-      a_request(:post, "#{@url}/config/rest/pan/site/add").
+      expect(a_request(:post, "#{@url}/config/rest/pan/site/add").
       with(:body    => 'user=user%40user.com&pass=secret',
            :headers => {
                          'Accept'      =>'*/*',
                          'Content-Type'=>'application/x-www-form-urlencoded',
-                         'User-Agent'  =>'Ruby'}).
-      should have_been_made
+                         'User-Agent'  =>'Ruby'})).
+      to have_been_made
     end
 
     it "includes options passed as a hash" do
       @cdn_api.add(:pad => "cache.foo.com", :origin => "neworigin.foo.com")
 
-      a_request(:post, "#{@url}/config/rest/pan/site/add").
+      expect(a_request(:post, "#{@url}/config/rest/pan/site/add").
         with(:body    => 'pad=cache.foo.com&origin=neworigin.foo.com&user=user%40user.com&pass=secret',
              :headers => {
                            'Accept'      =>'*/*',
                            'Content-Type'=>'application/x-www-form-urlencoded',
-                           'User-Agent'  =>'Ruby'}).
-      should have_been_made
+                           'User-Agent'  =>'Ruby'})).
+      to have_been_made
     end
   end
 
@@ -115,25 +115,25 @@ describe CdnetworksClient do
     it "calls the edit method of the cdnetworks api" do
       @cdn_api.edit
 
-      a_request(:post, "#{@url}/config/rest/pan/site/edit").
+      expect(a_request(:post, "#{@url}/config/rest/pan/site/edit").
       with(:body    => 'user=user%40user.com&pass=secret',
            :headers => {
                          'Accept'      =>'*/*',
                          'Content-Type'=>'application/x-www-form-urlencoded',
-                         'User-Agent'  =>'Ruby'}).
-      should have_been_made
+                         'User-Agent'  =>'Ruby'})).
+      to have_been_made
     end
 
     it "includes the options passed as a hash" do
       @cdn_api.edit(:pad => "cache.foo.com", :honor_byte_range => "1")
 
-      a_request(:post, "#{@url}/config/rest/pan/site/edit").
+      expect(a_request(:post, "#{@url}/config/rest/pan/site/edit").
       with(:body    => 'pad=cache.foo.com&honor_byte_range=1&user=user%40user.com&pass=secret',
            :headers => {
                          'Accept'      =>'*/*',
                          'Content-Type'=>'application/x-www-form-urlencoded',
-                         'User-Agent'  =>'Ruby'}).
-      should have_been_made
+                         'User-Agent'  =>'Ruby'})).
+      to have_been_made
     end
   end
 
@@ -147,56 +147,56 @@ describe CdnetworksClient do
       it "calls the purge method of the cdnetworks api" do
         @cdn_api.execute_cache_purge
 
-        a_request(:post, "#{@url}/OpenAPI/services/CachePurgeAPI/executeCachePurge").
+        expect(a_request(:post, "#{@url}/OpenAPI/services/CachePurgeAPI/executeCachePurge").
         with(:body    => 'userId=user%40user.com&password=secret',
              :headers => {
                            'Accept'      =>'*/*',
                            'Content-Type'=>'application/x-www-form-urlencoded',
-                           'User-Agent'  =>'Ruby'}).
-        should have_been_made
+                           'User-Agent'  =>'Ruby'})).
+        to have_been_made
       end
 
       it "includes the options passed as a hash" do
         @cdn_api.execute_cache_purge(:purgeUriList => "cdn.example.com")
 
-        a_request(:post, "#{@url}/OpenAPI/services/CachePurgeAPI/executeCachePurge").
+        expect(a_request(:post, "#{@url}/OpenAPI/services/CachePurgeAPI/executeCachePurge").
         with(:body    => 'purgeUriList=cdn.example.com&userId=user%40user.com&password=secret',
              :headers => {
                            'Accept'      =>'*/*',
                            'Content-Type'=>'application/x-www-form-urlencoded',
-                           'User-Agent'  =>'Ruby'}).
-        should have_been_made
+                           'User-Agent'  =>'Ruby'})).
+        to have_been_made
       end
 
       it "handles options passed as an array" do
         @cdn_api.execute_cache_purge(:purgeUriList => ["cdn.example.com", "pad.foo.com"])
 
-        a_request(:post, "#{@url}/OpenAPI/services/CachePurgeAPI/executeCachePurge").
+        expect(a_request(:post, "#{@url}/OpenAPI/services/CachePurgeAPI/executeCachePurge").
         with(:body    => 'purgeUriList=cdn.example.com&purgeUriList=pad.foo.com&userId=user%40user.com&password=secret',
              :headers => {
                            'Accept'      =>'*/*',
                            'Content-Type'=>'application/x-www-form-urlencoded',
-                           'User-Agent'  =>'Ruby'}).
-        should have_been_made
+                           'User-Agent'  =>'Ruby'})).
+        to have_been_made
       end
     end
 
     context "getting a cache domain list" do
       before(:each) do
-        stub_request(:post, "https://openapi.us.cdnetworks.com/OpenAPI/services/CachePurgeAPI/getCacheDomainList").
+        stub_request(:post, "#{@url}/OpenAPI/services/CachePurgeAPI/getCacheDomainList").
           to_return(:status => 200, :body => "", :headers => {})
       end
 
       it "calls the cache domain list method of the cdnetworks api" do
         @cdn_api.get_cache_domain_list
 
-        a_request(:post, "#{@url}/OpenAPI/services/CachePurgeAPI/getCacheDomainList").
+        expect(a_request(:post, "#{@url}/OpenAPI/services/CachePurgeAPI/getCacheDomainList").
         with(:body    => 'userId=user%40user.com&password=secret',
              :headers => {
                            'Accept'      =>'*/*',
                            'Content-Type'=>'application/x-www-form-urlencoded',
-                           'User-Agent'  =>'Ruby'}).
-        should have_been_made
+                           'User-Agent'  =>'Ruby'})).
+        to have_been_made
       end
     end
   end
@@ -211,76 +211,87 @@ describe CdnetworksClient do
       it "calls the purge method" do
         @cdn_api.do_purge
 
-        a_request(:post, "#{@url}/purge/rest/doPurge").
+        expect(a_request(:post, "#{@url}/purge/rest/doPurge").
         with(:body    => 'user=user%40user.com&pass=secret',
              :headers => {
                            'Accept'      =>'*/*',
                            'Content-Type'=>'application/x-www-form-urlencoded',
-                           'User-Agent'  =>'Ruby'}).
-        should have_been_made
+                           'User-Agent'  =>'Ruby'})).
+        to have_been_made
       end
 
       it "handles options passed as a hash" do
         @cdn_api.do_purge(:pad => "cdn.example.com", :type => "all")
 
-        a_request(:post, "#{@url}/purge/rest/doPurge").
+        expect(a_request(:post, "#{@url}/purge/rest/doPurge").
         with(:body    => 'pad=cdn.example.com&type=all&user=user%40user.com&pass=secret',
              :headers => {
                            'Accept'      =>'*/*',
                            'Content-Type'=>'application/x-www-form-urlencoded',
-                           'User-Agent'  =>'Ruby'}).
-        should have_been_made
+                           'User-Agent'  =>'Ruby'})).
+        to have_been_made
       end
 
       it "handles options passed as an array" do
         @cdn_api.do_purge(:path => ["/images/one.jpg", "/images/two.jpg"])
-        a_request(:post, "#{@url}/purge/rest/doPurge").
+        expect(a_request(:post, "#{@url}/purge/rest/doPurge").
         with(:body    => 'path=%2Fimages%2Fone.jpg&path=%2Fimages%2Ftwo.jpg&user=user%40user.com&pass=secret',
              :headers => {
                            'Accept'      =>'*/*',
                            'Content-Type'=>'application/x-www-form-urlencoded',
-                           'User-Agent'  =>'Ruby'}).
-        should have_been_made
+                           'User-Agent'  =>'Ruby'})).
+        to have_been_made
       end
     end
 
     context "getting a list of PADs" do
+      before do
+        stub_request(:post, "#{@url}/purge/rest/padList").
+          with(:body => {"pass"=>"secret", "user"=>"user@user.com"}).
+          to_return(:status => 200, :body => "", :headers => {})
+      end
+
       it "calls the list method" do
         @cdn_api.pad_list
 
-        a_request(:post, "#{@url}/purge/rest/padList").
+        expect(a_request(:post, "#{@url}/purge/rest/padList").
         with(:body    => 'user=user%40user.com&pass=secret',
              :headers => {
                            'Accept'      =>'*/*',
                            'Content-Type'=>'application/x-www-form-urlencoded',
-                           'User-Agent'  =>'Ruby'}).
-        should have_been_made
+                           'User-Agent'  =>'Ruby'})).
+        to have_been_made
       end
     end
 
     context "get the status of a purge" do
+      before do
+        stub_request(:post, "#{@url}/purge/rest/status").
+          to_return(status: 200, body: "", headers: {})
+      end
+
       it "calls the status method" do
         @cdn_api.status
 
-        a_request(:post, "#{@url}/purge/rest/status").
+        expect(a_request(:post, "#{@url}/purge/rest/status").
         with(:body    => 'user=user%40user.com&pass=secret',
              :headers => {
                            'Accept'      =>'*/*',
                            'Content-Type'=>'application/x-www-form-urlencoded',
-                           'User-Agent'  =>'Ruby'}).
-        should have_been_made
+                           'User-Agent'  =>'Ruby'})).
+        to have_been_made
       end
 
       it "handles options passsed as a hash" do
         @cdn_api.status(pid: 1234)
 
-        a_request(:post, "#{@url}/purge/rest/status").
+        expect(a_request(:post, "#{@url}/purge/rest/status").
         with(:body    => 'pid=1234&user=user%40user.com&pass=secret',
              :headers => {
                            'Accept'      =>'*/*',
                            'Content-Type'=>'application/x-www-form-urlencoded',
-                           'User-Agent'  =>'Ruby'}).
-        should have_been_made
+                           'User-Agent'  =>'Ruby'})).
+        to have_been_made
       end
     end
   end
@@ -288,7 +299,7 @@ describe CdnetworksClient do
   context "locations" do
     it "uses the US access domain by default" do
       request = @cdn_api.compose_request("/some/path",{})
-      request.path.should include("openapi.us.cdnetworks.com")
+      expect(request.path).to include("openapi.us.cdnetworks.com")
     end
 
     it "uses the Korean access domain when specified" do
@@ -299,7 +310,7 @@ describe CdnetworksClient do
                    )
 
       request = korean_cdn.compose_request("/some/path",{})
-      request.path.should include("openapi.kr.cdnetworks.com")
+      expect(request.path).to include("openapi.kr.cdnetworks.com")
     end
 
     it "uses the Japanese access domain when specified" do
@@ -310,7 +321,7 @@ describe CdnetworksClient do
                    )
 
       request = japanese_cdn.compose_request("/some/path",{})
-      request.path.should include("openapi.jp.cdnetworks.com")
+      expect(request.path).to include("openapi.jp.cdnetworks.com")
     end
 
     it "uses the Chinese access domain when specified" do
@@ -321,7 +332,7 @@ describe CdnetworksClient do
                    )
 
       request = chinese_cdn.compose_request("/some/path",{})
-      request.path.should include("openapi.txnetworks.cn")
+      expect(request.path).to include("openapi.txnetworks.cn")
     end
   end
 
@@ -338,10 +349,104 @@ describe CdnetworksClient do
     end
 
     it "returns an error" do
-      error_result = @cdn_api.list
-      error_result.should include("An error has occurred")
-      error_result.should include("execution expired")
+      expect { @cdn_api.list }.to raise_error(Timeout::Error)
     end
   end
 
+
+  context 'OpenApiV2' do
+    before do
+      @cdn_api           = CdnetworksClient.new(
+                             user: @user,
+                             pass: @password,
+                             location: "Beta"
+                           )
+
+      @url               = "https://openapi-beta.cdnetworks.com"
+
+      @fake_token, @fake_key, _, @fake_service = stub_auth_calls
+    end
+
+    context "Session Management" do
+      let(:bad_token) { "oldtoken12345" }
+      let(:expired_session_resp) { JSON.pretty_unparse(apiKeyInfo: {returnCode: 102}) }
+
+      before do
+        @good_token, _ = stub_auth_calls
+        stub_request(:post, "#{@url}/api/rest/getApiKeyList").with(body: {"output"=>"json", "sessionToken"=>bad_token}).to_return(body: expired_session_resp)
+      end
+
+      it "re-establishes session if it expires" do
+        session_keys = @cdn_api.get_api_key_list(bad_token)
+
+        expect(a_request(:post, "#{@url}/api/rest/login")).to have_been_made
+        expect(session_keys.length).to be > 0
+      end
+
+      it "doesn't infinite loop if session can't be re-established" do
+        stub_request(:post, "#{@url}/api/rest/login").to_return(body: JSON.pretty_unparse(loginResponse: {resultCode: 101}))
+        expect { @cdn_api.get_api_key_list(bad_token) }.to raise_error(OpenApiError::ApiError)
+      end
+
+      it "gives up if session is not re-established after MAX_SESSION_RETRIES tries" do
+        stub_request(:post, "#{@url}/api/rest/getApiKeyList").with(body: {"output"=>"json", "sessionToken"=>@good_token}).to_return(body: expired_session_resp)
+
+        expect { @cdn_api.get_api_key_list(bad_token) }.to raise_error(OpenApiError::CriticalApiError)
+
+        expect(a_request(:post, "#{@url}/api/rest/login")).to have_been_made.times(3)
+      end
+    end
+
+    describe ConfigOpenApi do
+      before { stub_pad_list(@fake_service) }
+
+      it "fetches list using api key endpoint for OpenApiV2" do
+        expect(@cdn_api.list.first["origin"]).to eq(@fake_service)
+      end
+    end
+
+    describe AuthOpenApi do
+      it "raises error on failed login" do
+        stub_failed_login
+        expect{ @cdn_api.get_session_token }.to raise_error(OpenApiError::ApiError)
+      end
+
+      it "gets a session token" do
+        session_token = @cdn_api.get_session_token
+
+        expect(session_token).to eq(@fake_token)
+      end
+
+      skip "gets a service identifier" do
+        session = @cdn_api.get_session_token
+
+        expect(session[0]["svcGroupIdentifier"]).to eq(@fake_identifier)
+      end
+    end
+
+    describe OpenApiKeys do
+      it "gets api keys" do
+        api_key = @cdn_api.get_api_key(@fake_token, @fake_service)
+
+        expect(api_key).to eq(@fake_key)
+      end
+    end
+
+    describe StatisticsOpenApi do
+      describe "#bandwidth_usage" do
+        let(:end_time)           { Time.now }
+        let(:start_time)         { end_time - 1*60*60*24 }
+        let(:expected_bandwidth) { 1.23456 }
+
+        before do
+          stub_get_edge_traffic(expected_bandwidth)
+        end
+
+        it "returns bandwidth usage for a given time period" do
+          expect(@cdn_api.bandwidth_usage @fake_service, start_time, end_time).to eq expected_bandwidth
+        end
+      end
+    end
+
+  end
 end

data/spec/spec_helper.rb

@@ -1,3 +1,72 @@
 require 'webmock/rspec'
 
 require File.expand_path('../../lib/cdnetworks-client.rb', __FILE__)
+
+module ApiStubs
+  def stub_auth_calls
+    fake_token = "12345thetoken"
+    fake_api_key = "EAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA"
+    fake_identifier = "90525E70B7842930586545C6F1C9310C"
+    fake_service_name = 'cdn.example-app.host.com'
+    stub_login(fake_token, fake_identifier)
+    stub_get_api_keys(fake_token, fake_service_name, fake_api_key)
+
+    [fake_token, fake_api_key, fake_identifier, fake_service_name]
+  end
+
+  def stub_login(return_token, svc_identifier)
+    resp = JSON.pretty_unparse({loginResponse: {returnCode: 0,
+                                                session: [{sessionToken: return_token,
+                                                           svcGroupName: "Service Group Name",
+                                                           svcGroupIdentifier: svc_identifier}]}})
+
+    stub_request(:post, "#{@url}/api/rest/login").to_return(body: resp)
+  end
+
+  def stub_failed_login
+    stub_request(:post, "#{@url}/api/rest/login").to_return(body: JSON.pretty_unparse(loginResponse: {returnCode: 101}))
+  end
+
+  def stub_get_api_keys(session_token, service_name, return_key)
+    resp = JSON.pretty_unparse({apiKeyInfo: {returnCode: 0,
+                                             apiKeyInfoItem: [{type: 0,
+                                                               serviceName: "Content Acceleration",
+                                                               apiKey: "SERVICECATEGORY_CA",
+                                                               parentApiKey: "SERVICECATEGORY_CA"},
+                                                               {type: 1,
+                                                                serviceName: service_name,
+                                                                apiKey: return_key,
+                                                                parentApiKey: "SERVICECATEGORY_CA"},
+                                                                {type: 1,
+                                                                 serviceName: "cdn.another.app.com",
+                                                                 apiKey: "55555555555555555555555555555555",
+                                                                 parentApiKey: "SERVICECATEGORY_CA"}]}})
+
+    stub_request(:post, "#{@url}/api/rest/getApiKeyList").with(body: {"output"=>"json", "sessionToken"=>session_token}).to_return(body: resp)
+  end
+
+  def stub_get_edge_traffic(expected_bandwidth)
+    # TODO - take date as input and strftime it in output
+    resp = JSON.pretty_unparse(trafficResponse: {returnCode: 0,
+                                                 trafficItem:
+                                                 [{dateTime: '200809162305', bandwidth: 10, dataTransferred: expected_bandwidth}]})
+    stub_request(:post, "#{@url}/api/rest/traffic/edge").to_return(body: resp)
+  end
+
+  def stub_pad_list(expected_service)
+     resp = { "PadConfigResponse" => {
+                "resultCode" => 200,
+                "data"=> {
+                  "errors" => "",
+                  "data" => [ {"origin"=>expected_service, "pad"=>"pad.#{expected_service}", "id"=>11111},
+                              {"origin"=>"another-site.com", "pad"=>"assets.another-site.com", "id"=>22222},
+                              {"origin"=>"some.site.with.many.subdomains.com", "pad"=>"assets.many.subdomains.com", "id"=>33333},
+                              {"origin"=>"somesite.s3.amazonaws.com", "pad"=>"assets.somesite.com", "id"=>44444} ]}}}
+
+    stub_request(:post, "#{@url}/api/rest/pan/site/list").to_return(body: JSON.pretty_unparse(resp))
+  end
+end
+
+RSpec.configure do |config|
+  config.include ApiStubs
+end

metadata

@@ -1,46 +1,41 @@
 --- !ruby/object:Gem::Specification
 name: cdnetworks-client
 version: !ruby/object:Gem::Version
-  version: 1.0.0
-  prerelease: 
+  version: 1.1.0
 platform: ruby
 authors:
 - Nell Shamrell
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-09-06 00:00:00.000000000 Z
+date: 2015-10-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: webmock
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 description: Simple wrapper for the CDNetworks Config Open API v1.0 and Cache Purge
@@ -51,45 +46,50 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
+- ".gitignore"
 - Gemfile
 - LICENSE
-- LICENSE.txt
 - README.md
 - Rakefile
 - cdnetworks-client.gemspec
 - lib/cdnetworks-client.rb
+- lib/cdnetworks-client/auth_open_api.rb
 - lib/cdnetworks-client/cache_flush_open_api.rb
 - lib/cdnetworks-client/cache_purge_api.rb
 - lib/cdnetworks-client/config_open_api.rb
+- lib/cdnetworks-client/open_api_error.rb
+- lib/cdnetworks-client/open_api_keys.rb
+- lib/cdnetworks-client/statistics_open_api.rb
 - lib/cdnetworks-client/version.rb
+- lib/patches.rb
+- spec/integration_spec.rb
 - spec/lib/cdnetworks-client/cdnetworks_client_spec.rb
 - spec/spec_helper.rb
 homepage: https://github.com/blueboxgroup/cdnetworks-client
 licenses:
 - Apache
+metadata: {}
 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.25
+rubygems_version: 2.4.5.1
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: CDNetworks API Wrapper
 test_files:
+- spec/integration_spec.rb
 - spec/lib/cdnetworks-client/cdnetworks_client_spec.rb
 - spec/spec_helper.rb

data/LICENSE.txt

@@ -1,22 +0,0 @@
-Copyright (c) 2013 Nell Shamrell
-
-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.