collegiatelink 0.2.0 → 0.3.0

data/lib/collegiatelink/client.rb

@@ -6,17 +6,22 @@ module CollegiateLink
     # Creates a CollegiateLink client.
     #
     # ==== Parameters:
-    # * +apikey+ - The CollegiateLink "apikey" for your institution. For example, at Case Western Reserve University we go to http://casewestern.collegiatelink.net, so our "apikey" is "casewestern"
-    # * +ip+ - The IP address that the +sharedkey+ is approved for.
-    # * +sharedkey+ - The shared key granted by CollegiateLink to your IP and institution.
+    # * +options+ - A hash containing the following values:
+    #   * +apikey+ - The CollegiateLink "apikey"
+    #   * +ip+ - (Optional) The IP address that the +apikey+ is approved for,
+    #     if and only if that is how the +apikey+ is configured on CollegiateLink's
+    #     side.
+    #   * +privatekey+ - The shared key granted by CollegiateLink to your IP and
+    #     institution.
     #
-    def initialize(apikey, ip, sharedkey)
+    def initialize(options = {})
       @params = {
-        apikey: apikey,
-        ip:     ip,
+        apikey: options[:apikey],
       }
+      @params.merge(ip: options[:ip]) if options[:ip]
+
       @opts = {
-        sharedkey: sharedkey,
+        privatekey: options[:privatekey],
       }
       @@proxy = Net::HTTP
     end
@@ -40,7 +45,7 @@ module CollegiateLink
     # See CollegiateLink::Request#initialize for a list of optional parameters
     #
     def organizations(params = {})
-      orgs = request('organizations', CollegiateLink::Organization, params)
+      request('organizations', CollegiateLink::Organization, params)
     end
 
     def financetransactions(params = {})
@@ -49,7 +54,7 @@ module CollegiateLink
       params[:startdate] ||= (Time.now.to_i - seven_days)
       params[:startdate] = params[:startdate].to_i * 1000
 
-      transactions = request('financetransactions', CollegiateLink::FinanceTransaction, params)
+      request('financetransactions', CollegiateLink::FinanceTransaction, params)
     end
 
     ##
@@ -73,13 +78,13 @@ module CollegiateLink
       params[:startdate] = params[:startdate].to_i * 1000
       params[:enddate]   = params[:enddate].to_i * 1000
 
-      events = request('events', CollegiateLink::Event, params)
+      request('events', CollegiateLink::Event, params)
     end
 
     def roster(id, params = {})
       params.merge!(:organizationId => id)
 
-      members = request('memberships', CollegiateLink::Member, params)
+      request('memberships', CollegiateLink::Member, params)
     end
 
     private

data/lib/collegiatelink/request.rb

@@ -18,7 +18,7 @@ module CollegiateLink
     # Options are ways to pass in additional parameters about the request. The
     # following options are supported.
     #
-    # * <tt>:sharedkey</tt> - (Required) The shared key which is used, but not included in the URL of requests
+    # * <tt>:privatekey</tt> - (Required) The shared key which is used, but not included in the URL of requests
     # * <tt>:debug</tt> - Print debug information as the request happens.
     #
     def initialize(action, params = {}, opts = {})
@@ -26,7 +26,7 @@ module CollegiateLink
       @params = params
       @opts = opts
 
-      raise AuthenticationException unless opts.include?(:sharedkey)
+      raise AuthenticationException unless opts.include?(:privatekey)
 
       if NEW_ACTIONS.include?(action)
         @opts[:url_base] ||= 'https://casewestern.collegiatelink.net/api/'
@@ -52,7 +52,7 @@ module CollegiateLink
         time:   Time.now.to_i * 1000,
         random: Guid.new
       })
-      request_params[:hash] = hash(request_params.merge(sharedkey: @opts[:sharedkey]))
+      request_params[:hash] = hash(request_params.merge(privatekey: @opts[:privatekey]))
 
       # Then, compute the URL...
       url = URI([
@@ -134,7 +134,7 @@ module CollegiateLink
         params[:ip],
         params[:time].to_i,
         params[:random],
-        params[:sharedkey],
+        params[:privatekey],
       ].join
     end
   end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: collegiatelink
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-07-21 00:00:00.000000000 Z
+date: 2014-02-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: guid