StarRezApi 0.2.3

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2010 [name of plugin creator]
+
+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/Rakefile

@@ -0,0 +1,23 @@
+require 'rake'
+require 'rake/testtask'
+require 'rake/rdoctask'
+
+desc 'Default: run unit tests.'
+task :default => :test
+
+desc 'Test the starrez_api plugin.'
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = true
+end
+
+desc 'Generate documentation for the starrez_api plugin.'
+Rake::RDocTask.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'StarrezApi'
+  rdoc.options << '--line-numbers' << '--inline-source'
+  rdoc.rdoc_files.include('README')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/lib/starrez.yml

@@ -0,0 +1,8 @@
+development:
+  base_uri: https://localhost/StarRezPortalREST/services/
+  
+production:
+  base_uri: https://localhost/StarRezPortalREST/services/
+  
+test:
+  base_uri: https://localhost/StarRezPortalREST/services/

data/lib/starrez_api.rb

@@ -0,0 +1,22 @@
+# StarRez REST Web Services and Report API
+
+# Load our configuration
+if File.exists?(File.join(Rails.root,"config","starrez.yml"))
+  config_path = File.join(Rails.root,"config","starrez.yml")
+else
+  config_path = File.dirname(__FILE__) + "/starrez.yml"
+end
+STARREZ_CONFIG = YAML.load_file(config_path)[Rails.env]
+
+# Check for required gems
+begin
+  require 'httparty'
+  HTTParty
+rescue Exception => e
+  puts "HTTParty is a required GEM for this plugin. Solve by typing: gem install httparty"
+end
+  
+# Load our Plugin files
+require 'starrez_api/object'
+require 'starrez_api/star_rez_api'
+require 'starrez_api/star_rez_report'

data/lib/starrez_api/object.rb

@@ -0,0 +1,19 @@
+# Much props to _why and his (poignant) guide
+# This code can originally be found at
+# http://viewsourcecode.org/why/hacking/seeingMetaclassesClearly.html
+
+class Object
+  # The hidden singleton lurks behind everyone
+	def metaclass; class << self; self; end; end
+	def meta_eval &blk; metaclass.instance_eval &blk; end
+
+	# Adds methods to a metaclass
+	def meta_def name, &blk
+		meta_eval { define_method name, &blk }
+	end
+
+	# Defines an instance method within a class
+	def class_def name, &blk
+		class_eval { define_method name, &blk }
+	end
+end

data/lib/starrez_api/star_rez_api.rb

