osc_ruby 0.7.1 → 1.0.2

data/.travis.yml

@@ -1,10 +1,10 @@
-language: ruby
-rvm:
-- 2.2.0
-addons:
-  code_climate:
-    repo_token:
-      secure: jhiFV5qK92z9GNZNgifvOmzoYmghcTFcuHYn21B5pkcIFmUJRYL03FK4QHqinFQ4BvjHnKlGTEgRPvglivvPBtIwpGMwuDF0oX0JHeTNLXuAXk8Dd6SAap+udSc2fOZYBg7H8PNmhSVpP97fYu23JsLmhRN8lnoO/yYyFUn/xUZIufOhpPj5RBMtR/XmxXiqS1tnsuHpSs7P+Kp/h6sr8QUOw1pJALEAqHGw2WmdxGrI76GQc0bylLFGMITkCbAiTxVQA3QnjLKFYCHq8zo1U0QZiW78+ubbV22oZS1EVATAb4SyqlqFd2bJA9wYjL2J4tYl1I+RvgVSspMsksHs72uIYHDTNSsEuQTnMCxtkq7WJLbYjRW3Tzbqn124ize/NmJqHcJ70Bc8Tzc3CkgEuJNF/cK266r0UkNTu+m65OTElyic14y+wCzeU8r/aDfX9vQKPBpOFpvHuoWMC54iiGIPjLVZb0AYvI2i3weK2dcCh7ZFD+FsFoMAzyaFFFJP4ANH7R08ewVpTjdud4O8WiQBJOW08dXE9inOF+4hqUho2FdrTWQLvMbanVXOmQXsODeEy7zxFUi1I1wVcX1AktEACmcX2ruose8UiScRu7Tr2R6mhgPa4UAf1YhhBClYafeqtCBi1rRrHkgOkaofhKbU3hHHF5cQwDP2v2jUYEI=
-script: bundle exec rake spec
-after_success:
+language: ruby
+rvm:
+- 2.2.0
+addons:
+  code_climate:
+    repo_token:
+      secure: jhiFV5qK92z9GNZNgifvOmzoYmghcTFcuHYn21B5pkcIFmUJRYL03FK4QHqinFQ4BvjHnKlGTEgRPvglivvPBtIwpGMwuDF0oX0JHeTNLXuAXk8Dd6SAap+udSc2fOZYBg7H8PNmhSVpP97fYu23JsLmhRN8lnoO/yYyFUn/xUZIufOhpPj5RBMtR/XmxXiqS1tnsuHpSs7P+Kp/h6sr8QUOw1pJALEAqHGw2WmdxGrI76GQc0bylLFGMITkCbAiTxVQA3QnjLKFYCHq8zo1U0QZiW78+ubbV22oZS1EVATAb4SyqlqFd2bJA9wYjL2J4tYl1I+RvgVSspMsksHs72uIYHDTNSsEuQTnMCxtkq7WJLbYjRW3Tzbqn124ize/NmJqHcJ70Bc8Tzc3CkgEuJNF/cK266r0UkNTu+m65OTElyic14y+wCzeU8r/aDfX9vQKPBpOFpvHuoWMC54iiGIPjLVZb0AYvI2i3weK2dcCh7ZFD+FsFoMAzyaFFFJP4ANH7R08ewVpTjdud4O8WiQBJOW08dXE9inOF+4hqUho2FdrTWQLvMbanVXOmQXsODeEy7zxFUi1I1wVcX1AktEACmcX2ruose8UiScRu7Tr2R6mhgPa4UAf1YhhBClYafeqtCBi1rRrHkgOkaofhKbU3hHHF5cQwDP2v2jUYEI=
+script: bundle exec rake spec
+after_success:
 - bundle exec codeclimate-test-reporter

data/Gemfile

@@ -1,4 +1,4 @@
-source 'https://rubygems.org'
-
-# Specify your gem's dependencies in osc_ruby.gemspec
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in osc_ruby.gemspec
 gemspec

data/License.txt

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2017 rajangdavis
+
+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/README.md

