CollegiateLink 0.0.2 → 0.0.3

data/lib/collegiatelink.rb

@@ -4,6 +4,7 @@ require 'net/ssh'
 require 'guid'
 require 'nokogiri'
 require 'happymapper'
+require 'socksify/http'
 
 require 'collegiatelink/response'
 require 'collegiatelink/request'
@@ -15,10 +16,6 @@ require 'collegiatelink/organization'
 # development, so let me know if you plan to use it. (tomdooner@gmail.com)
 #
 module CollegiateLink
-  # URL base for all requests. The API key will be substituted into this when
-  # the request is made.
-  URL_BASE = 'https://%s.collegiatelink.net/ws/'
-
   # Currently-supported CollegiateLink action request types
   ACTIONS = [
     'organization/list',

data/lib/collegiatelink/client.rb

@@ -13,11 +13,20 @@ module CollegiateLink
     def initialize(apikey, ip, sharedkey)
       @params = {
         apikey: apikey,
-        ip:     ip
+        ip:     ip,
       }
       @opts = {
-        sharedkey: sharedkey
+        sharedkey: sharedkey,
       }
+      @@proxy = Net::HTTP
+    end
+
+    def self.proxy
+      @@proxy
+    end
+
+    def use_socks_proxy(host, port)
+      @@proxy = Net::HTTP.SOCKSProxy(host, port)
     end
 
     ##
@@ -31,8 +40,7 @@ module CollegiateLink
     # See CollegiateLink::Request#initialize for a list of optional parameters
     #
     def organizations(params = {})
-      orgs = request('organization/list', params)
-      orgs.map{ |o| CollegiateLink::Organization.parse(o.to_s) }
+      orgs = request('organization/list', CollegiateLink::Organization, params)
     end
 
     ##
@@ -56,21 +64,27 @@ module CollegiateLink
       params[:startdate] = params[:startdate].to_i * 1000
       params[:enddate]   = params[:enddate].to_i * 1000
 
-      events = request('event/list', params)
-      events.map{ |o| CollegiateLink::Event.parse(o.to_s) }
+      events = request('event/list', CollegiateLink::Event, params)
+    end
+
+    def roster(id, params = {})
+      params.merge!(:id => id)
+
+      members = request('organization/roster', CollegiateLink::Member, params)
     end
 
     private
 
-    def request(action, params = {})
+    def request(action, model, params = {})
       cl_request = CollegiateLink::Request.new(action, params.merge(@params), @opts)
       cl_resp = cl_request.perform
 
-      all_items = cl_resp.items
+      all_items = cl_resp.items.map { |i| model.parse(i.to_s) }
 
       while cl_resp.has_next_page?
-        cl_resp = cl_request.request_for_next_page.perform
-        all_items += cl_resp.items
+        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) }
       end
 
       all_items

data/lib/collegiatelink/organization.rb

@@ -45,10 +45,15 @@ module CollegiateLink
   #
   # ==== Properties:
   # * <tt>:id      </tt> - Integer
-  # * <tt>:ishidden</tt> - String
+  # * <tt>:parentId</tt> - Integer
   # * <tt>:name    </tt> - String
-  # * <tt>:addresses   </tt> - Array of Address objects
-  # * <tt>:categories  </tt> - Array of Category objects
+  # * <tt>:description   </tt> - String
+  # * <tt>:shortName  </tt> - String
+  # * <tt>:siteUrl  </tt> - String
+  # * <tt>:status  </tt> - String
+  # * <tt>:type  </tt> - String
+  # * <tt>:addresses  </tt> - Array of CollegiateLink::Address
+  # * <tt>:categories  </tt> - Array of CollegiateLink::Category
   class Organization
     include HappyMapper
 
@@ -95,4 +100,53 @@ module CollegiateLink
 
     has_one :organization, Organization
   end
+
+  ##
+  # A position of someone in an organization
+  #
+  class Position
+    include HappyMapper
+
+    element :name, String
+    element :enddate, Integer
+    element :startdate, Integer
+    element :userstartdate, Integer
+    element :userenddate, Integer
+
+    def current?
+      use_startdate = (userstartdate > 0) ? userstartdate : startdate
+      indefinite = (userenddate < 0) && (enddate < 0)
+
+      starts = Time.at(use_startdate / 1000, use_startdate % 1000)
+
+      if indefinite
+        return (starts < Time.now)
+      else
+        use_enddate = (userenddate > 0) ? userenddate : enddate
+        ends = Time.at(use_enddate / 1000, use_enddate % 1000)
+        return (starts < Time.now && Time.now < ends)
+      end
+    end
+  end
+
+  ##
+  # A Member record returned by CollegiateLink
+  #
+  class Member
+    include HappyMapper
+
+    #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
+
+    has_many :positions, Position
+
+    def active_positions
+      positions.keep_if { |p| p.current? }
+    end
+  end
 end

data/lib/collegiatelink/request.rb

@@ -33,6 +33,9 @@ module CollegiateLink
       @params[:page]            ||= 1
       @params[:pagesize]        ||= 100
       @params[:modelformatting] ||= 'normal'
+
+      # Default values for optional parameters
+      @opts[:url_base]  ||= 'https://%s.collegiatelink.net/ws/' % @params[:apikey]
     end
 
     ##
@@ -48,16 +51,16 @@ module CollegiateLink
 
       # Then, compute the URL...
       url = URI([
-        URL_BASE % @params[:apikey]
-        @action
-        '?'
-        URI.encode_www_form(request_params)
+        @opts[:url_base],
+        @action,
+        '?',
+        URI.encode_www_form(request_params),
       ].join)
 
       puts "requesting: \n#{url}"   if @opts[:debug]
 
       # Make the Request!
-      res = Net::HTTP.new(url.host, url.port)
+      res = CollegiateLink::Client.proxy.new(url.host, url.port)
       res.use_ssl = true
       res.verify_mode = OpenSSL::SSL::VERIFY_NONE
 

data/lib/collegiatelink/response.rb

@@ -4,7 +4,7 @@ module CollegiateLink
   #
   class Response
     # Create the response.
-    # 
+    #
     # ==== Parameters:
     # * +document+ - The Nokogiri document of the returned XML
     def initialize(document)

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: CollegiateLink
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-11-13 00:00:00.000000000 Z
+date: 2012-02-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: guid
@@ -59,6 +59,22 @@ dependencies:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: socksify
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -83,7 +99,7 @@ dependencies:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
-  type: :development
+  type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     none: false
@@ -125,6 +141,5 @@ rubyforge_project:
 rubygems_version: 1.8.24
 signing_key: 
 specification_version: 3
-summary: CollegiateLink Client Gem
+summary: Old, deprecated gem. Use the lowercased gem "collegiatelink" instead!
 test_files: []
-has_rdoc: