osc_ruby 0.1.13 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 3886686a1a45880611a4e06689c3c4ae573a3f30
-  data.tar.gz: 276a472588a6495a688103ac8756184c03b60904
+  metadata.gz: 0262af3d710018528271b39304094ca53663c9e2
+  data.tar.gz: 1c7000c6df53b2bc4dfa45a6e65ff0356f182246
 SHA512:
-  metadata.gz: f9cd46f98226b08627060983f4d16bd722a05048bb06f9c0bb135a16743c4e68c6e5dfc2a6538e703d8fee299158a7694b256388ab78ad309931684d7cd3103b
-  data.tar.gz: a940df9e72dda18074ab014b1be6b490044bfe3a6aa141fe142e5a1af8206fc33fd5f69428b6a4d1dfd733d30d81ee59bf39b634a474d70d71d18db15815238c
+  metadata.gz: ab15d881832e339d67857eec0129bb5416b79f8822c8f5d7fad3b0b4998db89d300da41337cbf311b0432edd23949ea8caa46b90cacf2e013e96b89e419ef77c
+  data.tar.gz: be2146f1137e001348c636dab826f08c8a3d4963e0da2392a52e993394ae8958085dc6d20ed3be68f9f5968428d6c017a1f5319ecee02d9b0e3e6b24a0b976dc

data/.gitignore

@@ -6,6 +6,7 @@
 /doc/
 /pkg/
 /spec/reports/
+/spec/fixtures/
 /tmp/
 *.bundle
 *.so

data/Gemfile

@@ -1,10 +1,4 @@
 source 'https://rubygems.org'
 
 # Specify your gem's dependencies in osc_ruby.gemspec
-gemspec
-
-group :test do
-	gem 'rspec'
-	gem "simplecov"
-  	gem "codeclimate-test-reporter", "~> 1.0.0"
-end
+gemspec

data/README.md

