collegiatelink 0.0.5 → 0.1.0

data/lib/collegiatelink.rb

@@ -2,8 +2,11 @@ require 'digest'
 require 'net/https'
 require 'net/ssh'
 require 'guid'
+require 'json'
 require 'nokogiri'
-require 'happymapper'
+require 'ostruct'
+require 'representable/json'
+require 'representable/xml'
 require 'socksify/http'
 
 require 'collegiatelink/response'
@@ -17,13 +20,16 @@ require 'collegiatelink/organization'
 #
 module CollegiateLink
   # Currently-supported CollegiateLink action request types
-  ACTIONS = [
+  OLD_ACTIONS = [
     'organization/list',
     'organization/roster',
     #'user/memberships',
     #'user/position',
     'event/list',
   ]
+  NEW_ACTIONS = [
+    'financetransactions',
+  ]
 
   # Raised when performing a CollegiateLink::Request for an action that is not
   # supported by the gem (as defined by CollegiateLink::ACTIONS).

data/lib/collegiatelink/client.rb

@@ -17,7 +17,6 @@ module CollegiateLink
       }
       @opts = {
         sharedkey: sharedkey,
-        debug: true,
       }
       @@proxy = Net::HTTP
     end
@@ -44,6 +43,15 @@ module CollegiateLink
       orgs = request('organization/list', CollegiateLink::Organization, params)
     end
 
+    def financetransactions(params = {})
+      # Default to only showing transactions in the past seven days
+      seven_days = 7 * 24 * 60 * 60
+      params[:startdate] ||= (Time.now.to_i - seven_days)
+      params[:startdate] = params[:startdate].to_i * 1000
+
+      transactions = request('financetransactions', CollegiateLink::FinanceTransaction, params)
+    end
+
     ##
     # Return a complete list of CollegiateLink::Event instances for your
     # institution.
@@ -80,14 +88,14 @@ module CollegiateLink
       cl_request = CollegiateLink::Request.new(action, params.merge(@params), @opts)
       cl_resp = cl_request.perform
 
-      all_items = cl_resp.items.map { |i| model.parse(i.to_s) }
+      all_items = cl_resp.items.map { |i| model.parse(i) }
 
       while cl_resp.has_next_page?
         cl_request = cl_request.request_for_next_page
         cl_resp = cl_request.perform
-        all_items += cl_resp.items.map { |i| model.parse(i.to_s) }
+        all_items += cl_resp.items.map { |i| model.parse(i) }
       end
-      
+
       all_items
     end
   end

data/lib/collegiatelink/organization.rb

@@ -11,16 +11,16 @@ module CollegiateLink
   # * <tt>:street1   </tt> - String
   # * <tt>:street2   </tt> - String
   # * <tt>:type      </tt> - Integer
-  class Address
-    include HappyMapper
-
-    element :city, String
-    element :country, String
-    element :postalcode, String
-    element :state, String
-    element :street1, String
-    element :street2, String
-    element :type, Integer
+  class Address < OpenStruct
+    include Representable::XML
+
+    property :city
+    property :country
+    property :postalcode
+    property :state
+    property :street1
+    property :street2
+    property :type
   end
 
   ##
@@ -31,12 +31,12 @@ module CollegiateLink
   # * <tt>:id      </tt> - Integer
   # * <tt>:ishidden</tt> - String
   # * <tt>:name    </tt> - String
-  class Category
-    include HappyMapper
+  class Category < OpenStruct
+    include Representable::XML
 
-    element :id, Integer
-    element :ishidden, String
-    element :name, String
+    property :id
+    property :ishidden
+    property :name
   end
 
   ##
@@ -54,19 +54,23 @@ module CollegiateLink
   # * <tt>:type  </tt> - String
   # * <tt>:addresses  </tt> - Array of CollegiateLink::Address
   # * <tt>:categories  </tt> - Array of CollegiateLink::Category
-  class Organization
-    include HappyMapper
-
-    element :id, Integer
-    element :parentId, Integer
-    element :name, String
-    element :description, String
-    element :shortName, String
-    element :siteUrl, String
-    element :status, String
-    element :type, String
-    has_many :addresses, Address
-    has_many :categories, Category
+  class Organization < OpenStruct
+    include Representable::XML
+
+    property :id
+    property :parentId
+    property :name
+    property :description
+    property :shortName
+    property :siteUrl
+    property :status
+    property :type
+    collection :addresses
+    collection :categories
+
+    def self.parse(xml)
+      from_xml(xml.to_s)
+    end
   end
 
   ##
