osc_ruby 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 8037699e524a610096534990ff8c2a5c6b675375
-  data.tar.gz: de4304b8f05ed89f3226d67ab8b310d6c9ce430f
+  metadata.gz: bf379c1f203bbe3a5a5f77bde85d2618a0115158
+  data.tar.gz: a4d27cee02b3451ce580283ad09b3a41137ac320
 SHA512:
-  metadata.gz: eceab49e9e22cd4965d9e386c1f78fe2dccbe1676ddf48d4a47818c4cf039d8903c67b06aaf3717bf87783f7054f1cadb118202912ae8c2acf6cf85e9b6b6b6a
-  data.tar.gz: 202c440ec8081ddce1542131e1624dd97c7b1b0229fbd8efe64f99b404558778407446d7196ab10f6a0be88680c0e9fd173cbda80bb4b00db6ccbc06ae563a7d
+  metadata.gz: 9b4a750e171d4f02b355511a9de8643314182d744ee53f4e72bf2e5b3300c4585417ee390adcf43266f392fbf84aa11652f2683ce831d25256902644d4861e15
+  data.tar.gz: 4627953fdbd006c4ace517f8239d1a1a41f4078f08e54cefd4da100039814bda45a0927ba2d5c5d5dc40d3b0a67cdde7b79bb65d85b60ba5e21564d7207cdb6f

data/README.md

