collegiatelink 0.1.1 → 0.2.0

data/lib/collegiatelink.rb

@@ -21,15 +21,11 @@ require 'collegiatelink/member'
 #
 module CollegiateLink
   # Currently-supported CollegiateLink action request types
-  OLD_ACTIONS = [
-    'organization/list',
-    'organization/roster',
-    #'user/memberships',
-    #'user/position',
-    'event/list',
-  ]
   NEW_ACTIONS = [
+    'organizations',
     'financetransactions',
+    'events',
+    'memberships',
   ]
 
   # Raised when performing a CollegiateLink::Request for an action that is not

data/lib/collegiatelink/client.rb

@@ -40,7 +40,7 @@ module CollegiateLink
     # See CollegiateLink::Request#initialize for a list of optional parameters
     #
     def organizations(params = {})
-      orgs = request('organization/list', CollegiateLink::Organization, params)
+      orgs = request('organizations', CollegiateLink::Organization, params)
     end
 
     def financetransactions(params = {})
@@ -73,13 +73,13 @@ module CollegiateLink
       params[:startdate] = params[:startdate].to_i * 1000
       params[:enddate]   = params[:enddate].to_i * 1000
 
-      events = request('event/list', CollegiateLink::Event, params)
+      events = request('events', CollegiateLink::Event, params)
     end
 
     def roster(id, params = {})
-      params.merge!(:id => id)
+      params.merge!(:organizationId => id)
 
-      members = request('organization/roster', CollegiateLink::Member, params)
+      members = request('memberships', CollegiateLink::Member, params)
     end
 
     private

data/lib/collegiatelink/member.rb

@@ -1,73 +1,56 @@
 module CollegiateLink
+
   ##
-  # A position of someone in an organization
+  # A Member record returned by CollegiateLink
   #
-  class Position < OpenStruct
-    include Representable::XML
+  class Member < OpenStruct
+    include Representable::JSON
+
+    property :membershipId
+    property :organizationId
+    property :organizationName
+    property :organizationShortName
+    property :positionTemplate
+    property :positionTypeName
+    property :positionId
+    property :positionName
+    property :userId
+    property :username
+    property :userFirstName
+    property :userLastName
+    property :userCampusEmail
+    property :preferredemail
+    property :positionRecordedStartDate
+    property :positionRecordedEndDate
+    property :positionReportedStartDate
+    property :positionReportedEndDate
 
-    property :name
-    property :enddate
-    property :startdate
-    property :userstartdate
-    property :userenddate
+    def id
+      membershipId
+    end
 
     def current?
-      use_startdate = (userstartdate.to_i > 0) ? userstartdate.to_i : startdate.to_i
-      indefinite = (userenddate.to_i < 0) && (enddate.to_i < 0)
+      if (use_startdate = positionReportedStartDate.to_i) == 0
+        use_startdate = positionRecordedStartDate.to_i
+      end
+      if (use_enddate = positionReportedEndDate.to_i) == 0
+        use_enddate = positionRecordedEndDate.to_i
+      end
+
+      indefinite = (positionReportedEndDate.to_i <= 0) && (positionRecordedEndDate.to_i <= 0)
 
       starts = Time.at(use_startdate / 1000, use_startdate % 1000)
 
       if indefinite
         return (starts < Time.now)
       else
-        use_enddate = (userenddate.to_i > 0) ? userenddate.to_i : enddate.to_i
         ends = Time.at(use_enddate / 1000, use_enddate % 1000)
         return (starts < Time.now && Time.now < ends)
       end
     end
-  end
-
-  module PositionRepresenter
-    include Representable::XML
-
-    property :name
-    property :enddate
-    property :startdate
-    property :userstartdate
-    property :userenddate
-  end
-
-  class PositionList < OpenStruct
-    include Representable::XML
-
-    collection :positions, :extend => PositionRepresenter, :class => Position, :as => :position
-  end
-
-  ##
-  # A Member record returned by CollegiateLink
-  #
-  class Member < OpenStruct
-    include Representable::XML
-
-    #property :affiliation   # Not sure the format of this...
-    property :campusemail
-    property :firstname
-    property :id
-    property :lastname
-    property :preferredemail
-    property :username
-    property :positionList, :class => PositionList, :as => :positions
-
-    def positions
-      positionList.positions
-    end
-
-    def active_positions
-      positions.keep_if { |p| p.current? }
-    end
 