@@ -0,0 +1,312 @@
+require 'httparty'
+require 'xmlsimple'
+
+module StarRezApi  
+  include HTTParty
+  base_uri STARREZ_CONFIG['base_uri']
+
+  def self.included receiver
+    receiver.extend ClassMethods
+  end
+
+  module ClassMethods
+    def first
+      results = find(:first)
+    end
+
+    def url
+      "#{StarRezApi::base_uri}/select/#{self.name.gsub(/.*\:\:/,'').downcase}.xml/?_top=1"
+    end
+
+    def what_am_i?
+      "#{self.class.name}"
+    end
+
+    def class_name
+      self.name.gsub(/.*\:\:/,'')
+    end
+    
+     def populate_variables(hash, related_tables=[])
+        self.instance_variable_set("@original_hash",hash)
+        hash.each do |k,v|
+          if related_tables.include? k.to_s
+            children = Array.new
+            v = [v] unless v.is_a? Array # This handles the instance of a single-child
+            v.each do |child|
+              new_child = self.clone
+              new_child.populate_variables(child)
+              children << new_child
+            end
+            new_k = k.to_s.underscore.pluralize
+            self.instance_variable_set("@#{new_k}", children)
+            meta_def new_k do
+              self.instance_variable_get("@#{new_k}")
+            end
+            meta_def "#{new_k}=" do |v|
+              self.instance_variable_set("@#{new_k}",v)
+            end
+          elsif k.is_a?(Hash)
+            # Ignore sub-objects
+          else
+            unless k.blank?
+              k = k.to_s.underscore
+              self.instance_variable_set("@#{k}",v)
+              meta_def k do
+                self.instance_variable_get("@#{k}")
+              end
+              meta_def "#{k}=" do |v|
+                self.instance_variable_set("@#{k}",v)
+              end
+            end
+          end
+        end
+      end
+  
+    def id
+      self.send "#{self.class_name.underscore}_id"
+    end
+       
+    def changed
+      changed_attributes = Hash.new
+      self.instance_variable_get("@original_hash").each do |k,v|
+        k = k.to_s.underscore
+        current_value = self.send(k.to_sym)
+        unless current_value.eql? v
+          changed_attributes[k.to_sym] = [v, current_value]
+        end
+      end
+      return changed_attributes
+    end
+   
+    def changed?
+      self.changed.size > 0
+    end
+   
+    def save
+      if self.changed?
+        response = StarRezApi::post("#{StarRezApi::base_uri}/update/#{self.class_name}/#{self.id}", :body => self.build_query(self.changed))
+        if response.code.eql? 200
+          original_hash = self.instance_variable_get("@original_hash")
+          self.build_query(self.changed).keys.each do |attribute|
+            original_hash[attribute.to_s] = self.send(attribute.to_s.underscore.to_sym)
+          end
+          self.instance_variable_set("@original_hash",original_hash)
+          return true
+        else
+          return response
+        end
+      else
+        warn "[WARN] Nothing to save"
+        return false
+      end
+    end
+    
+    def create(attribute_hash = {}, options ={})
+      formatted_hash = Hash.new
+      attribute_hash.each_pair { |column, value| formatted_hash[column.to_s.camelize.to_sym] = value }
+      results = StarRezApi::post("#{StarRezApi::base_uri}/create/#{self.class_name}", :body => formatted_hash)
+      if results.code.eql? 200
+        if options[:return].eql? :boolean
+          return true
+        else
+          response = XmlSimple.xml_in(results.body)
+          new_id = response["entry"][0]["content"]
+          return self.find new_id
+        end
+      elsif results.code.eql? 400
+        return false
+      else
+        return false
+      end
+    end
+    
+   
+    def all(page_index = 1, page_size = 50)
+      return find(:all, {:size => page_size, :page => page_index})
+    end
+
+    
+    
+    # Find objects via the API interface
+    # Returns an object defined on demand by the API result
+    #
+    # An Object ID or one of the following symbols (:all, :first) must be the first argument
+    # +id+::          The ID of the Object your are searching
+    # +:all+::        Returns an array of objects
+    # +:first+::      Returns the first matched object  
+    #
+    #
+    # The following options are not required but can be used to refine the search
+    # +:conditions+::  Field-Value Pairs
+    # +:page+::        The index page for pagination
+    # +:size+::        The number of results returned per page
+    # +:fields+::      An array of field names to return
+    # +:include+::     Include related tables (this only works if you go from parent->child)
+    # +:order+::       An array of field names to order the response by.
+    # +:limit+::       The number of results to return
+    # 
+    # The +conditions+ option should be a hash with key-value pairs related to the search
+    # requirements. Due to the nature of the StarRez API, there is an additional complexity
+    # of seach operands. For this reason the conditions can be in either of the following
+    # two formats:
+    #
+    #  { :column_name => value }
+    #
+    #  { :column_name => { :operand => value } }
+    #
+    #  Available Operands are:
+    #  
+    #  +ne+::     Not Equals
+    #  +gt+::     Greater Than
+    #  +lt+::     Less Than
+    #  +gte+::    Greater Than or Equal To
+    #  +lte+::    Less Than or Equal To
+    #  +c+::      Contains
+    #  +nc+::     Not Contains
+    #  +sw+::     Starts With
+    #  +nsw+::    Not Starts With
+    #  +ew+::     Ends With
+    #  +new+::    Not Ends With
+    #  +in+::     Value is in (comma separated integer list)
+    #  +notin+::  Value is not in (comma separated integer list)
+    #
+    # The +fields+ option should be an Array of either symbols or strings which refer to a
+    # column in the field. There is no error checking prior to the submission, so an invalid
+    # field name will result in an error.
+    #
+    # The +include+ option should be an Array of either symbols or strings which refer to a
+    # related tables in the database. There is no error checking and an invalid relationship
+    # will result in a failure. This will create an instance variable of an Array of the 
+    # returned objects which will be accessible by a method with the table name pluralized.
+    #
+    # The +order+ option should be an array of fields which the response is ordered by. If
+    # You wish to search by descending order, use a key value of :desc. For example: 
+    # :order => [:name_last, :name_first => :desc]
+    #
+    #
+    # Usage:
+    #
+    #   # Search for a single Entry with the ID of 1234
+    #   Entry.find(1234)
+    #
+    #   # Search for all entries with the last name 'Smith'
+    #   Entry.find(:all, :conditions => { :name_last => "Smith"})
+    #
+    #   # Search for all entries with the last name that starts with 'Sm' and only return first and last names
+    #   Entry.find(:all, :conditions => { :name_last => { :sw => "Sm" } }, :fields => [:name_last, :name_first])
+    #
+    #   # Search for all rooms on a specific floor ('654')
+    #   RoomLocationFloorSuite(654, :include => [:room])
+    
+
+    def find(entry, options = {})
+      options[:size] ||= 50
+      options[:page] = options[:page].blank? || options[:page] == 1 ? 0 : options[:page] * options[:size]
+      query_array = Array.new
+      unless options[:conditions].blank?
+        query_array << get_condition_string(options[:conditions]) 
+      end
+      if entry.is_a?(Symbol)
+        get_url = "#{StarRezApi::base_uri}/select/#{self.class_name}.xml/"
+      else
+        get_url = "#{StarRezApi::base_uri}/select/#{self.class_name}.xml/#{entry}"
+      end
+      if entry.eql? :first        
+        query_array << "_top=1"
+      elsif entry.eql? :all
+        query_array << "_pageIndex=#{options[:page]}"
+        query_array << "_pageSize=#{options[:size]}"  
+      end
+      unless options[:fields].blank?
+        fields = Array.new
+        options[:fields].each { |f| fields << f.to_s.camelize }
+        query_array << "_fields=#{fields.join(',')}"
+      end
+      tables = Array.new
+      unless options[:include].blank?
+        options[:include].each { |t| tables << t.to_s.camelize }
+        query_array << "_relatedtables=#{tables.join(',')}"
+      end
+      unless options[:order].blank?
+        order = Array.new
+        options[:order].each { |o| order << (options[:order][o].eql? :desc) ? "#{o.to_s.camelize}.desc" : "#{o.to_s.camelize}"}
+        query_array << "_orderby=#{order.join(',')}"
+      end
+      unless options[:limit].blank?
+        query_array << "_top=#{options[:limit]}"
+      end
+      get_url += "?#{query_array.join('&')}"
+      results = StarRezApi::get(get_url)
+      if results.response.is_a?(Net::HTTPNotFound)
+        return nil
+      elsif results.code.eql? 403
+        raise SecurityError, "Access Denied to API"
+      elsif options[:return].eql? :response
+        return results
+      elsif results.code.eql? 200
+        ret = results["Results"][self.class_name]
+      else
+        return results
+      end
+      if ret.is_a?(Hash)
+        self.populate_variables(ret,tables)
+        if entry.eql? :all
+          return [self]
+        else        
+          return self
+        end
+      else
+        results = Array.new
+        ret.each do |entry_hash|
+          new_entry = self.clone
+          new_entry.populate_variables(entry_hash,tables)
+          results << new_entry
+        end
+        return results
+      end
+    end
+    
+     
+    def build_query(hash)
+      query = Hash.new
+      hash.keys.each do |attribute|
+        query[attribute.to_s.camelize.to_sym] = self.send(attribute)
+      end
+      return query
+    end
+    
+    private 
+    
+    #Just a quick method used in get_condition_string that would have been repeated
+    #Just takes the array and converts it into a formatted string for StarRezAPI
+    def parse_value(values)
+      if values.is_a?(Array)
+        return URI::encode(values.join(','))
+      else
+        return URI::encode(values.to_s)
+      end    
+    end
+        
+    # Coditions Clean-up by Dan
+    # Example:
+    # find(:all, :conditions => { :column_name => value, :column_name => { :operator => value } })
+    
+    def get_condition_string(conditions)
+      queries = Array.new
+      if conditions.is_a?(Hash)
+        conditions.each_pair do |column, value|
+          query = column.to_s.camelize
+          if value.is_a?(Hash)
+            query += "[_operator%3D#{value.keys.first.to_s}]=#{parse_value(value[value.keys.first])}"
+          else
+            query += "=#{parse_value(value)}"
+          end
+          queries << query
+        end
+        return queries.join('&')
+      else
+        raise ArgumentError, "Condition needs to be a hash of values, Please review the source code"
+      end
+    end
+  end
+end

