osc_ruby 0.7.1 → 1.0.2

data/spec/core/query_results_spec.rb

@@ -1,134 +1,108 @@
-require 'core/spec_helper'
-require 'json'
-require 'uri'
-
-describe OSCRuby::QueryResults do
-
-	let(:client) { 
-
-		OSCRuby::Client.new do |config|
-		
-			config.interface = ENV['OSC_TEST1_SITE']
-		
-			config.username = ENV['OSC_ADMIN']
-		
-			config.password = ENV['OSC_PASSWORD']
-		
-		end
-	}
-
-	let(:query_results){
-		OSCRuby::QueryResults.new
-	}
-
-
-
-	let(:table){ "answers" } 
-	let(:nested_attributes){
- 		[ "*",
-		  "accessLevels.namedIDList.*",
-		  "answerType.*",
-		  "assignedTo.account.*",
-		  "assignedTo.staffGroup.*",
-		  "banner.*",
-		  "banner.importanceFlag.*",
-		  "banner.updatedByAccount.*",
-		  "categories.categoriesList.*",
-		  "commonAttachments.fileAttachmentList.*",
-		  "commonAttachments.fileAttachmentList.names.labelList.labelText",
-		  "commonAttachments.fileAttachmentList.names.labelList.language.*",
-		  "fileAttachments.fileAttachmentList.*",
-		  "guidedAssistance.*",
-		  "language.*",
-		  "notes.noteList.*",
-		  "positionInList.*",
-		  "products.productsList.*",
-		  "relatedAnswers.answerRelatedAnswerList.*",
-		  "relatedAnswers.answerRelatedAnswerList.toAnswer.*",
-		  "siblingAnswers.*",
-		  "statusWithType.statusType.*",
-		  "updatedByAccount.*",
-		  "customFields.c.*"
-		]
-	}
-
-
-	context "#query" 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{query_results.query(client,'describe')}.to raise_error('Client must have some configuration set; please create an instance of OSCRuby::Client with configuration settings')
-
-		end
-
-		it 'should expect a query' do
-
-			expect(client).to be_an(OSCRuby::Client)
-
-			expect{query_results.query(client,"")}.to raise_error("A query must be specified when using the 'query' method")
-
-		end
-
-		it 'should put results in array of hashes',:vcr do 
-
-			# expect(query_results.query(client,"describe")).not_to eq(nil)
-
-			expect(query_results.query(client,"describe")).to be_an(Array)
-
-			# expect(query_results.query(client,"describe answers")).not_to eq(nil)
-
-			expect(query_results.query(client,"describe answers;describe serviceproducts",true)).to be_an(Array)
-
-			# expect(query_results.query(client,"describe answers;describe servicecategories")).not_to eq(nil)
-
-			expect(query_results.query(client,"describe answers;describe servicecategories")).to be_an(Array)
-
-		end
-
-		it 'should be able to manipulate and assign results data',:vcr do 
-
-			@answers = query_results.query(client,"select * from answers where ID > 2500")
-
-			@answers.each do |answer|
-
-				expect(answer['id'].to_i).to be_a(Integer)
-
-				expect(answer['answerType']).not_to be(nil)
-
-				expect(answer['answerType']).not_to eq("\n")
-
-				expect{@answer = OSCRuby::Answer.new(answer)}.not_to raise_error
-
-			end 
-
-		end
-
-		context "#nested_query" do
-
-			it 'should take nested queries and return multiple objects',:vcr do
-
-				query = nested_attributes.map{|q| "select #{table}.#{q} from #{table} where ID = 2222" }.join("; ")
-
-
-				expect do
-					
-					results = query_results.nested_query(client,query,true)
-					expect(results.length).to eq(nested_attributes.length)
-
-					puts "Results : #{results.length} | Queries: #{nested_attributes.length}"
-
-				end.not_to raise_error
-
-
-				
-			end
-
-		end
-		
-	end
-
+require 'core/spec_helper'
+require 'json'
+require 'uri'
+
+describe OSCRuby::QueryResults 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(:query_results){
+		OSCRuby::QueryResults.new
+	}
+
+
+
+	let(:table){ "answers" } 
+	let(:nested_attributes){
+ 		[ "*",
+		  "accessLevels.namedIDList.*",
+		  "answerType.*",
+		  "assignedTo.account.*",
+		  "assignedTo.staffGroup.*",
+		  "banner.*",
+		  "banner.importanceFlag.*",
+		  "banner.updatedByAccount.*",
+		  "categories.categoriesList.*",
+		  "commonAttachments.fileAttachmentList.*",
+		  "commonAttachments.fileAttachmentList.names.labelList.labelText",
+		  "commonAttachments.fileAttachmentList.names.labelList.language.*",
+		  "fileAttachments.fileAttachmentList.*",
+		  "guidedAssistance.*",
+		  "language.*",
+		  "notes.noteList.*",
+		  "positionInList.*",
+		  "products.productsList.*",
+		  "relatedAnswers.answerRelatedAnswerList.*",
+		  "relatedAnswers.answerRelatedAnswerList.toAnswer.*",
+		  "siblingAnswers.*",
+		  "statusWithType.statusType.*",
+		  "updatedByAccount.*",
+		  "customFields.c.*"
+		]
+	}
+
+
+	context "#query" 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{query_results.query(client,'describe')}.to raise_error('Client must have some configuration set; please create an instance of OSCRuby::Client with configuration settings')
+
+		end
+
+		it 'should expect a query' do
+
+			expect(client).to be_an(OSCRuby::Client)
+
+			expect{query_results.query(client,"")}.to raise_error("A query must be specified when using the 'query' method")
+
+		end
+
+		it 'should put results in array of hashes',:vcr do 
+
+			# expect(query_results.query(client,"describe")).not_to eq(nil)
+
+			expect(query_results.query(client,"describe")).to be_an(Array)
+
+			# expect(query_results.query(client,"describe answers")).not_to eq(nil)
+
+			expect(query_results.query(client,"describe answers;describe serviceproducts",true)).to be_an(Array)
+
+			# expect(query_results.query(client,"describe answers;describe servicecategories")).not_to eq(nil)
+
+			expect(query_results.query(client,"describe answers;describe servicecategories")).to be_an(Array)
+
+		end
+
+		it 'should be able to manipulate and assign results data',:vcr do 
+
+			@incidents = query_results.query(client,"select * from incidents where ID > 2500 LIMIT 10")
+
+			@incidents.each do |incident|
+
+				expect(incident['id'].to_i).to be_a(Integer)
+
+			end 
+
+		end
+		
+	end
+
 end	