-    def self.parse(xml)
-      from_xml(xml.to_s)
+    def self.parse(json)
+      new(json)
     end
   end
 end

data/lib/collegiatelink/organization.rb

@@ -41,35 +41,32 @@ module CollegiateLink
 
   ##
   # An Organization record returned by CollegiateLink
-  # See: http://support.collegiatelink.net/entries/332558-web-services-developer-documentation#orgList
-  #
-  # ==== Properties:
-  # * <tt>:id      </tt> - Integer
-  # * <tt>:parentId</tt> - Integer
-  # * <tt>:name    </tt> - String
-  # * <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 < OpenStruct
-    include Representable::XML
+    include Representable::JSON
 
-    property :id
-    property :parentId
+    property :organizationId
     property :name
-    property :description
-    property :shortName
-    property :siteUrl
     property :status
-    property :type
-    collection :addresses
-    collection :categories
+    property :shortName
+    property :summary
+    property :description
+    property :addressStreet1
+    property :addressStreet2
+    property :addressCity
+    property :addressStateProvince
+    property :addressZipPostal
+    property :phoneNumber
+    property :email
+    property :externalWebsite
+    property :facebookUrl
+    property :twitterUrl
+    property :profileUrl
+    property :typeId
+    property :typeName
+    property :parentId
 
-    def self.parse(xml)
-      from_xml(xml.to_s)
+    def self.parse(json)
+      new(json)
     end
   end
 
@@ -77,33 +74,28 @@ module CollegiateLink
   # An Event record returned by CollegiateLink
   # See: http://support.collegiatelink.net/entries/332558-web-services-developer-documentation#eventList
   #
-  # ==== Properties:
-  # * <tt>:id         </tt> - Integer
-  # * <tt>:name       </tt> - String
-  # * <tt>:description</tt> - String
-  # * <tt>:startDate  </tt> - Integer
-  # * <tt>:endDate    </tt> - Integer
-  # * <tt>:location   </tt> - String
-  # * <tt>:status     </tt> - String
-  # * <tt>:urlLarge   </tt> - String
-  # * <tt>:urlSmall   </tt> - String
-  # * <tt>:organization</tt> - The hosting Organization (..todo?)
-  #
   class Event < OpenStruct
-    include Representable::XML
+    include Representable::JSON
 
-    property :id
-    property :name
+    property :eventId
+    property :eventName
+    property :organizationId
+    property :organizationName
+    property :startDateTime
+    property :endDateTime
+    property :externalLocationId
+    property :locationId
+    property :otherLocation
+    # properties for address here...
     property :description
-    property :startDate
-    property :endDate
-    property :location
+    property :flyerUrl
+    property :thumbnailUrl
+    property :typeId
+    property :typeName
     property :status
-    property :urlLarge
-    property :urlSmall
 
-    def self.parse(xml)
-      from_xml(xml.to_s)
+    def self.parse(json)
+      new(json)
     end
   end
 

data/lib/collegiatelink/request.rb

@@ -28,11 +28,8 @@ module CollegiateLink
 
       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]
+      if NEW_ACTIONS.include?(action)
+        @opts[:url_base] ||= 'https://casewestern.collegiatelink.net/api/'
         @opts[:response_format] = 'JSON'
       else
         raise UnknownAction, 'Action not supported!'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: collegiatelink
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.2.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-03-28 00:00:00.000000000 Z
+date: 2012-07-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: guid
@@ -108,7 +108,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 description: 
-email: ted27@case.edu
+email: tomdooner@gmail.com
 executables: []
 extensions: []
 extra_rdoc_files: []