osc_ruby 1.2.0 → 1.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: '092bf8f94c945604c55401ccc25290289a330bb5'
-  data.tar.gz: b93990c2ad72a2b09aa350ad49eaf842e70088d7
+  metadata.gz: 0445ee6723c74419476e60d6c70dde19cf0dca7d
+  data.tar.gz: aae32a58af79823e0970c7f19d720d5375dfdaab
 SHA512:
-  metadata.gz: 155dc9b479a66e823ad6aedbb563021ca2a875184623d3af3a7b69a243a31c0fa34d06717a9a4f9e892ae211c853d865cb96b24131868a64d5926a2d192a0b11
-  data.tar.gz: 2433bff4ab9edbf81e37d7f3bde8c413a397152737e7d75854e551b6f4442faf887d284694babcaa909521aac4415cc35ea64c2566dc5db5461879eda557bf6a
+  metadata.gz: 78d2397aaef603036464facd1380ca8893d28114ddffb319eeaf2b8a21ca4d0b12f8d33286e2fa627b33369950ba27df0c20a9fd4128c36e59c0fd1c96b9d453
+  data.tar.gz: 8ab64d7ed2f04d5f89c07f32b6be1eebdf4e9d07c97bc34d61e2b70d642fefa2e6b37d48e20f43e3d5973ae6ff2768e8e5718f0ee3386cabcd65b7ee086acddd

data/lib/osc_ruby/classes/analytics_report_results.rb

@@ -0,0 +1,77 @@
+require 'osc_ruby/modules/validations_module'
+require 'osc_ruby/modules/normalize_module'
+require 'json'
+
+module OSCRuby
+
+	class AnalyticsReportResults
+
+		include NormalizeModule
+		include ValidationsModule
+
+		attr_accessor :lookupName,:id, :filters
+
+	    def initialize(**args)
+	    	@lookupName = args[:lookupName]
+	    	@id = args[:id]
+	    	@filters = []
+	    end
+
+
+
+		def run(client)
+
+			json_data = convert_to_json(self)
+
+			ValidationsModule::check_client(client)
+
+	    	response = OSCRuby::Connect.post_or_patch(client,'analyticsReportResults',json_data)
+
+	    	check_and_parse_response(response)
+
+		end
+
+
+		private
+
+		def convert_to_json(s)
+			json_data = {}
+			check_for_id_and_name(s)
+			s.instance_variables.each do|iv|
+				key = iv.to_s.gsub("@",'')
+				value = instance_variable_get iv
+				json_data[key] = value unless value.nil?
+			end
+			json_data
+		end
+
+		def check_for_id_and_name(s)
+			if s.lookupName.nil? && s.id.nil?
+				raise ArgumentError, "AnalyticsReportResults must have an id or lookupName set"
+			end
+		end
+
+		def check_and_parse_response(response)
+			if response.code.to_i != 200
+				puts JSON.pretty_generate(response.body)
+				response.body
+			else
+				body = JSON.parse(response.body)
+				final_json = []
+				body['rows'].each_with_index do |r,j|
+					
+					hash = {}
+					
+					body['columnNames'].each_with_index do |cn,i|
+						hash[cn] = if !r[i].nil? && r[i].is_i? == true then r[i].to_i else r[i] end
+					end
+					
+					final_json << hash
+				end 
+				final_json
+			end
+		end
+
+	end
+
+end

data/lib/osc_ruby/version.rb

@@ -1,3 +1,3 @@
 module OSCRuby
-  VERSION = "1.2.0"
+  VERSION = "1.2.1"
 end

data/spec/core/analytics_report_results_spec.rb

@@ -0,0 +1,86 @@
+require 'core/spec_helper'
+require 'json'
+require 'uri'
+
+describe OSCRuby::AnalyticsReportResults do
+
+	let(:client) { 
+
+		OSCRuby::Client.new do |config|
+		
+			config.interface = ENV['OSC_SITE']
+		
+			config.username = ENV['OSC_ADMIN']
+		
+			config.password = ENV['OSC_PASSWORD']
+
+			config.demo_site = true
+		
+		end
+	}
+
+	let(:last_updated){
+		OSCRuby::AnalyticsReportResults.new(lookupName: "Last Updated By Status")
+	}
+
+	let(:answers_search){
+		OSCRuby::AnalyticsReportResults.new(id: 176)
+	}
+
+	let(:error_example){
+		OSCRuby::AnalyticsReportResults.new
+	}
+
+
+	context "#initialize" do
+
+		it "should expect an id or a lookupName for a report" do
+			
+			expect(last_updated).to be_an(OSCRuby::AnalyticsReportResults)
+
+			expect(last_updated.lookupName).to eq("Last Updated By Status")
+
+			expect(answers_search).to be_an(OSCRuby::AnalyticsReportResults)
+
+			expect(answers_search.id).to eq(176)
+		
+		end
+
+
+				
+	end
+
+	context "#run" do
+		it 'should expect client is an instance of OSCRuby::Client class and raise an error if does not' do
+
+			expect(client).to be_an(OSCRuby::Client)
+
+			client = nil
+
+			expect{answers_search.run(client)}.to raise_error('Client must have some configuration set; please create an instance of OSCRuby::Client with configuration settings')
+
+		end
+
+		it 'should throw an error if there is no id or no lookupName assigned',:vcr do
+			expect{error_example.run(client)}.to raise_error('AnalyticsReportResults must have an id or lookupName set')
+			error_example.id = 176
+			expect(error_example.run(client)).to be_an(Array)
+		end
+
+		it 'should be able to take filters', :vcr do
+			keywords = arrf(name: "search_ex", values: "Maestro")
+			answers_search.filters << keywords
+
+			answers = answers_search.run(client)
+
+			answers.each do |answer|
+
+				expect(answer['Summary']).to be_a(String)
+				expect(answer['Answer ID']).to be_a(Fixnum)
+			end			
+
+		end
+
+	end
+
+end	

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: osc_ruby
 version: !ruby/object:Gem::Version
-  version: 1.2.0
+  version: 1.2.1
 platform: ruby
 authors:
 - Rajan Davis
@@ -159,6 +159,7 @@ files:
 - Rakefile
 - lib/ext/string.rb
 - lib/osc_ruby.rb
+- lib/osc_ruby/classes/analytics_report_results.rb
 - lib/osc_ruby/classes/query_results.rb
 - lib/osc_ruby/classes/query_results_set.rb
 - lib/osc_ruby/client.rb
@@ -169,6 +170,7 @@ files:
 - lib/osc_ruby/modules/validations_module.rb
 - lib/osc_ruby/version.rb
 - osc_ruby.gemspec
+- spec/core/analytics_report_results_spec.rb
 - spec/core/client_spec.rb
 - spec/core/configuration_spec.rb
 - spec/core/connect_spec.rb
@@ -201,6 +203,7 @@ signing_key:
 specification_version: 4
 summary: Making the best of opensource and enterprise technology
 test_files:
+- spec/core/analytics_report_results_spec.rb
 - spec/core/client_spec.rb
 - spec/core/configuration_spec.rb
 - spec/core/connect_spec.rb