rnow 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 04ea26cf6ff542dba07ddc744e63abbcc0137dc3
+  data.tar.gz: a909855b5b6172c2a58d8018fe1ba6254524df9b
+SHA512:
+  metadata.gz: 234da4a45ec8f44e11ea6d9fc25cf3b7084594d63e94f759b7a877c264183e36840abb2d80650cba6dbdca8fb30d090d8974a0f5616b104d656a23decf23c6d2
+  data.tar.gz: d9524f9455d62772371a1f29aaba9ea156fe00c632f54b44aa82a4ece8ed567cd5745d32f131efca060cd442a94cde20458b6e4aa5cb68ba8b52cd47f8a070ad

data/.byebug_history

@@ -0,0 +1,167 @@
+connection.get(resource_uri, params).body
+connection.class
+c
+n
+connection.get(resource_uri, params).body
+params
+c
+self.href
+n
+c
+i1["links"].first["href"]
+i1["links"]
+i2 = new(i1)
+i1["organization"]
+i1["id"]
+i1
+i1.id
+ref.body
+i1.organization
+i1
+i1 = JSON.parse(ref.body)
+ref = connection.post(resource_uri, remote_attribute_hash(write = true, post = true))
+c
+remote_attribute_hash(write = true, post = true)
+quit
+connection.class
+c
+n
+remote_attribute_hash(write = true, post = true)
+quit
+remote_attribute_hash(write = true, post = true)
+c
+self.class.remote_attrs
+remote_attribute_hash(write = true, post = true)
+resource_uri
+c
+count
+n
+page
+n
+params
+quit
+f.login
+f.lookupName
+f.id
+f = new(dummy)
+dummy = hash.merge({href: resource_uri + '/' + hash["id"], connection: connection})
+n
+s
+n
+s
+n
+hash
+s
+n
+hash
+quit
+connection.get(JSON.parse(a.body)["links"].first["href"])
+JSON.parse(a.body)["links"].first["href"]
+JSON.parse(a.body)["links"].first[:href]
+JSON.parse(a.body)["links"]
+JSON.parse(a.body).class
+JSON.parse(a.body)["href"]
+JSON.parse(a.body)[:href]
+JSON.parse(a.body)
+JSON.parse(a)
+a
+a["id"]
+a
+a = connection.get(dummy[:href])
+connection.get(dummy[:href])
+dummy
+quit
+{href: resource_uri + '/' + h["id"]}
+h[:href]
+{href: resource_uri + '/' + h["id"]}
+h.merge({})
+n
+h.merge({})
+h
+n
+s
+n
+h.merge({})
+h
+quit
+c
+Rnow::Contact.rnow_object.class
+Rnow::Contact.rnow_object
+Rnow::Contact.hash
+h.merge({href: resource_uri + '/' + h["id"]})
+h[:href]
+h["id"]
+h.merge({})
+h
+c
+rows.map {|r| Hash[keys.zip r]}
+rows
+keys
+quit
+b.map {|array| Hash[a.zip array]}
+Hash[a.zip b.zip]
+Hash[a.zip b]
+[a.zip c]
+a.zip
+Hash[a.zip c]
+c = [ 7, 8, 9 ]
+b = [[10, 11, 12], [20, 21, 22], [30, 31, 32]]
+a = [ 4, 5, 6 ]
+keys.zip
+response["items"].first["rows"].first
+response["items"].first["rows"]
+keys
+n
+quit
+n
+response["items"].first["columnNames"]
+response["items"].count
+response["items"]
+response
+response["items"]["columnNames"]
+quit
+item["columnNames"]
+item
+quit
+n
+c
+params
+n
+uri
+n
+params
+count
+page
+n
+params
+quit
+c
+n
+href
+n
+quit
+href=item.delete["links"]
+item
+quit
+n
+c
+JSON.parse(connection.get(resource_uri, params).body)["items"].first.merge({:connection => connection})
+JSON.parse(connection.get(resource_uri, params).body)["items"].first
+c
+n
+item
+n
+item={data: item}
+item
+n
+pwd
+item={data: item}
+item={item}
+item
+quit
+n
+params={}
+params
+n
+params={}
+default_params

data/.gitignore

@@ -0,0 +1,14 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--require spec_helper

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2016 Soheil Eizadi
+
+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/README.md