@@ -85,35 +89,70 @@ module CollegiateLink
   # * <tt>:urlSmall   </tt> - String
   # * <tt>:organization</tt> - The hosting Organization
   #
-  class Event
-    include HappyMapper
-
-    element :id, Integer
-    element :name, String
-    element :description, String
-    element :startDate, Integer
-    element :endDate, Integer
-    element :location, String
-    element :status, String
-    element :urlLarge, String
-    element :urlSmall, String
-
-    has_one :organization, Organization
+  class Event < OpenStruct
+    include Representable::XML
+
+    property :id
+    property :name
+    property :description
+    property :startDate
+    property :endDate
+    property :location
+    property :status
+    property :urlLarge
+    property :urlSmall
+
+    def self.parse(xml)
+      from_xml(xml.to_s)
+    end
+  end
+
+  class FinanceTransaction < OpenStruct
+    include Representable::JSON
+
+    property :transactionId
+    property :transactionNumber
+    property :requestId
+    property :requestNumber
+    property :transactionType
+    property :financeTypeId
+    property :financeTypeName
+    property :financeCategoryId
+    property :financeCategoryName
+    property :accountId
+    property :accountName
+    property :originatingAccountId
+    property :originatingAccountName
+    property :originatingOrganizationId
+    property :originiatingOrganizationName
+    property :requestPayeeFirstName
+    property :requestPayeeLastName
+    property :payeeSourceFirstName
+    property :payeeSourceLastName
+    property :transactionDate # todo, make this usable as a date ("1363891642000")
+    property :amount
+    property :endingAllocationAfter
+    property :endingAvailableAfter
+    property :memo
+    property :reconciledStatus
+    property :cancelledStatus
+
+    def self.parse(hash)
+      new(hash)
+    end
   end
 
   ##
   # A position of someone in an organization
   #
-  class Position
-    include HappyMapper
+  class Position < OpenStruct
+    include Representable::XML
 
-    element :name, String
-    element :enddate, Integer
-    element :startdate, Integer
-    element :userstartdate, Integer
-    element :userenddate, Integer
-    element :positionTemplate, String
-    element :positionType, String
+    property :name
+    property :enddate
+    property :startdate
+    property :userstartdate
+    property :userenddate
 
     def current?
       use_startdate = (userstartdate > 0) ? userstartdate : startdate
@@ -134,25 +173,21 @@ module CollegiateLink
   ##
   # A Member record returned by CollegiateLink
   #
-  class Member
-    include HappyMapper
+  class Member < OpenStruct
+    include Representable::XML
 
-    #element :affiliation   # Not sure the format of this...
-    element :campusemail, String
-    element :firstname, String
-    element :id, Integer
-    element :lastname, String
-    element :preferredemail, String
-    element :username, String
+    #property :affiliation   # Not sure the format of this...
+    property :campusemail
+    property :firstname
+    property :id
+    property :lastname
+    property :preferredemail
+    property :username
 
-    has_many :positions, Position
+    collection :positions, :class => CollegiateLink::Position
 
     def active_positions
       positions.keep_if { |p| p.current? }
     end
-
-    def ==(other)
-      self.id == other.id
-    end
   end
 end

data/lib/collegiatelink/request.rb

@@ -22,20 +22,28 @@ module CollegiateLink
     # * <tt>:debug</tt> - Print debug information as the request happens.
     #
     def initialize(action, params = {}, opts = {})
-      raise UnknownAction unless ACTIONS.include?(action)
-      raise AuthenticationException unless opts.include?(:sharedkey)
-
       @action = action
       @params = params
       @opts = opts
 
+      raise AuthenticationException unless opts.include?(:sharedkey)
+
+      if OLD_ACTIONS.include?(action)
+        @opts[:url_base] ||= 'https://casewestern.collegiatelink.net/ws/' % @params[:apikey]
+        @opts[:response_format] = 'XML'
+      elsif NEW_ACTIONS.include?(action)
+        @opts[:url_base] ||= 'https://casewestern.collegiatelink.net/api/' % @params[:apikey]
+        @opts[:response_format] = 'JSON'
+      else
+        raise UnknownAction, 'Action not supported!'
+      end
+
       # URL Query String Parameters
       @params[:page]            ||= 1