@@ -1,242 +1,95 @@
-# OSCRuby
-
-[![Code Climate](https://codeclimate.com/github/rajangdavis/osc_ruby/badges/gpa.svg)](https://codeclimate.com/github/rajangdavis/osc_ruby) [![Test Coverage](https://codeclimate.com/github/rajangdavis/osc_ruby/badges/coverage.svg)](https://codeclimate.com/github/rajangdavis/osc_ruby/coverage) [![Build Status](https://travis-ci.org/rajangdavis/osc_ruby.svg?branch=master)](https://travis-ci.org/rajangdavis/osc_ruby) [![Gem Version](https://badge.fury.io/rb/osc_ruby.svg)](https://badge.fury.io/rb/osc_ruby)
-
-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
-
-
-## 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 from the REST API:
-
-	ServiceProduct
-
-	ServiceCategory
-
-	Answer
-
-	QueryResults (does not support CRUD)
-
-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'
-
-rn_client = OSCRuby::Client.new do |config|
-	config.username = ENV['OSC_ADMIN']
-	config.password = ENV['OSC_PASSWORD']
-	config.interface = ENV['OSC_TEST1_SITE']
-end
-
-
-# ServiceProduct Creation example (Completed 12/30/2016)
-
-new_product = OSCRuby::ServiceProduct.new
-
-# use Ruby hashes to set field information
-
-new_product.names[0] = {'labelText' => 'QTH45-test', 'language' => {'id' => 1}}
-new_product.names[1] = {'labelText' => 'QTH45-test', 'language' => {'id' => 11}}
-
-new_product.parent = {'id' => 102}
-
-new_product.displayOrder = 4
-
-new_product.adminVisibleInterfaces[0] = {'id' => 1}
-
-new_product.endUserVisibleInterfaces[0] = {'id' => 1}
-
-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
-
-
-# ServiceProduct fetch example (Completed 12/28/2016)
-
-product = OSCRuby::ServiceProduct.find(rn_client,100)
-
-puts product
-# => #<ServiceProduct:0x007fd0fa87e588>
-
-puts product.name
-# => QR404
-
-puts product.displayOrder
-# => 3
-
-# ServiceProduct fetch all example (Completed 01/05/2017)
-
-products = OSCRuby::ServiceProduct.all(rn_client)
-
-products.each do |p|
-
-	puts p.name
-
-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
-
-# 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 = OSCRuby::ServiceProduct.where(rn_client,"parent is null and lookupName!='Unsure'")
-
-products_lvl_1.each do |p|
-
-	puts p.name
-
-end
-
-# => DVR/NVR
-# => Cameras
-# => Accessories
-
-
-# ServiceProduct update example (Completed 01/05/2017)
-
-product_to_update = OSCRuby::ServiceProduct.find(rn_client,100)
-
-product_to_update.names[0] = {'labelText' => 'name-updated', 'language' => {'id' => 1}}
-
-product_to_update.update(rn_client)
-
-# ServiceProduct updated
-
-
-
-
-# ServiceProduct destroy example (Completed 01/06/2017)
-
-product_to_delete = OSCRuby::ServiceProduct.find(rn_client,100)
-
-product_to_delete.destroy(rn_client)
-
-# ServiceProduct destroyed
-```
-
-## To do list
-
-- [x] Create a URL generator method into the Connect Class
-
-- [x] Move tests for the get method into the URL generator method
-
-- [x] Move check_config method into the URL generator method so that tests pass
-
-- [x] Create more tests to validate the generated URL
-
-- [x] Add in TravisCI into workflow to run tests and push and publish gem
-
-- [x] Add in Code Climate or something to show the percentage of covered methods for testing
-
-- [x] Put the URL generator method into the get class
-
-- [x] Have the get method make a get request using the Net::HTTP class
-
-- [x] Need to add tests for passing resources, query/id/other param into the URL generator class
-
-- [x] Need to figure out how to pass resources and some sort of query/id/other param into the URL generator class
-
-- [x] Add in tests for Post requests
-
-- [x] Make a Post method
-
-- [x] Add in tests for patch requests
-
-- [x] Make a patch method
-
-- [x] Add in tests for delete requests
-
-- [x] Make a delete method
-
-- [x] Create a OSCRuby::ServiceProduct class
-
-- [x] Build a QueryModule Module with the following query methods to be shared between most if not all classes:
-
-- [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
-
-- [x] Add in VCR and WebMock as dependencies
-
-- [x] Figure out how to record and stub responses for a good response and bad response
-
-- [x] Simulate these responses for ALL Connect HTTP methods
-
-- [x] Make OpenSSL::SSL::VERIFY_PEER the default with OpenSSL::SSL::VERIFY_NONE option set in the config class 
-
-- [x] Make version default to 1.3 but an option to be set in the config class
-
-- [x] Need to update QueryResults to split the queries
-
-- [x] Need to update QueryResults to be able to manipulate the results
-
-- [ ] Figure out subclasses
-
-- [ ] Follow with next Classes (Accounts,ServiceCategories, Incidents)
-
-- [ ] Allow for the prefer:exclude-null-properties header => update config and connect class, update tests
-
-- [ ] Allow for Session Authorization => update config class and connect classes, update tests
-
-- [ ] Figure out how to do RDoc/Yardoc documentation or best in class documentation for using this Ruby ORM
-
-- [ ] Release MVP
+# OSCRuby
+
+[![Code Climate](https://codeclimate.com/github/rajangdavis/osc_ruby/badges/gpa.svg)](https://codeclimate.com/github/rajangdavis/osc_ruby) [![Test Coverage](https://codeclimate.com/github/rajangdavis/osc_ruby/badges/coverage.svg)](https://codeclimate.com/github/rajangdavis/osc_ruby/coverage) [![Build Status](https://travis-ci.org/rajangdavis/osc_ruby.svg?branch=master)](https://travis-ci.org/rajangdavis/osc_ruby) [![Gem Version](https://badge.fury.io/rb/osc_ruby.svg)](https://badge.fury.io/rb/osc_ruby)
+
+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
+
+
+## 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 May 2016. This is because ROQL queries were not exposed via the REST API until May 2016.
+
+There is only support for except for ROQL Queries. There is still the capacity to create, read, update, and destroy a Service Cloud object; more on this below.
+
+## 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
+
+require 'osc_ruby'
+
+rn_client = OSCRuby::Client.new do |config|
+	config.username = ENV['OSC_ADMIN']
+	config.password = ENV['OSC_PASSWORD']
+	config.interface = ENV['OSC_SITE']
+end
+
+# use Ruby hashes and arrays to set field information
+
+new_product = {}
+new_product['names'] = []
+new_product['names'][0] = {'labelText' => 'NEW_PRODUCT', 'language' => {'id' => 1}}
+new_product['displayOrder'] = 4
+
+new_product['adminVisibleInterfaces'] = []
+new_product['adminVisibleInterfaces'][0] = {'id' => 1}
+new_product['endUserVisibleInterfaces'] = []
+new_product['endUserVisibleInterfaces'][0] = {'id' => 1}
+
+res = OSCRuby::Connect.post_or_patch(rn_client,'/serviceProducts',new_product)
+
+puts res.code # => 201
+
+puts res.body # => JSON body
+
+# callback with JSON details
+
+
+
+
+# QueryResults example
+# 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
+
+# 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!
+
+rn_client = OSCRuby::Client.new do |config|
+	config.username = ENV['OSC_ADMIN']
+	config.password = ENV['OSC_PASSWORD']
+	config.interface = ENV['OSC_SITE']
+end
+
+q = OSCRuby::QueryResults.new
+
+query = "select * from answers where ID = 1557"
+
+results = q.query(rn_client,query) # => will return an array of results
+
+puts results[0] => "{'id':1557,'name':...}"
+
+```

data/Rakefile

@@ -1,3 +1,3 @@
-require "bundler/gem_tasks"
-
+require "bundler/gem_tasks"
+
 Dir.glob('tasks/**/*.rake').each(&method(:import))

data/lib/ext/string.rb

@@ -1,19 +1,19 @@
-class String
-    def is_i?
-       /\A[-+]?\d+\z/ === self
-    end
-
-	def camel_case_lower
-		@class_to_array = self.split('')
-		@class_name_length = @class_to_array.length - 1
-		@output = @class_to_array.each_with_index do |letter,i|
-			if i ==0
-				letter.downcase!
-			elsif i == @class_name_length
-				letter.gsub!(/y/,'ie')
-			end
-		end.join
-
-		@output + 's'
-	end
+class String
+    def is_i?
+       /\A[-+]?\d+\z/ === self
+    end
+
+	def camel_case_lower
+		@class_to_array = self.split('')
+		@class_name_length = @class_to_array.length - 1
+		@output = @class_to_array.each_with_index do |letter,i|
+			if i ==0
+				letter.downcase!
+			elsif i == @class_name_length
+				letter.gsub!(/y/,'ie')
+			end
+		end.join
+
+		@output + 's'
+	end
 end

data/lib/osc_ruby/classes/query_results.rb

@@ -1,61 +1,41 @@
-require 'osc_ruby/connect'
-require 'osc_ruby/modules/validations_module'
-require 'osc_ruby/modules/normalize_module'
-require 'json'
-
-module OSCRuby
-
-	class QueryResults
-
-		include QueryModule
-		include ValidationsModule
-
-		def initialize; end
-
-		def query(client,query,return_json = false)
-
-			ValidationsModule::check_client(client)
-
-			ValidationsModule::check_query(query,"query")
-
-			@query = URI.escape("queryResults/?query=#{query}")
-
-	    	response = QueryModule::find(client,@query)
-
-	    	json_response = JSON.parse(response) 
-
-	    	json_response.unshift("\n")
-
-	    	if return_json == true
-	    		json_response_final = NormalizeModule::query_injection(query,json_response)
-	    		puts json_response_final
-	    	end
-
-	    	NormalizeModule::remove_new_lines(json_response)
- 
-		end
-
-		def nested_query(client,query,return_json = false)
-
-			ValidationsModule::check_client(client)
-
-			ValidationsModule::check_query(query,"query")
-
-			@query = URI.escape("queryResults/?query=#{query}")
-
-	    	response = QueryModule::nested_find(client,@query)
-
-	    	json_response = JSON.parse(response) 
-
-	    	if return_json == true
-	    		json_response_final = NormalizeModule::query_injection(query,json_response)
-	    		puts json_response_final
-	    	end
-
-	    	NormalizeModule::remove_new_lines(json_response)
- 
-		end
-	
-	end
-
+require 'osc_ruby/connect'
+require 'osc_ruby/modules/validations_module'
+require 'osc_ruby/modules/normalize_module'
+require 'osc_ruby/modules/query_module'
+require 'json'
+
+module OSCRuby
+
+	class QueryResults
+
+		include QueryModule
+		include ValidationsModule
+
+		def initialize; end
+
+		def query(client,query,return_json = false)
+
+			ValidationsModule::check_client(client)
+
+			ValidationsModule::check_query(query,"query")
+
+			@query = URI.escape("queryResults/?query=#{query}")
+
+	    	response = QueryModule::find(client,@query)
+
+	    	json_response = JSON.parse(response) 
+
+	    	json_response.unshift("\n")
+
+	    	if return_json == true
+	    		json_response_final = NormalizeModule::query_injection(query,json_response)
+	    		puts json_response_final
+	    	end
+
+	    	NormalizeModule::remove_new_lines(json_response)
+ 
+		end
+	
+	end
+
 end

data/lib/osc_ruby/client.rb

@@ -1,41 +1,41 @@
-require 'osc_ruby/version'
-require 'osc_ruby/configuration'
-
-
-module OSCRuby
-
-	class Client
-		# The top-level class that handles configuration and connection to the Oracle Service Cloud REST API.
-		
-		attr_accessor :config
-		
-		def initialize
-	        raise ArgumentError, "block not given" unless block_given?
-	        self.config ||= OSCRuby::Configuration.new
-	    	yield(config)
-
-	    	check_config
-	    	optional_check
-		end
-
-	    def check_config
-	    	if config.interface ==''
-	    		raise ArgumentError, "Interface cannot be nil or blank"
-	    	elsif config.username ==''
-	    		raise ArgumentError, "Username cannot be nil or blank"
-	    	elsif config.password ==''
-	    		raise ArgumentError, "Password cannot be nil or blank"
-	    	end
-
-	    	true
-	    end
-
-	    def optional_check
-	    	if config.no_ssl_verify.class != FalseClass && config.no_ssl_verify.class != TrueClass
-	    		raise ArgumentError, "The no SSL verification setting must be set to true or false"
-	    	elsif config.version.nil?
-	    		raise ArgumentError, "Connect version cannot be null"
-	    	end
-	    end
-	end
+require 'osc_ruby/version'
+require 'osc_ruby/configuration'
+
+
+module OSCRuby
+
+	class Client
+		# The top-level class that handles configuration and connection to the Oracle Service Cloud REST API.
+		
+		attr_accessor :config
+		
+		def initialize
+	        raise ArgumentError, "block not given" unless block_given?
+	        self.config ||= OSCRuby::Configuration.new
+	    	yield(config)
+
+	    	check_config
+	    	optional_check
+		end
+
+	    def check_config
+	    	if config.interface ==''
+	    		raise ArgumentError, "Interface cannot be nil or blank"
+	    	elsif config.username ==''
+	    		raise ArgumentError, "Username cannot be nil or blank"
+	    	elsif config.password ==''
+	    		raise ArgumentError, "Password cannot be nil or blank"
+	    	end
+
+	    	true
+	    end
+
+	    def optional_check
+	    	if config.no_ssl_verify.class != FalseClass && config.no_ssl_verify.class != TrueClass
+	    		raise ArgumentError, "The no SSL verification setting must be set to true or false"
+	    	elsif config.version.nil?
+	    		raise ArgumentError, "Connect version cannot be null"
+	    	end
+	    end
+	end
 end

data/lib/osc_ruby/configuration.rb

@@ -1,14 +1,15 @@
-module OSCRuby
-
-	class Configuration
-		# A holder class that holds the configuration information for the OSCRuby::Client block
-	
-	    attr_accessor :interface,:username,:password,:no_ssl_verify,:version,:suppress_rules
-
-	    def initialize
-	    	@no_ssl_verify = false
-	    	@version = 'v1.3'
-	    	@suppress_rules = 'No'
-	    end
-	end
+module OSCRuby
+
+	class Configuration
+		# A holder class that holds the configuration information for the OSCRuby::Client block
+	
+	    attr_accessor :interface,:username,:password,:no_ssl_verify,:version,:suppress_rules,:demo_site
+
+	    def initialize
+	    	@no_ssl_verify = false
+	    	@version = 'v1.3'
+	    	@suppress_rules = false
+	    	@demo_site = false
+	    end
+	end
 end