OSCRuby

Still developing this; will let ya know when this happens.

The basic idea is to be able to do something simple like import a csv of information and post it into an Oracle Service Cloud site.

The ultimate goal is to use this gem to make a Rails app for advanced administration/development that cannot be done with Oracle Service Cloud alone

Example (still coding this out, but trying to get this pretty simple)

# Product Fetch example

client = OSCRuby::Client.new do |config|    
    config.interface = ENV['OSC_TEST_SITE']
    config.username = ENV['OSC_ADMIN']
    config.password = ENV['OSC_PASSWORD']
end

product = OSCRuby::ServiceProduct.fetch(1)

puts product.name

# puts 'Product Lookup Name'

# Product Creation example

names = []

names[0] = {:labelText => 'QTH45', :language => {:id => 1}}
names[1] = {:labelText => 'QTH45', :language => {:id => 11}}

parent = {:id => 102}

displayOrder = {:id => 4}

admin_user_visible_interfaces = []
admin_user_visible_interfaces[0] = {:id => 1}

end_user_visible_interfaces = []
end_user_visible_interfaces[0] = {:id => 1}

new_prod = []
new_prod[0] = {:names => names, 
               :parent => parent, 
               :adminVisibleInterfaces => admin_user_visible_interfaces,
               :endUserVisibleInterfaces => end_user_visible_interfaces}

OSCRuby::ServiceProduct.save(client, new_prod)

# callback with JSON details

TODO

[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
[ ] Put the URL generator method into the get class
[ ] Have the get method make a get request using the Net::HTTP class
[ ] Need to add tests for passing resources, query/id/other param into the URL generator class
[ ] Need to figure out how to pass resources and some sort of query/id/other param into the URL generator class
[ ] Add in tests for Post requests
[ ] Make a Post method
[ ] Add in tests for update requests
[ ] Make a update method
[ ] Add in tests for delete requests
[ ] Make a delete method
[ ] I might need to do a transformation class that converts JSON response into a Ruby Hash
[ ] Create a OSCRuby::ServiceProduct class
[ ] Figure out how to do RDoc/Yardoc documentation or best in class documentation for using this Ruby Wrapper
[ ] Add in VCR and WebMock as dependencies
[ ] Figure out how to record and stub responses for a good response and bad response
[ ] Simulate these responses
[ ] Follow with next Classes (ServiceCategories, Answers, Interfaces)
[ ] Release MVP

Installation

Add this line to your application's Gemfile:

gem 'osc_ruby'

And then execute:

$ bundle

Or install it yourself as:

$ gem install osc_ruby