data/lib/starrez_api/star_rez_report.rb

@@ -0,0 +1,88 @@
+require 'httparty'
+class StarRezReport
+  include HTTParty
+  base_uri STARREZ_CONFIG['base_uri']
+  attr_accessor :name, :results
+    
+  def self.find_by_id(entry, options = {})
+    if entry.blank?
+      raise IOError, "Must include a report ID to search"
+    end
+    conditions = options[:conditions].blank? ? '' : "?#{self.get_condition_string(options[:conditions])}"
+    url = "#{base_uri}/getreportbyid/#{entry}.xml/#{conditions}"
+    response = get(url)
+    if options[:return].eql? :response
+      return response
+    else
+      return self.parse_response(response)
+    end
+  end
+  
+  def self.find_by_name(name, options = {})
+    if name.blank?
+      raise IOError, "Must include a report name"
+    end
+    conditions = options[:conditions].blank? ? '' : "?#{self.get_condition_string(options[:conditions])}"
+    url = "#{base_uri}/getreportbyname/#{URI::escape(name.to_s)}.xml/#{conditions}"
+    response = get(url)
+    if options[:return].eql? :response
+      return response
+    else
+      return self.parse_response(response)
+    end
+  end
+    
+  private
+  # Parse the response from the API
+  def self.parse_response(response)
+    if response.code.eql? 200
+      report = StarRezReport.new
+      report.name = response.keys.first
+      if response[report.name].blank?
+        report.results = []
+      else
+        if response[report.name]["Record"].is_a? Hash
+          report.results = [response[report.name]["Record"]]
+        else
+          report.results = response[report.name]["Record"]
+        end
+      end
+      return report
+    elsif response.code.eql? 403
+      raise SecurityError, "Access Denied to API"
+    else
+      return false
+    end
+  end
+  
+  # Coditions Clean-up by Dan
+  # Example:
+  # find(:all, :conditions => { :column_name => value, :column_name => { :operator => value } })
+  def self.get_condition_string(conditions)
+    queries = Array.new
+    if conditions.is_a?(Hash)
+      conditions.each_pair do |column, value|
+        query = column.to_s.camelize
+        if value.is_a?(Hash)
+          query += "[_operator%3D#{value.keys.first.to_s}]=#{self.parse_value(value[value.keys.first])}"
+        else
+          query += "=#{self.parse_value(value)}"
+        end
+        queries << query
+      end
+      return queries.join('&')
+    else
+      raise ArgumentError, "Condition needs to be a hash of values, Please review the source code"
+    end
+  end
+    
+  #Just a quick method used in get_condition_string that would have been repeated
+  #Just takes the array and converts it into a formatted string for StarRezAPI
+  def self.parse_value(values)
+    if values.is_a?(Array)
+      return URI::encode(values.join(','))
+    else
+      return URI::encode(values.to_s)
+    end    
+  end
+end