-      @params[:pagesize]        ||= 100
-      @params[:modelformatting] ||= 'normal'
+      @params[:pageSize]        ||= 100
 
       # Default values for optional parameters
-      @opts[:url_base]  ||= 'https://%s.collegiatelink.net/ws/' % @params[:apikey]
+      @opts[:debug]     ||= true
     end
 
     ##
@@ -70,7 +78,12 @@ module CollegiateLink
 
       case resp
       when Net::HTTPSuccess
-        return parse_response(resp.body)
+        case @opts[:response_format]
+        when 'JSON'
+          return parse_json_response(resp.body)
+        when 'XML'
+          return parse_xml_response(resp.body)
+        end
       when Net::HTTPError
         raise NetworkException
       else
@@ -88,7 +101,7 @@ module CollegiateLink
 
     private
 
-    def parse_response(body)
+    def parse_xml_response(body)
       d = Nokogiri::XML::Document.parse(body)
 
       # Parse exceptions
@@ -109,7 +122,13 @@ module CollegiateLink
         end
       end
 
-      Response.new(d)
+      CollegiateLink::Response::XML.new(d)
+    end
+
+    def parse_json_response(body)
+      d = ::JSON.parse(body)
+      # Handle errors?
+      CollegiateLink::Response::JSON.new(d)
     end
 
     def hash(params = {})

data/lib/collegiatelink/response.rb

@@ -1,30 +1,54 @@
 module CollegiateLink
-  ##
-  # Container for the XML gunk returned from CollegiateLink
-  #
-  class Response
-    # Create the response.
-    #
-    # ==== Parameters:
-    # * +document+ - The Nokogiri document of the returned XML
-    def initialize(document)
-      raise UnknownException unless document.xpath('//results/page')
-
-      @document = document
-      @page_size   = document.xpath('//results/page/pageSize').inner_html.to_i
-      @page_number = document.xpath('//results/page/pageNumber').inner_html.to_i
-      @total_items = document.xpath('//results/page/totalItems').inner_html.to_i
-      @total_pages = document.xpath('//results/page/totalPages').inner_html.to_i
+  module Response
+    module Common
+      # Utility method to determine if the request has another page to retrieve.
+      def has_next_page?
+        @page_number < @total_pages
+      end
     end
 
-    # Extract the items from the response. Returns a Nokogiri NodeSet.
-    def items
-      @document.xpath('//results/page/items/*')
+    ##
+    # Container for the XML gunk returned from CollegiateLink
+    #
+    class XML
+      include CollegiateLink::Response::Common
+
+      # Create the response.
+      #
+      # ==== Parameters:
+      # * +document+ - The Nokogiri document of the returned XML
+      def initialize(document)
+        raise UnknownException unless document.xpath('//results/page')
+
+        @document = document
+        @page_size   = document.xpath('//results/page/pageSize').inner_html.to_i
+        @page_number = document.xpath('//results/page/pageNumber').inner_html.to_i
+        @total_items = document.xpath('//results/page/totalItems').inner_html.to_i
+        @total_pages = document.xpath('//results/page/totalPages').inner_html.to_i
+      end
+
+      # Extract the items from the response. Returns a Nokogiri NodeSet.
+      def items
+        @document.xpath('//results/page/items/*')
+      end
     end
 
-    # Utility method to determine if the request has another page to retrieve.
-    def has_next_page?
-      @page_number < @total_pages
+    class JSON
+      include CollegiateLink::Response::Common
+
+      def initialize(document)
+        raise UnknownException unless document["items"]
+
+        @document = document
+        @page_size   = document["pageSize"]
+        @page_number = document["pageNumber"]
+        @total_items = document["totalItems"]
+        @total_pages = document["totalPages"]
+      end
+
+      def items
+        @document["items"]
+      end
     end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: collegiatelink
 version: !ruby/object:Gem::Version
-  version: 0.0.5
+  version: 0.1.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-02-19 00:00:00.000000000 Z
+date: 2012-03-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: guid
@@ -44,7 +44,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: happymapper
+  name: representable
   requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
@@ -138,7 +138,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.24
+rubygems_version: 1.8.23
 signing_key: 
 specification_version: 3
 summary: CollegiateLink Client Gem