@@ -4,57 +4,76 @@
 
 [![Test Coverage](https://codeclimate.com/github/rajangdavis/osc_ruby/badges/coverage.svg)](https://codeclimate.com/github/rajangdavis/osc_ruby/coverage)
 
+
+
 An (under development) Ruby ORM for using Oracle Service Cloud influenced by the ConnectPHP API and ActiveRecord Gem
 
 ## Example (still coding this out, but trying to get this pretty simple)
 
-	# Product Fetch example
+	# Configuration is as simple as requiring the gem
+	# and adding a config block (Completed 12/2016)
 
-	client = OSCRuby::Client.new do |config|	
-		config.interface = ENV['OSC_TEST_SITE']
+	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
 
-	product = OSCRuby::ServiceProduct.fetch(1)
 
-	# returns OSCRuby::ServiceProduct object with id of 1
+	# ServiceProduct fetch example (Completed 12/28/2016)
 
-	puts product.name
+		product = ServiceProduct.find(rn_client,100)
 
-	# =>'Product Lookup Name'
+		puts product
+		# => #<ServiceProduct:0x007fd0fa87e588>
 
-	puts product.displayOrder
+		puts product.name
+		# => QR404
 
-	# => 64
+		puts product.displayOrder
+		# => 3
 
+	# ServiceProduct fetch all example
 
+		products = OSCRuby::ServiceProduct.all(rn_client)
 
+		products.each do |p|
 
-	# Product Creation example
+			puts p.name
 
-	new_product = OSCRuby::ServiceProduct.new
+		end
 
-	# use Ruby hashes to set field information
+		# => Unsure
+		# => DVR/NVR
+		# => QC Series
+		# => QR Series
+		# => QR404
+		# => QS Series
+		# => QT Series
 
-	new_product.names[0] = {:labelText => 'QTH45-test', :language => {:id => 1}}
-	new_product.names[1] = {:labelText => 'QTH45-test', :language => {:id => 11}}
+	# Product Creation example
 
-	new_product.parent = {:id => 102}
+		new_product = OSCRuby::ServiceProduct.new
 
-	new_product.displayOrder = {:id => 4}
+		# use Ruby hashes to set field information
 
-	new_product.adminUserVisibleInterfaces[0] = {:id => 1}
+		new_product.names[0] = {'labelText' => 'QTH45-test', 'language' => {'id' => 1}}
+		new_product.names[1] = {'labelText' => 'QTH45-test', 'language' => {'id' => 11}}
 
-	new_product.endUserVisibleInterfaces[0] = {:id => 1}
+		new_product.parent = {'id' => 102}
 
-	new_product.save(client)
+		new_product.displayOrder = 4
 
-	# callback with JSON details
+		new_product.adminVisibleInterfaces[0] = {'id' => 1}
 
+		new_product.endUserVisibleInterfaces[0] = {'id' => 1}
 
+		new_product.save(client)
+
+	# callback with JSON details
 
-	
 
 ## To do list
 
@@ -90,9 +109,27 @@ An (under development) Ruby ORM for using Oracle Service Cloud influenced by the
 
 - [x] Make a delete method
 
-- [ ] Create a OSCRuby::ServiceProduct class
+- [x] Create a OSCRuby::ServiceProduct class
+
+- [x] Build a QueryModule Module with the following query methods to be shared between all classes:
+	
+- [x] find
+	
+- [ ] take
+	
+- [ ] first
+	
+- [ ] last
+	
+- [ ] order
+	
+- [ ] find_by
+	
+- [ ] where
+	
+- [ ] all
 
-- [ ] I might need to do a transformation class that converts JSON response into a Ruby Hash
+- [x] QueryModel converts JSON response into a Ruby Hash => new instance of the object being queried
 
 - [ ] Figure out how to do RDoc/Yardoc documentation or best in class documentation for using this Ruby Wrapper
 

data/example.rb

@@ -0,0 +1,42 @@
+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 fetch example
+
+	product = ServiceProduct.find(rn_client,100)
+
+	puts product
+
+	# => #<ServiceProduct:0x007fd0fa87e588>
+
+	puts product.name
+
+	# => QR404
+
+	puts product.displayOrder
+
+	# => 3
+
+# ServiceProduct fetch all example
+
+	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

data/lib/ext/string.rb

@@ -0,0 +1,5 @@
+class String
+    def is_i?
+       /\A[-+]?\d+\z/ === self
+    end
+end

data/lib/osc_ruby/client.rb

@@ -4,7 +4,6 @@ require 'osc_ruby/configuration'
 
 module OSCRuby
 
-	
 	class Client
 		# The top-level class that handles configuration and connection to the Oracle Service Cloud REST API.
 		

data/lib/osc_ruby/configuration.rb

@@ -1,10 +1,11 @@
 module OSCRuby
+
 	class Configuration
+		# A holder class that holds the configuration information for the OSCRuby::Client block
 	
-	    attr_accessor :interface,:username,:password,:resource
+	    attr_accessor :interface,:username,:password
 
 	    def initialize
-	    	@resource = ''
 	    end
 	end
 end

data/lib/osc_ruby/connect.rb

@@ -7,6 +7,7 @@ require 'uri'
 module OSCRuby
 	
 	class Connect
+		# This class is purely to provide the underlying methods for CRUD functionality using Net::HTTP, URI, and OpenSSL
 
 		def self.get(client,resource_url = nil)
 

data/lib/osc_ruby/query_module.rb

@@ -0,0 +1,72 @@
+require 'osc_ruby/connect'
+require_relative '../ext/string'
+
+require 'json'
+
+module OSCRuby
+
+	module QueryModule
+	
+		def self.find(rn_client,resource)
+
+			obj_to_find = OSCRuby::Connect.get(rn_client,resource)
+
+			check_obj_for_errors(obj_to_find)
+
+			obj_info = normalize(obj_to_find)
+
+		end
+
+		def self.create(rn_client,resource,json_content)
+
+			obj_to_find = OSCRuby::Connect.post_or_patch(rn_client,resource,json_content)
+
+			obj_to_find.body
+
+		end
+
+		def self.normalize(input)
+
+			if input.code.to_i == 404
+
+				input.body
+
+			else
+
+				_json = JSON.parse(input.body)
+
+				final_hash = []
+
+				_json['items'][0]['rows'].each do |row|
+
+					obj_hash = {}
+					
+					_json['items'][0]['columnNames'].each_with_index do |column,i|
+						obj_hash[column] = if !row[i].nil? && row[i].is_i? == true then row[i].to_i else row[i] end
+					end
+
+					final_hash.push(obj_hash)
+
+				end
+
+				final_hash.to_json
+
+			end
+
+		end
+
+		def self.check_obj_for_errors(obj_to_check)
+
+			_json = JSON.parse(obj_to_check.body)
+
+			if _json['items'][0]['rows'].count == 0
+
+				raise ArgumentError, 'There were no objects matching your query; please try again.'
+
+			end
+
+		end
+		
+	end
+
+end

data/lib/osc_ruby/service_product.rb

@@ -0,0 +1,130 @@
+require 'osc_ruby/client'
+require 'osc_ruby/query_module'
+require 'json'
+require 'uri'
+
+module OSCRuby
+	
+	class ServiceProduct
+
+		include QueryModule
+		
+		attr_reader :id, :lookupName, :createdTime, :updatedTime, :name
+		
+		attr_accessor :names, :parent, :displayOrder, :adminVisibleInterfaces, :endUserVisibleInterfaces
+
+	    def initialize(attributes = nil)
+
+	    	if attributes.nil?
+
+				@names = []
+
+				@parent = {}
+
+				@displayOrder = 1
+
+				@adminVisibleInterfaces = []
+
+				@endUserVisibleInterfaces = []
+
+			else
+
+				@id = attributes["id"]
+		      
+				@lookupName = attributes["lookupName"]
+		      
+				@createdTime = attributes["createdTime"]
+		      
+				@updatedTime = attributes["updatedTime"]
+		      
+				@displayOrder = attributes["displayOrder"]
+		      
+				@name = attributes["name"]
+		      
+				@parent = attributes["parent"]
+
+			end
+
+	    end
+
+	    def self.find(client,id = nil)
+
+	    	check_client(client)
+
+	    	if id.nil? == true
+	    		raise ArgumentError, 'ID cannot be nil'
+	    	elsif id.class != Fixnum
+	    		raise ArgumentError, 'ID must be an integer'
+	    	end
+	    		
+	    	resource = URI.escape("queryResults/?query=select * from serviceproducts where id = #{id}")
+
+	    	service_product_json = QueryModule::find(client,resource)
+
+	    	service_product_json_final = JSON.parse(service_product_json)
+
+	      	new_from_fetch(service_product_json_final[0])
+
+	    end
+
+	    # def self.all(client)
+	    	
+	    # 	resource = URI.escape("queryResults/?query=select * from serviceproducts")
+
+	    # 	service_product_json = QueryModule::find(client,resource)
+
+	    # 	service_product_json_final = JSON.parse(service_product_json)
+
+	    # 	service_product_json_final.map { |attributes| new_from_fetch(attributes) }
+
+	    # end
+
+	  #   def create(client)
+
+	  #   	new_product = self
+
+	  #   	empty_arr = []
+
+	  #   	json_content = {}
+
+			# new_product.instance_variables.each {|var| json_content[var.to_s.delete("@")] = new_product.instance_variable_get(var)}
+
+			# empty_arr[0] = json_content
+
+			# puts JSON.pretty_generate(empty_arr)
+
+	  #   	resource = URI.escape("/serviceProducts")
+
+	  #   	service_product_json = QueryModule::create(client,resource,empty_arr[0])
+
+	  #   end
+
+		def self.new_from_fetch(attributes)
+
+	    	check_attributes(attributes)
+
+	    	OSCRuby::ServiceProduct.new(attributes)
+
+		end
+
+		def self.check_attributes(attributes)
+
+			if attributes.class != Hash
+				
+				raise ArgumentError, "Attributes must be a hash; please use the appropriate data structure"
+		
+			end
+
+		end
+
+		def self.check_client(client)
+
+			if client.class != OSCRuby::Client || client.nil?
+				raise ArgumentError, "Client must have some configuration set; please create an instance of OSCRuby::Client with configuration settings"
+			end
+
+		end
+
+	end
+
+end

data/lib/osc_ruby/version.rb

@@ -1,3 +1,3 @@
 module OSCRuby
-  VERSION = "0.1.0"
+  VERSION = "0.1.1"
 end

data/lib/osc_ruby.rb

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

data/spec/core/service_product_spec.rb

@@ -0,0 +1,152 @@
+require 'core/spec_helper'
+require 'json'
+require 'uri'
+
+describe OSCRuby::ServiceProduct do
+
+	let(:service_product){
+		
+		OSCRuby::ServiceProduct.new
+
+	}
+
+	context '#initialize' do
+
+		it 'should not throw an error when initialized' do
+
+			expect{service_product}.not_to raise_error
+
+		end
+
+		it 'should initialize with names being an array; parent is an empty hash; 
+		displayOrder is 1; adminVisibleInterfaces is an empty array; and endUserVisibleInterfaces is an empty array' do
+
+			expect(service_product.names).to eq([])
+
+			expect(service_product.parent).to eq({})
+
+			expect(service_product.displayOrder).to eq(1)
+
+			expect(service_product.adminVisibleInterfaces).to eq([])
+
+			expect(service_product.endUserVisibleInterfaces).to eq([])
+
+		end
+
+	end
+
+	let(:attributes){
+		{'id' => 1, 
+		 'lookupName' => 'Test Product Lookup Name',
+		 'createdTime'=>nil,
+		 'updatedTime'=>nil,
+		 'displayOrder'=>1,
+		 'name'=>'Test Product Lookup Name',
+		 'parent' => nil
+		}
+	}
+
+	context '#new_from_fetch' do
+
+		it 'should accept an attributes as a hash' do
+
+			expect do
+
+				attributes = []
+
+				OSCRuby::ServiceProduct.new_from_fetch(attributes)
+
+			end.to raise_error("Attributes must be a hash; please use the appropriate data structure")
+
+			expect do
+
+				OSCRuby::ServiceProduct.new_from_fetch(attributes)
+
+			end.not_to raise_error
+
+		end
+
+		it 'should instantiate an id, lookupName, createdTime, updatedTime, displayOrder, name, and parent with the correct values' do
+
+			test = OSCRuby::ServiceProduct.new_from_fetch(attributes)
+
+			expect(test.id).to eq(1)
+
+			expect(test.lookupName).to eq('Test Product Lookup Name')
+
+			expect(test.createdTime).to eq(nil)
+
+			expect(test.updatedTime).to eq(nil)
+
+			expect(test.displayOrder).to eq(1)
+
+			expect(test.name).to eq('Test Product Lookup Name')
+
+			expect(test.name).to eq(test.lookupName)
+
+			expect(test.parent).to eq(nil)
+
+		end
+
+	end
+
+	let(:client) { 
+
+		OSCRuby::Client.new do |config|
+		
+			config.interface = ENV['OSC_TEST_SITE']
+		
+			config.username = ENV['OSC_ADMIN']
+		
+			config.password = ENV['OSC_PASSWORD']
+		
+		end
+	}
+
+	context '#find' 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{OSCRuby::ServiceProduct.find(client,100)}.to raise_error('Client must have some configuration set; please create an instance of OSCRuby::Client with configuration settings')
+
+		end
+
+		it 'should raise an error if ID is undefined' do
+
+			expect{OSCRuby::ServiceProduct.find(client)}.to raise_error('ID cannot be nil')
+
+		end
+
+		it 'should raise an error if ID is not an integer' do
+
+			expect{OSCRuby::ServiceProduct.find(client, 'a')}.to raise_error('ID must be an integer')
+
+		end
+
+		it 'should return a warning if empty/no instances of the object can be found' do
+
+			expect{OSCRuby::ServiceProduct.find(client, 1)}.to raise_error('There were no objects matching your query; please try again.')
+
+		end
+
+		let(:known_working_product){
+			OSCRuby::ServiceProduct.find(client, 100)
+		}
+
+		it 'should return an instance of a new OSC::ServiceProduct object with at least a name and displayOrder' do
+
+			expect(known_working_product).to be_an(OSCRuby::ServiceProduct)
+
+			expect(known_working_product.name).to eq('QR404')
+
+			expect(known_working_product.displayOrder).to eq(3)
+
+		end
+
+	end
+
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: osc_ruby
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Rajan Davis
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-12-24 00:00:00.000000000 Z
+date: 2016-12-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -69,15 +69,20 @@ files:
 - LICENSE.txt
 - README.md
 - Rakefile
+- example.rb
+- lib/ext/string.rb
 - lib/osc_ruby.rb
 - lib/osc_ruby/client.rb
 - lib/osc_ruby/configuration.rb
 - lib/osc_ruby/connect.rb
+- lib/osc_ruby/query_module.rb
+- lib/osc_ruby/service_product.rb
 - lib/osc_ruby/version.rb
 - osc_ruby.gemspec
 - spec/core/client_spec.rb
 - spec/core/configuration_spec.rb
 - spec/core/connect_spec.rb
+- spec/core/service_product_spec.rb
 - spec/core/spec_helper.rb
 - tasks/rspec.rake
 homepage: https://github.com/rajangdavis/osc_ruby
@@ -108,4 +113,5 @@ test_files:
 - spec/core/client_spec.rb
 - spec/core/configuration_spec.rb
 - spec/core/connect_spec.rb
+- spec/core/service_product_spec.rb
 - spec/core/spec_helper.rb