@@ -0,0 +1,100 @@
+# RNow
+
+Interact with the Oracle RightNow REST interface with Ruby.  Use this gem to list, create, and delete RightNow organizations, contacts and incdents. The Orcale RightNow REST Interface was available with version 15.05 (May 2015).
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'rnow'
+```
+
+And then execute:
+
+```
+    $ bundle
+```
+
+Or install it yourself as:
+
+```
+    $ gem install rnow
+```
+
+## Usage
+
+### Connections
+An instance of the `Rnow::Connection` class is necessary:
+```ruby
+    connection = Rnow::Connection.new(username: '', password: '', host: '')
+    connection.get(uri, params)
+```
+For example:
+```ruby
+	uri = Rnow::base_path + 'organizations'
+    JSON.parse(connection.get(uri).body)
+```
+
+To debug connections:
+```ruby
+	logger = Logger.new(STDOUT)
+	connection = Rnow::Connection.new(username: '', password: '', host: '', logger: logger)
+	uri = Rnow::base_path + 'organizations'
+	JSON.parse(connection.get(uri).body).map do |item|
+		puts item
+	end
+```
+
+### Resources
+The resource object Rnow::Resource can be used raw similar to connection above or can be encapsulated by a higher level Resource object. To use the objects bundled with Gem:
+
+    orgs = Rnow::Organizations.all(connection)
+
+You can create an incident like this:
+ 	incident =Rnow::Incident.new(assignedTo: {account: {id: 356}}, category: {id: 2314}, primaryContact: {id: 58599}, organization: {id: 38277}, product: {id: 2740}, severity: {id: 2}, subject: "Test Message 1 Soheil Eizadi", connection: connection).create
+
+## Development / testing
+
+Clone:
+```
+$ git clone https://github.com/seizadi/rnow.git
+```
+
+Bundle: 
+```
+$ bundle install
+```
+
+Make changes and add additional test suite as needed.
+
+Run the tests: 
+```
+$ rspec
+```
+
+## References
+
+This is a very early feature for Oracle RightNow and with every release it gets more complete, it took from May to
+Novemember release to get paging into the mix:
+http://documentation.custhelp.com/euf/assets/devdocs/november2015/Connect_REST_API/wwhelp/wwhimpl/js/html/wwhelp.htm#href=Connect_REST_API.1.32.html#
+
+At this time I am running on the August release:
+Oracle RightNow REST interface documented here:
+http://documentation.custhelp.com/euf/assets/devdocs/august2015/Connect_REST_API/wwhelp/wwhimpl/js/html/wwhelp.htm#href=Connect_REST_API.1.01.html
+
+Hoping to test on the Feb 2016 release next, you can monitor the RightNow release train here:
+http://cxdeveloper.com/page/cx-features-version
+
+The August release introduced the primitive ROQL interface from REST, it is the only way to properly do searching and paganition support until the REST interface is complete. 
+http://documentation.custhelp.com/euf/assets/devdocs/november2015/Connect_REST_API/wwhelp/wwhimpl/js/html/wwhelp.htm#href=Connect_REST_API.1.29.html
+
+The design pattern for this Gem is based on previous work by Billy Reisinger, https://github.com/govdelivery/infoblox.git
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/rnow/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+

data/lib/rnow.rb

@@ -0,0 +1,31 @@
+require 'logger'
+require 'json'
+require 'faraday'
+require 'faraday_middleware'
+require 'openssl'
+require "rnow/version"
+require "rnow/connection"
+require "rnow/resource"
+# Require everything in the resources directory
+Dir[File.expand_path('../rnow/resources/*.rb', __FILE__)].each do |f|
+  require f
+end
+
+module Rnow
+  DEBUG        = ENV['DEBUG']
+  
+  def rnow_version
+    @rnow_version ||= (ENV['RNOW_VERSION'] || '1.3')
+  end
+  module_function :rnow_version
+
+  def rnow_version=(v)
+    @rnow_version = v
+  end
+  module_function :rnow_version=
+  
+  def base_path
+  	'services/rest/connect/v' + Rnow.rnow_version + '/'
+  end
+  module_function :base_path
+end

data/lib/rnow/connection.rb

@@ -0,0 +1,106 @@
+module Rnow
+  class Error < StandardError
+  end
+
+  class ClearTextEncoder
+    def self.encode(params)
+      buffer = ''
+      params.each do |key, value|
+        buffer << "#{key}=#{value}&"
+      end
+      return buffer.chop
+    end
+  end
+
+  class Connection
+    attr_accessor :adapter,
+                  :adapter_block,
+                  :connection,
+                  :host,
+                  :logger,
+                  :password,
+                  :ssl_opts,
+                  :username
+
+    def get(href, params={})
+      wrap do
+        connection.get(href, params)
+      end
+    end
+
+    def post(href, body)
+      wrap do
+        connection.post do |req|
+          req.url href
+          req.body = body.to_json
+        end
+      end
+    end
+
+    def put(href, body)
+      wrap do
+        connection.put do |req|
+          req.url href
+          req.body = body.to_json
+        end
+      end
+    end
+
+    def delete(href)
+      wrap do
+        connection.delete(href)
+      end
+    end
+
+    def initialize(opts={})
+      self.username = opts[:username]
+      self.password = opts[:password]
+      self.host     = opts[:host]
+      self.logger   = opts[:logger]
+      self.ssl_opts = opts[:ssl_opts]
+    end
+
+    def connection
+      @connection ||= Faraday.new(:url => self.host, :ssl => {:verify => false}) do |faraday|
+        faraday.use Faraday::Response::Logger, logger if logger
+        faraday.request :json
+        faraday.basic_auth(self.username, self.password)
+        faraday.adapter(self.adapter, &self.adapter_block)
+        faraday.options.params_encoder = Rnow::ClearTextEncoder # Used for ROQL encoding 
+      end
+    end
+
+    ##
+    # The host variable is expected to be a protocol with a host name. 
+    # If the host has no protocol, https:// is added before it. 
+    #
+    def host=(new_host)
+      unless new_host =~ /^http(s)?:\/\//
+        new_host = "https://#{new_host}"
+      end
+      @host = new_host
+    end
+
+    def adapter
+      @adapter ||= :net_http
+    end
+
+    ##
+    # Don't display the username/password in logging, etc. 
+    #
+    def inspect
+      "#<#{self.class}:#{object_id} @host=\"#{@host}\">"
+    end
+
+    private
+
+    def wrap
+      yield.tap do |response|
+        unless response.status < 300
+          raise Rnow::Error.new("Error: #{response.status} #{response.body}")
+        end
+      end
+    end
+  end
+end
+