Merge pull request #1 from Cielo24/feature/CLC-673

Feature/clc 673

Author: ccoakley

cielo24_gem/cielo24-0.0.16.gem

@@ -31,6 +31,7 @@ class Actions
     GET_CAPTION_PATH = '/api/job/get_caption'
     GET_ELEMENT_LIST_PATH = '/api/job/get_elementlist'
     GET_LIST_OF_ELEMENT_LISTS_PATH = '/api/job/list_elementlists'
+    AGGREGATE_STATISTICS_PATH = '/api/job/aggregate_statistics'
 
     def initialize(base_url='https://api.cielo24.com')
       @base_url = base_url
@@ -77,10 +78,10 @@ def update_password(api_token, new_password, sub_account=nil)
       WebUtils.http_request(@base_url + UPDATE_PASSWORD_PATH, 'POST', WebUtils::BASIC_TIMEOUT, nil, nil, query_hash)
     end
 
-    def generate_api_key(api_token, username, force_new=false)
-      assert_argument(username, 'Username')
+    def generate_api_key(api_token, sub_account=nil, force_new=false)
       query_hash = init_access_req_dict(api_token)
-      query_hash[:account_id] = username
+      # account_id parameter named sub_account for clarity
+      query_hash[:account_id] = sub_account unless sub_account.nil?
       query_hash[:force_new] = force_new
       response = WebUtils.get_json(@base_url + GENERATE_API_KEY_PATH, 'GET', WebUtils::BASIC_TIMEOUT, query_hash)
       response['ApiKey']
@@ -213,6 +214,18 @@ def get_list_of_element_lists(api_token, job_id)
       WebUtils.get_json(@base_url + GET_LIST_OF_ELEMENT_LISTS_PATH, 'GET', WebUtils::BASIC_TIMEOUT, query_hash)
     end
 
+    def aggregate_statistics(api_token, metrics=nil, group_by=nil, start_date=nil, end_date=nil, sub_account=nil)
+      query_hash = init_access_req_dict(api_token)
+      query_hash[:metrics] = metrics.to_json unless metrics.nil?
+      query_hash[:group_by] = group_by unless group_by.nil?
+      query_hash[:start_date] = start_date unless start_date.nil?
+      query_hash[:end_date] = end_date unless end_date.nil?
+      # account_id parameter named sub_account for clarity
+      query_hash[:account_id] = sub_account unless sub_account.nil?
+      response = WebUtils.get_json(@base_url + AGGREGATE_STATISTICS_PATH, 'GET', WebUtils::BASIC_TIMEOUT, query_hash)
+      return Mash.new(response)
+    end
+
     ##############################
     ### PRIVATE HELPER METHODS ###
     ##############################

cielo24_gem/cielo24-0.0.17.gem

@@ -1,3 +1,3 @@
 module Cielo24
-  VERSION = '0.0.16'
-end
+  VERSION = '0.0.17'
+end

cielo24_gem/lib/cielo24/actions.rb

@@ -5,18 +5,33 @@
 
 class ActionsTest < Test::Unit::TestCase
 
-  def initialize(test_method_name)
-    super(test_method_name)
+  def initialize(opts)
+    super(opts)
     @config = Configuration.new
     @actions = Cielo24::Actions.new(@config.server_url)
     @api_token = nil
     @secure_key = nil
   end
 
-  # Called before every test method runs. Can be used to set up fixture information.
   def setup
     # Start with a fresh session each time
     @api_token = @actions.login(@config.username, @config.password, nil, true)
     @secure_key = @actions.generate_api_key(@api_token, @config.username, false)
   end
+
+  def teardown
+    # Remove secure key
+    unless @api_token.nil? or @secure_key.nil?
+      begin
+        @actions.remove_api_key(@api_token, @secure_key)
+      rescue WebError => e
+        if e.type == ErrorType::ACCOUNT_UNPRIVILEGED
+          @api_token = @actions.login(@config.username, @config.password, nil, true)
+          @actions.remove_api_key(@api_token, @secure_key)
+        else
+          # Pass silently
+        end
+      end
+    end
+  end
 end

cielo24_gem/lib/cielo24/version.rb

@@ -15,6 +15,17 @@ def setup
     @job_id = @actions.create_job(@api_token, 'Ruby_test').JobId
   end
 
+  # Called after every test method runs. Can be used to tear down fixture information.
+  def teardown
+    super
+    # Delete job
+    begin
+      @actions.delete_job(@api_token, @job_id)
+    rescue
+      # Pass silently
+    end
+  end
+
   # Since all option classes extend BaseOptions class (with all of the functionality) we only need to test one class
   def test_options
     options = CaptionOptions.new
@@ -106,4 +117,16 @@ def test_add_media_to_job_file
     @task_id = @actions.add_media_to_job_file(@api_token, @job_id, file)
     assert_equal(32, @task_id.length)
   end
+
+  def test_aggregate_statistics
+    response = @actions.aggregate_statistics(@api_token,
+                                             metrics=%w(billable_minutes_total billable_minutes_professional),
+                                             group_by='month',
+                                             start_date='2015-06-25T00:00:00.000000',
+                                             end_date='2015-07-25T00:00:00.000000',
+                                             account_id='*')
+    assert_equal(response.data.length, 2)
+    assert(response.data[0].has_key?('billable_minutes_total'))
+    assert(response.data[0].has_key?('billable_minutes_professional'))
+  end
 end

cielo24_gem/test/actions_test.rb

@@ -8,7 +8,6 @@
 
 class SequentialTest < ActionsTest
 
-  # Called before every test method runs. Can be used to set up fixture information.
   def setup
     # Do nothing - we want to be able to control when we login/logout etc.
   end