data/lib/tasks/starrez_api.rake

@@ -0,0 +1,4 @@
+# desc "Explaining what the task does"
+# task :starrez_api do
+#   # Task goes here
+# end

data/rails/init.rb

@@ -0,0 +1,2 @@
+# Include hook code here
+require 'starrez_api'

metadata

@@ -0,0 +1,84 @@
+--- !ruby/object:Gem::Specification 
+name: StarRezApi
+version: !ruby/object:Gem::Version 
+  prerelease: 
+  version: 0.2.3
+platform: ruby
+authors: 
+- Daniel Reedy
+- Steven Stephen
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-06-15 00:00:00 Z
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: httparty
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 0.7.4
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: xml-simple
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 1.0.12
+  type: :runtime
+  version_requirements: *id002
+description: This gem that allows the user access to the StarRez REST Web Services and Reporting API
+email: dreedy@housing.siu.edu
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- lib/starrez.yml
+- lib/starrez_api/object.rb
+- lib/starrez_api/star_rez_api.rb
+- lib/starrez_api/star_rez_report.rb
+- lib/starrez_api.rb
+- lib/tasks/starrez_api.rake
+- rails/init.rb
+- MIT-LICENSE
+- Rakefile
+homepage: http://www.housing.siu.edu
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.8.5
+signing_key: 
+specification_version: 3
+summary: A module mixin that allows a class to access StarRez
+test_files: []
+