@@ -4,131 +4,166 @@
 
 An (under development) Ruby ORM for using Oracle Service Cloud influenced by the [ConnectPHP API](http://documentation.custhelp.com/euf/assets/devdocs/november2016/Connect_PHP/Default.htm) and ActiveRecord Gem
 
-## Example (still coding this out, but trying to get this pretty simple)
+
+## Compatibility
+
+This gem was tested against Oracle Service Cloud November 2016 using Ruby version 2.1.2p95 (2014-05-08 revision 45877) [x86_64-darwin13.0]. Additionally,
+[TravisCI](https://travis-ci.org/rajangdavis/osc_ruby) tests against Ruby version 2.2.0 as well as jruby version 1.7.19
+
+The create, update, and destroy methods should work on any version of Oracle Service Cloud since version May 2015; however, there maybe some issues with querying items on any version before November 2016. This is because I am using the ROQL queries to generate values for Common Objects
+
+Currently supporting the following objects:
+
+**ServiceProduct**
+**Answer** (only new, create, and find methods supported as of 1/11)
+
+At this time, subclasses such as ServiceProduct.CategoryLinks are not currently supported. 
+
+I am trying to build a few more classes and have a pretty solid testing suite and codebase before implementing this functionality.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'osc_ruby'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install osc_ruby
+
+
+## ServiceProduct Example
 ```ruby
-	# Configuration is as simple as requiring the gem
-	# and adding a config block (Completed 12/2016)
 
-	require 'osc_ruby'
+# Configuration is as simple as requiring the gem
+# and adding a config block (Completed 12/2016)
 
-	rn_client = OSCRuby::Client.new do |config|
-		config.username = ENV['OSC_ADMIN']
-		config.password = ENV['OSC_PASSWORD']
-		config.interface = ENV['OSC_TEST_SITE']
-	end
+require 'osc_ruby'
 
+rn_client = OSCRuby::Client.new do |config|
+	config.username = ENV['OSC_ADMIN']
+	config.password = ENV['OSC_PASSWORD']
+	config.interface = ENV['OSC_TEST_SITE']
+end
 
-	# ServiceProduct Creation example (Completed 12/30/2016)
 
-	new_product = OSCRuby::ServiceProduct.new
+# ServiceProduct Creation example (Completed 12/30/2016)
 
-	# use Ruby hashes to set field information
+new_product = OSCRuby::ServiceProduct.new
 
-	new_product.names[0] = {'labelText' => 'QTH45-test', 'language' => {'id' => 1}}
-	new_product.names[1] = {'labelText' => 'QTH45-test', 'language' => {'id' => 11}}
+# use Ruby hashes to set field information
 
-	new_product.parent = {'id' => 102}
+new_product.names[0] = {'labelText' => 'QTH45-test', 'language' => {'id' => 1}}
+new_product.names[1] = {'labelText' => 'QTH45-test', 'language' => {'id' => 11}}
 
-	new_product.displayOrder = 4
+new_product.parent = {'id' => 102}
 
-	new_product.adminVisibleInterfaces[0] = {'id' => 1}
+new_product.displayOrder = 4
 
-	new_product.endUserVisibleInterfaces[0] = {'id' => 1}
+new_product.adminVisibleInterfaces[0] = {'id' => 1}
 
-	new_product.create(rn_client)
+new_product.endUserVisibleInterfaces[0] = {'id' => 1}
 
-	# callback with JSON details
+new_product.create(rn_client)
 
+# callback with JSON details
 
 
 
-	# NOTE: Make sure that in a production environment
-	# that the following methods are wrapped in a begin/rescue block.
 
-	# If a null set is returned by your query
-	# an exception will be raised
-	# this is to ensure that you 
-	# handle your errors explicitly
-	# when writing scripts
+# NOTE: Make sure that in a production environment
+# that the following methods are wrapped in a begin/rescue block.
 
+# If a null set is returned by your query
+# an exception will be raised
+# this is to ensure that you 
+# handle your errors explicitly
+# when writing scripts
 
-	# ServiceProduct fetch example (Completed 12/28/2016)
 
-	product = OSCRuby::ServiceProduct.find(rn_client,100)
+# ServiceProduct fetch example (Completed 12/28/2016)
 
-	puts product
-	# => #<ServiceProduct:0x007fd0fa87e588>
+product = OSCRuby::ServiceProduct.find(rn_client,100)
 
-	puts product.name
-	# => QR404
+puts product
+# => #<ServiceProduct:0x007fd0fa87e588>
 
-	puts product.displayOrder
-	# => 3
+puts product.name
+# => QR404
 
-	# ServiceProduct fetch all example (Completed 01/05/2017)
+puts product.displayOrder
+# => 3
 
-	products = OSCRuby::ServiceProduct.all(rn_client)
+# ServiceProduct fetch all example (Completed 01/05/2017)
 
-	products.each do |p|
+products = OSCRuby::ServiceProduct.all(rn_client)
 
-		puts p.name
+products.each do |p|
 
-	end
+	puts p.name
 
-	# => Unsure
-	# => DVR/NVR
-	# => QC Series
-	# => QR Series
-	# => QR404
-	# => QS Series
-	# => QT Series
+end
 
+# => Unsure
+# => DVR/NVR
+# => QC Series
+# => QR Series
+# => QR404
+# => QS Series
+# => QT Series
 
-	# ServiceProduct where example (Completed 01/05/2017) 
 
-	# NOTE: Make sure to put your queries wrapped in doublequotes("")
-	# this is because when Ruby converts the queries into a URI
-	# the REST API does not like it when the queries are wrapped in single quotes ('')
-	# with strings escaped by double quotes
+# ServiceProduct where example (Completed 01/05/2017) 
 
-	# For example
-	# "parent is null and lookupName!='Unsure'" => great!
-	# 'parent is null and lookupName!="Unsure"' => don't do this
-	# it will spit back an error from the REST API!
+# NOTE: Make sure to put your queries wrapped in doublequotes("")
+# this is because when Ruby converts the queries into a URI
+# the REST API does not like it when the queries are wrapped in single quotes ('')
+# with strings escaped by double quotes
 
-	products_lvl_1 = OSCRuby::ServiceProduct.where(rn_client,"parent is null and lookupName!='Unsure'")
+# For example
+# "parent is null and lookupName!='Unsure'" => great!
+# 'parent is null and lookupName!="Unsure"' => don't do this
+# it will spit back an error from the REST API!
 
-	products_lvl_1.each do |p|
+products_lvl_1 = OSCRuby::ServiceProduct.where(rn_client,"parent is null and lookupName!='Unsure'")
 
-		puts p.name
+products_lvl_1.each do |p|
 
-	end
+	puts p.name
 
-	# => DVR/NVR
-	# => Cameras
-	# => Accessories
+end
 
+# => DVR/NVR
+# => Cameras
+# => Accessories
 
-	# ServiceProduct update example (Completed 01/05/2017)
 
-	product_to_update = OSCRuby::ServiceProduct.find(rn_client,100)
+# ServiceProduct update example (Completed 01/05/2017)
 
-	product_to_update.names[0] = {'labelText' => 'name-updated', 'language' => {'id' => 1}}
+product_to_update = OSCRuby::ServiceProduct.find(rn_client,100)
 
-	product_to_update.update(rn_client)
+product_to_update.names[0] = {'labelText' => 'name-updated', 'language' => {'id' => 1}}
 
-	# ServiceProduct updated
+product_to_update.update(rn_client)
 
+# ServiceProduct updated
 
 
 
-	# ServiceProduct destroy example
 
-	product_to_delete = OSCRuby::ServiceProduct.find(rn_client,100)
+# ServiceProduct destroy example (Completed 01/06/2017)
 
-	product_to_delete.destroy(rn_client)
+product_to_delete = OSCRuby::ServiceProduct.find(rn_client,100)
 
-	# ServiceProduct destroyed
+product_to_delete.destroy(rn_client)
+
+# ServiceProduct destroyed
 ```
 
 ## To do list
@@ -169,54 +204,28 @@ An (under development) Ruby ORM for using Oracle Service Cloud influenced by the
 
 - [x] Build a QueryModule Module with the following query methods to be shared between most if not all classes:
 
-- [x] create
-	
-- [x] find
-		
-- [x] where
-	
-- [x] all
-
-- [x] update
-
-- [ ] destroy
+- [x] create, find, where, all, update, destroy
 
 - [x] QueryModule converts JSON response into a Ruby Hash => new instance of the object being queried
 
 - [x] Create some validations for creating a ServiceProduct object
 
-- [ ] Make OpenSSL::SSL::VERIFY_PEER the default with OpenSSL::SSL::VERIFY_NONE option set in the config class 
+- [x] Add in VCR and WebMock as dependencies
 
-- [ ] Make version default to 1.3 but an option to be set in the config class
+- [x] Figure out how to record and stub responses for a good response and bad response
 
-- [ ] Allow for the prefer:exclude-null-properties header => update config and connect class, update tests
+- [x] Simulate these responses for ALL Connect HTTP methods
 
-- [ ] Allow for Session Authorization => update config class and connect classes, update tests
+- [x] Make OpenSSL::SSL::VERIFY_PEER the default with OpenSSL::SSL::VERIFY_NONE option set in the config class 
 
-- [ ] Figure out how to do RDoc/Yardoc documentation or best in class documentation for using this Ruby ORM
+- [x] Make version default to 1.3 but an option to be set in the config class
 
-- [ ] Add in VCR and WebMock as dependencies
+- [ ] Allow for the prefer:exclude-null-properties header => update config and connect class, update tests
 
-- [ ] Figure out how to record and stub responses for a good response and bad response
+- [ ] Allow for Session Authorization => update config class and connect classes, update tests
 
-- [ ] Simulate these responses for ALL Connect HTTP methods
+- [ ] Figure out how to do RDoc/Yardoc documentation or best in class documentation for using this Ruby ORM
 
 - [ ] Follow with next Classes (ServiceCategories, Answers, Incidents)
 
-- [ ] Release MVP
-
-## Installation
-
-Add this line to your application's Gemfile:
-
-```ruby
-gem 'osc_ruby'
-```
-
-And then execute:
-
-    $ bundle
-
-Or install it yourself as:
-
-    $ gem install osc_ruby
+- [ ] Release MVP

data/lib/osc_ruby.rb

@@ -2,4 +2,5 @@ module OSCRuby; end
 
 require 'osc_ruby/client'
 require 'osc_ruby/connect'
-require 'osc_ruby/service_product'
+require 'osc_ruby/service_product'
+require 'osc_ruby/answer'

data/lib/osc_ruby/answer.rb

@@ -0,0 +1,169 @@
+require 'osc_ruby/client'
+require 'osc_ruby/query_module'
+require 'osc_ruby/validations_module'
+require 'osc_ruby/class_factory_module'
+require 'json'
+require 'uri'
+
+module OSCRuby
+	
+	class Answer
+
+		include QueryModule
+		include ValidationsModule
+		include ClassFactoryModule
+		
+		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
+
+	    def initialize(attributes = nil)
+
+			if attributes.nil?
+
+   				@answerType = {}
+   				@summary = "Answer summary text"
+   				@language = {}
+   				@question = nil
+
+			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
+
+	    def create(client,return_json = false)
+
+			ClassFactoryModule.create(client,self,"/answers",return_json)
+
+	    end
+
+
+	    def self.find(client,id = nil,return_json = false)
+
+	    	ClassFactoryModule.find(client,id,'answers',return_json,OSCRuby::Answer)
+
+	    end
+
+
+	    def self.all(client, return_json = false)
+
+	    	ClassFactoryModule.all(client,'answers',return_json,OSCRuby::Answer)
+
+	    end
+
+	    def self.where(client, query = '', return_json = false)
+
+	    	ClassFactoryModule.where(client,query,'answers',return_json,OSCRuby::Answer)
+
+	    end
+
+	    def update(client, return_json = false)
+
+	    	ClassFactoryModule::update(client,self,"answers",return_json)
+
+	    end
+
+	    def destroy(client, return_json = false)
+
+	    	ClassFactoryModule.destroy(client,self,'answers',return_json)
+
+	    end
+
+
+
+
+
+
+
+
+
+
+
+	    # Convenience Methods for making the CRUD operations nicer to use
+
+		def set_attributes(response_body)
+	    	self.id = response_body['id'].to_i
+			self.lookupName = response_body['lookupName'].to_i
+			self.createdTime = response_body['createdTime']
+			self.updatedTime = response_body['updatedTime']
+			self.accessLevels = response_body['accessLevels']
+			self.adminLastAccessTime = response_body['adminLastAccessTime']
+			self.answerType = response_body['answerType']
+			self.expiresDate = response_body['expiresDate']
+			self.guidedAssistance = response_body['guidedAssistance']
+			self.keywords = response_body['keywords']
+			self.language = response_body['language']
+			self.lastAccessTime = response_body['lastAccessTime']
+			self.lastNotificationTime = response_body['lastNotificationTime']
+			self.name = response_body['name'].to_i
+			self.nextNotificationTime = response_body['nextNotificationTime']
+			self.originalReferenceNumber = response_body['originalReferenceNumber']
+			self.positionInList = response_body['positionInList']
+			self.publishOnDate = response_body['publishOnDate']
+			self.question = response_body['question']
+			self.solution = response_body['solution']
+			self.summary = response_body['summary']
+			self.updatedByAccount = response_body['updatedByAccount']
+			self.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