data/spec/core/spec_helper.rb

@@ -1,26 +1,26 @@
-require 'osc_ruby'
-require 'simplecov'
-require 'vcr'
-require 'json'
-
-VCR.configure do |c|
-	c.cassette_library_dir = "spec/fixtures"
-	c.hook_into :fakeweb
-	c.allow_http_connections_when_no_cassette = true
-	c.filter_sensitive_data('<OSC_ADMIN_USERNAME>') { ENV['OSC_ADMIN'] }
-	c.filter_sensitive_data('<OSC_ADMIN_PASSWORD>') { ENV['OSC_PASSWORD'] }
-	c.filter_sensitive_data('<TEST_INTERFACE>') { ENV['OSC_TEST1_SITE'] }
-	c.filter_sensitive_data('<BASIC_AUTH>') { ENV['OSC_BASIC_64'] } 
-end
-
-RSpec.configure do |c|
-  c.around(:each, :vcr) do |example|
-    class_name = example.metadata[:described_class].to_s.gsub(/OSCRuby::/,'').downcase
-    method_name = example.metadata[:example_group][:description_args][0].gsub(/#/,'')
-    test_name = example.metadata[:description].gsub(/ /,'_').downcase
-    name = [class_name,method_name,test_name].join('/')[0...95]
-    VCR.use_cassette(name) { example.call }
-  end
-end
-
+require 'osc_ruby'
+require 'simplecov'
+require 'vcr'
+require 'json'
+
+VCR.configure do |c|
+	c.cassette_library_dir = "spec/fixtures"
+	c.hook_into :fakeweb
+	c.allow_http_connections_when_no_cassette = true
+	c.filter_sensitive_data('<OSC_ADMIN_USERNAME>') { ENV['OSC_ADMIN'] }
+	c.filter_sensitive_data('<OSC_ADMIN_PASSWORD>') { ENV['OSC_PASSWORD'] }
+	c.filter_sensitive_data('<TEST_INTERFACE>') { ENV['OSC_TEST1_SITE'] }
+	c.filter_sensitive_data('<BASIC_AUTH>') { ENV['OSC_BASIC_64'] } 
+end
+
+RSpec.configure do |c|
+  c.around(:each, :vcr) do |example|
+    class_name = example.metadata[:described_class].to_s.gsub(/OSCRuby::/,'').downcase
+    method_name = example.metadata[:example_group][:description_args][0].gsub(/#/,'')
+    test_name = example.metadata[:description].gsub(/ /,'_').downcase
+    name = [class_name,method_name,test_name].join('/')[0...95]
+    VCR.use_cassette(name) { example.call }
+  end
+end
+
 SimpleCov.start

data/tasks/rspec.rake

@@ -1,3 +1,3 @@
-require 'rspec/core/rake_task'
-
+require 'rspec/core/rake_task'
+
 RSpec::Core::RakeTask.new(:spec)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: osc_ruby
 version: !ruby/object:Gem::Version
-  version: 0.7.1
+  version: 1.0.2
 platform: ruby
 authors:
 - Rajan Davis
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-06-14 00:00:00.000000000 Z
+date: 2017-08-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: simplecov
@@ -29,6 +29,9 @@ dependencies:
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+    - - ">="
       - !ruby/object:Gem::Version
         version: 1.0.0
   type: :development
@@ -36,6 +39,9 @@ dependencies:
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+    - - ">="
       - !ruby/object:Gem::Version
         version: 1.0.0
 - !ruby/object:Gem::Dependency
@@ -71,6 +77,9 @@ dependencies:
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.2'
+    - - ">="
       - !ruby/object:Gem::Version
         version: 3.2.0
   type: :development
@@ -78,6 +87,9 @@ dependencies:
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.2'
+    - - ">="
       - !ruby/object:Gem::Version
         version: 3.2.0
 - !ruby/object:Gem::Dependency
@@ -85,6 +97,9 @@ dependencies:
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+    - - ">="
       - !ruby/object:Gem::Version
         version: 3.0.3
   type: :development
@@ -92,6 +107,9 @@ dependencies:
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+    - - ">="
       - !ruby/object:Gem::Version
         version: 3.0.3
 - !ruby/object:Gem::Dependency
@@ -115,7 +133,7 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-  type: :runtime
+  type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
@@ -136,37 +154,24 @@ files:
 - ".rubocop.yml"
 - ".travis.yml"
 - Gemfile
-- LICENSE.txt
+- License.txt
 - README.md
 - Rakefile
 - lib/ext/string.rb
 - lib/osc_ruby.rb
-- lib/osc_ruby/classes/account.rb
-- lib/osc_ruby/classes/answer.rb
-- lib/osc_ruby/classes/incident.rb
-- lib/osc_ruby/classes/product_category_shared.rb
 - lib/osc_ruby/classes/query_results.rb
-- lib/osc_ruby/classes/service_category.rb
-- lib/osc_ruby/classes/service_class.rb
-- lib/osc_ruby/classes/service_product.rb
 - lib/osc_ruby/client.rb
 - lib/osc_ruby/configuration.rb
 - lib/osc_ruby/connect.rb
-- lib/osc_ruby/modules/class_factory_module.rb
-- lib/osc_ruby/modules/nested_resource_module.rb
 - lib/osc_ruby/modules/normalize_module.rb
 - lib/osc_ruby/modules/query_module.rb
 - lib/osc_ruby/modules/validations_module.rb
 - lib/osc_ruby/version.rb
 - osc_ruby.gemspec
-- spec/core/account_spec.rb
-- spec/core/answer_spec.rb
 - spec/core/client_spec.rb
 - spec/core/configuration_spec.rb
 - spec/core/connect_spec.rb
 - spec/core/query_results_spec.rb
-- spec/core/service_category_spec.rb
-- spec/core/service_product_spec.rb
 - spec/core/spec_helper.rb
 - tasks/rspec.rake
 homepage: https://github.com/rajangdavis/osc_ruby
@@ -189,17 +194,13 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.8
+rubygems_version: 2.6.12
 signing_key: 
 specification_version: 4
 summary: Making the best of opensource and enterprise technology
 test_files:
-- spec/core/account_spec.rb
-- spec/core/answer_spec.rb
 - spec/core/client_spec.rb
 - spec/core/configuration_spec.rb
 - spec/core/connect_spec.rb
 - spec/core/query_results_spec.rb
-- spec/core/service_category_spec.rb
-- spec/core/service_product_spec.rb
 - spec/core/spec_helper.rb

data/LICENSE.txt

@@ -1,22 +0,0 @@
-Copyright (c) 2016 rajangdavis
-
-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/lib/osc_ruby/classes/account.rb

@@ -1,75 +0,0 @@
-module OSCRuby
-
-	class Account < ServiceClass
-
-		attr_accessor :displayName,:login,:name,:nameFurigana,:attributes,:profile,:name,:staffGroup,:newPassword,:country,:emails
-
-	    def initialize(attributes = nil)
-
-	    	@displayName = 'Display Name'
-	    	@login = 'Login'
-	    	@name = {}
-	    	@nameFurigana = {}
-	    	@attributes = {}
-	    	@profile = {}
-	    	@name = {}
-	    	@staffGroup = {}
-	    	@newPassword = 'default_password'
-	    	@country = {}
-	    	@emails = []
-
-	    end
-
-	    # Convenience Methods for making the CRUD operations nicer to use
-
-		def set_attributes(response_body)
-
-			self.id = response_body["id"]
-
-    		self.name = response_body["lookupName"]
-
-    		self.lookupName = response_body["lookupName"]
-
-			self.displayOrder = response_body["displayOrder"]
-
-		end
-
-		def update_attributes(updated_product)
-
-			self.lookupName = updated_product.lookupName
-
-			self.createdTime = updated_product.createdTime
-
-			self.updatedTime = updated_product.updatedTime
-
-			self.name = updated_product.name
-
-			self.parent = updated_product.parent
-
-		end
-
-		def self.check_self(obj,is_update = false)
-
-			class_name = self.to_s.split('::')[1]
-
-			obj_attrs = ValidationsModule::extract_attributes(obj)
-
-			# if is_update == true
-			
-			# 	obj_attrs = remove_unused_new_attrs(obj_attrs)
-			
-			# else
-
-			# 	obj_attrs = ValidationsModule::check_for_names(obj_attrs,class_name)
-
-			# 	obj_attrs = ValidationsModule::check_for_parents(obj_attrs)
-				
-			# end
-
-			obj_attrs
-
-		end
-
-	end
-	
-end

data/lib/osc_ruby/classes/answer.rb

@@ -1,117 +0,0 @@
-require 'osc_ruby/modules/nested_resource_module'
-
-module OSCRuby
-	
-	class Answer < ServiceClass
-		include NestedResourceModule
-		
-		attr_accessor :answerType, :language, :summary, :id, :lookupName, :createdTime, :updatedTime, :accessLevels, :name, :adminLastAccessTime, :expiresDate, :guidedAssistance, :keywords, :lastAccessTime, :lastNotificationTime, :nextNotificationTime, :originalReferenceNumber, :positionInList,
-			:publishOnDate, :question, :solution, :updatedByAccount, :uRL, :categories
-
-	    def initialize(attributes = nil)
-
-			if attributes.nil?
-
-   				@answerType = {}
-   				@accessLevels = []
-   				@summary = "Answer summary text"
-   				@language = {}
-   				@question = nil
-   				@categories = []
-   				@id = 0
-
-			else
-
-				@id = attributes["id"]
-				@lookupName = attributes["lookupName"]
-				@createdTime = attributes["createdTime"]
-				@updatedTime = attributes["updatedTime"]
-				@accessLevels = attributes["accessLevels"]
-				@name = attributes["name"]
-				@adminLastAccessTime = attributes["adminLastAccessTime"]
-				@answerType = attributes["answerType"]
-				@expiresDate = attributes["expiresDate"]
-				@guidedAssistance = attributes["guidedAssistance"]
-				@keywords = attributes["keywords"]
-				@language = attributes["language"]
-				@lastAccessTime = attributes["lastAccessTime"]
-				@lastNotificationTime = attributes["lastNotificationTime"]
-				@nextNotificationTime = attributes["nextNotificationTime"]
-				@originalReferenceNumber = attributes["originalReferenceNumber"]
-				@positionInList = attributes["positionInList"]
-				@publishOnDate = attributes["publishOnDate"]
-				@question = attributes["question"]
-				@solution = attributes["solution"]
-				@summary = attributes["summary"]
-				@updatedByAccount = attributes["updatedByAccount"]
-				@uRL = attributes["uRL"]
-
-			end
-
-	    end
-
-
-	    # Convenience Methods for making the CRUD operations nicer to use
-
-		def self.set_attributes(response_body)
-	    	id = response_body['id'].to_i
-			lookupName = response_body['lookupName'].to_i
-			createdTime = response_body['createdTime']
-			updatedTime = response_body['updatedTime']
-			accessLevels = response_body['accessLevels']
-			adminLastAccessTime = response_body['adminLastAccessTime']
-			answerType = response_body['answerType']
-			expiresDate = response_body['expiresDate']
-			guidedAssistance = response_body['guidedAssistance']
-			keywords = response_body['keywords']
-			language = response_body['language']
-			lastAccessTime = response_body['lastAccessTime']
-			lastNotificationTime = response_body['lastNotificationTime']
-			name = response_body['name'].to_i
-			nextNotificationTime = response_body['nextNotificationTime']
-			originalReferenceNumber = response_body['originalReferenceNumber']
-			positionInList = response_body['positionInList']
-			publishOnDate = response_body['publishOnDate']
-			question = response_body['question']
-			solution = response_body['solution']
-			summary = response_body['summary']
-			updatedByAccount = response_body['updatedByAccount']
-			uRL = response_body['uRL']
-		end
-
-		def self.check_self(obj,is_update = false)
-
-			obj_attrs = ValidationsModule::extract_attributes(obj)
-
-			if is_update == false
-
-				obj_attrs = check_for_language_and_type(obj_attrs)
-				
-			end
-
-			obj_attrs
-
-		end
-
-		def self.check_for_language_and_type(obj_attrs)
-
-			if ValidationsModule::attr_hash_exists_and_is_type_of(obj_attrs,'language','id',Fixnum)
-				
-				raise ArgumentError, 'Answer should at least the language, answerType, and summary set (new_answer.language = {"id" => 1}; new_answer.answerType = {"id" => 1}}; new_answer.summary = "This is the Answer Title")'
-			
-			end
-			
-			if ValidationsModule::attr_hash_exists_and_is_type_of(obj_attrs,'answerType','id',Fixnum) && 
-				ValidationsModule::attr_hash_exists_and_is_type_of(obj_attrs,'answerType','lookupName',String)
-				
-				raise ArgumentError, 'Answer should at least the language, answerType, and summary set (new_answer.language = {"id" => 1}; new_answer.answerType = {"id" => 1}}; new_answer.summary = "This is the Answer Title")'
-
-			end
-
-			obj_attrs
-
-		end
-
-	end
-
-end

data/lib/osc_ruby/classes/incident.rb

@@ -1,13 +0,0 @@
-require 'osc_ruby/modules/nested_resource_module'
-
-module OSCRuby
-	
-	class Incident < ServiceClass
-	
-	# TODO BUILD CLASS
-	
-
-
-	end
-
-end