blackbaud-client 0.1.4 → 0.2.0

checksums.yaml

@@ -1,7 +1,15 @@
 ---
-SHA1:
-  metadata.gz: 631c752d0154a233be0dced206e8a25f4d339f59
-  data.tar.gz: cf6b78ac100ad91fd7e79a998389172540f0b737
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    MjI4YjQ0ZjBlZmM2MDJiMmQ5YTc1YTA0Y2EzYjY2YWI3ZjhkOGMxYQ==
+  data.tar.gz: !binary |-
+    YmQ2YTFkOTJhYTkxMWFiMjZhODgwNjNmMTIwYTFlNDM3OTcwMmY2ZQ==
 SHA512:
-  metadata.gz: 19e17a3ab89fe833b422dc2f36e284b430875f5b34f703bb849c6f17342d467b935537b81867e5993be7114854cb45faaa92462df984a4e4294edb62f4e2a4a2
-  data.tar.gz: 1a9793df98ce432240f2e491ec953447479e7793182891f9c1863d7612de39544e28def1749676019a0a883e0a86c22e3269070ff865ab6abdd0f0dd66b65c38
+  metadata.gz: !binary |-
+    YjY4MDdkZDJkYzQ5NDljN2E5MzEzYjc5ZWUxN2IyOGU4MmRmMjZiYTQxOTZi
+    ZWNiNmVkMjUwMmNiYWRlMjQyYTA0NDQ4YjkxYjQ4YjgxOTNhZWE4Njk0NTM3
+    ZDJkNGVkM2Y5YTc1Y2YxYzFlZDJiNGUwMTRhNmY5MmMwYzc2Mzc=
+  data.tar.gz: !binary |-
+    ZWQwMDc1NDdlY2IzZWEwZmRlMjM5NWYwNzk2NDZiMDNiODAxYWI1NWRlODEz
+    YzRjMzIyZGNhMWM3YWMyMmM5NzdiNGNiNWUyZWM2N2FmMjJhMTIyZjZhZDkx
+    NThhNjI4MDMyOWZkOTllNzRiOTgzODhjZDc3MGJiOGI0MmQ3ODk=

data/.gitignore

@@ -5,4 +5,4 @@ test/
 log/
 .ruby-version
 .ruby-gemset
-Gemfile.lock
+Gemfile.lock

data/.travis.yml

@@ -0,0 +1,8 @@
+language: ruby
+rvm:
+  - 1.9.3
+  - 2.1.7
+  - 2.2.3
+
+script: bundle exec rspec spec
+sudo: false

data/CHANGELOG.md

@@ -1,5 +1,11 @@
 # Change Log
 
+## 0.1.5 - 2015-09-30
+### Changed
+- Major refactor to support Post reuqests
+- Rename client methods to reflect their request type
+- Add get objects and methods for TransalationTable, TranslationTableEntry, Grades, and MarkingColumn
+
 ## 0.1.4 - 2015-07-14
 ### Changed
 - Added deceased attribute to Person.

data/README.md

@@ -1,5 +1,6 @@
 [![Gem Version](https://badge.fury.io/rb/blackbaud-client.svg)](http://badge.fury.io/rb/blackbaud-client)
 [![Code Climate](https://codeclimate.com/github/haikulearning/blackbaud-client/badges/gpa.svg)](https://codeclimate.com/github/haikulearning/blackbaud-client)
+[![Build Status](https://secure.travis-ci.org/haikulearning/blackbaud-client.svg)](http://travis-ci.org/haikulearning/blackbaud-client)
 
 # Blackbaud Client
 Ruby client for the Blackbaud API.
@@ -8,12 +9,14 @@ Ruby client for the Blackbaud API.
 
 Create a Blackbaud API Client
 
+    require 'blackbaud-client'
+
     options = {
-      :password => "pass",
-      :key => "abcde",
-      :username => "user",
-      :database => "1"
-      :url => "https://blackbaud.api.url.example/key/"
+      :database_key => "db_key",
+      :database_number => 1,
+      :vendor_id => 'vendor_id',
+      :vendor_key => 'vendor_key',
+      :url => "https://blackbaud-api-url.com"
     }
 
     @client = Blackbaud::Client.new(options)

data/blackbaud-client.gemspec

@@ -18,5 +18,8 @@ Gem::Specification.new do |gem|
   gem.add_runtime_dependency  'ruby-hmac',    '~>0.4'
   gem.add_runtime_dependency  'rest-client',  '~>1.6'
 
-  gem.add_development_dependency  'rake'
-end
+  gem.add_development_dependency 'rspec', '~>3.3'
+  gem.add_development_dependency 'webmock', '~>1.21'
+  gem.add_development_dependency  'rake', '~>0.9'
+  gem.add_development_dependency 'pry', '~>0.10'
+end

data/lib/blackbaud-client/api/academic_year.rb

@@ -2,15 +2,16 @@ module Blackbaud
   class AcademicYear < BlackbaudObject
     attr_accessor(:description, :ea7_academic_year_id, :end_date, :school_id, :school_name, :sessions, :short_description, :start_date, :links)
 
-    def initialize(values)
-      values["sessions"].map! {|s| Blackbaud::Session.new(s)} if values["sessions"]
+    def initialize(options)
+
+      options.fetch(:values)["sessions"].map! {|s| Blackbaud::Session.new(values: s)} if options.fetch(:values)["sessions"]
 
       ["start_date", "end_date"].each do |date|
-        send("#{date}=".intern, format_date(values["#{date}"]))
-        values.delete("#{date}")
+        send("#{date}=".intern, format_date(options.fetch(:values)["#{date}"]))
+        options.fetch(:values).delete("#{date}")
       end
 
-      super(values)
+      super
     end
 
     def connection_string

data/lib/blackbaud-client/api/attendance_by_class_record.rb

@@ -0,0 +1,5 @@
+module Blackbaud
+  class AttendanceByClassRecord < AttendanceRecord
+    attr_accessor(:ea7_attendance_by_class_id, :ea7_class_meeting_id)
+  end
+end

data/lib/blackbaud-client/api/attendance_by_day_record.rb

@@ -0,0 +1,5 @@
+module Blackbaud
+  class AttendanceByDayRecord < AttendanceRecord
+    attr_accessor(:ea7_attendance_by_day_id)
+  end
+end

data/lib/blackbaud-client/api/attendance_code.rb

@@ -0,0 +1,5 @@
+module Blackbaud
+  class AttendanceCode < BlackbaudObject
+    attr_accessor(:ea7_attendance_code_id, :allow_daily_entry, :code_type, :code_type_desc, :description, :short_description)
+  end
+end

data/lib/blackbaud-client/api/attendance_record.rb

@@ -0,0 +1,13 @@
+module Blackbaud
+  class AttendanceRecord < BlackbaudObject
+    attr_accessor(:ea7_record_id, :code, :date, :name_for_display, :ea7_attendance_code_id)
+
+    def initialize(options)
+      options.fetch(:values)
+      self.date = format_date(options.fetch(:values)["date"])
+      options.fetch(:values).delete(:date)
+      super
+    end
+
+  end
+end

data/lib/blackbaud-client/api/blackbaud_class.rb

@@ -0,0 +1,26 @@
+module Blackbaud
+  class BlackbaudClass < BlackbaudObject
+    attr_accessor(:ea7_class_id, :course_id, :course_name, :section, :ea7_term_id, :ea7_term_name, :faculty, :students)
+
+    def initialize(options)
+      {
+        'faculty'   => Blackbaud::Person::USER_TYPE[:faculty],
+        'students'  => Blackbaud::Person::USER_TYPE[:student],
+      }.each do |response_key, type_id|
+        if options.fetch(:values)[response_key].is_a?(Enumerable)
+          options.fetch(:values)[response_key].map! do |person|
+            person['type'] = type_id
+            Blackbaud::Person.new({values: person})
+          end
+        end
+      end
+
+      super
+    end
+
+    def marking_columns
+      @client.get_class_marking_columns(self.ea7_class_id)
+    end
+
+  end
+end

data/lib/blackbaud-client/api/blackbaud_object.rb

@@ -1,15 +1,37 @@
 module Blackbaud
   class BlackbaudObject
 
-    def initialize(values)
-      values.each do |k,v|
+    attr_accessor :client
+
+    def initialize(options)
+      @client ||= options.delete(:client)
+
+      options.fetch(:values).each do |k,v|
         send("#{k}=".intern, v) if respond_to?("#{k}=".intern)
       end
+    rescue NoMethodError
+      puts "NoMethodError: There is no method for one of the keys in your options: #{options}"
+      return nil
     end
 
     def format_date(d)
       DateTime.parse(d)
     end
 
+    def to_hash(keys=nil)
+      ivs = (keys ? (instance_variables & keys) : instance_variables)
+      ivs -= [:@client]
+      Hash[*
+        ivs.map { |v|
+        [v.to_s[1..-1].to_sym, instance_variable_get(v)]
+      }.flatten]
+    end
+
+    def to_json(*args)
+      JSON.generate(to_hash)
+    end
+
+    alias_method :to_h, :to_hash
+
   end
-end
+end

data/lib/blackbaud-client/api/code_table.rb

@@ -1,5 +1,10 @@
 module Blackbaud
   class CodeTable < BlackbaudObject
     attr_accessor(:_links, :id, :name, :links)
+
+    def entries
+      @client.get_code_table_entries(self)
+    end
+
   end
 end

data/lib/blackbaud-client/api/grade.rb

@@ -0,0 +1,13 @@
+module Blackbaud
+  class Grade < BlackbaudObject
+    attr_accessor(:ea7_marking_column_id,:ea7_record_id,:ea7_student_course_id,:ea7_student_grade_id,:ea7_student_gradebook_grade_id,:ea7_translation_table_entry_id,:grade,:grade_post_status,:grade_type,:message,:name_for_display)
+
+    def to_hash
+      super([:@ea7_marking_column_id, :@ea7_student_course_id, :@ea7_student_grade_id, :@ea7_translation_table_entry_id, :@message])
+    end
+    
+    def post
+      @client.post_grades(self)
+    end
+  end
+end

data/lib/blackbaud-client/api/marking_column.rb

@@ -0,0 +1,10 @@
+module Blackbaud
+  class MarkingColumn < BlackbaudObject
+    attr_accessor(:ea7_course_grading_info_grade_id, :description, :ea7_marking_column_id, :ea7_translation_table_id, :short_description, :values_allowed, :ea7_class_id)
+
+    def grades
+      @client.get_grades(self.ea7_class_id, self.ea7_marking_column_id)
+    end
+
+  end
+end

data/lib/blackbaud-client/api/person.rb

@@ -8,30 +8,28 @@ module Blackbaud
      :undefined => nil,
     }
 
-    def initialize(values, type_id)
-      values["type"] = type_id
-
-      if values["bio"]
-        values["bio"].each {|k, v| values[k] = v}
-        values.delete("bio")
+    def initialize(options)
+      if options.fetch(:values)["bio"]
+        options.fetch(:values)["bio"].each {|k, v| options.fetch(:values)[k] = v}
+        options.fetch(:values).delete("bio")
       end
 
-      if values["contact_info"]
-        values["contacts"] = values["contact_info"].map {|c| Blackbaud::Contact.new(c)}
-        values.delete("contact_info")
+      if options.fetch(:values)["contact_info"]
+        options.fetch(:values)["contacts"] = options.fetch(:values)["contact_info"].map {|c| Blackbaud::Contact.new({values: c})}
+        options.fetch(:values).delete("contact_info")
       else
-        values["contacts"] = []
+        options.fetch(:values)["contacts"] = []
       end
 
-      if values["relations"]
-        values["relations"].map! {|r| Blackbaud::Relation.new(r)}
+      if options.fetch(:values)["relations"]
+        options.fetch(:values)["relations"].map! {|r| Blackbaud::Relation.new({values: r})}
       else
-        values["relations"] = []
+        options.fetch(:values)["relations"] = []
       end
 
-      values["birth_date"] = format_date(values["birth_date"]) if values["birth_date"]
+      options.fetch(:values)["birth_date"] = format_date(options.fetch(:values)["birth_date"]) if options.fetch(:values)["birth_date"]
 
-      super(values)
+      super
     end
 
     def faculty?

data/lib/blackbaud-client/api/relation.rb

@@ -2,9 +2,9 @@ module Blackbaud
   class Relation < BlackbaudObject
     attr_accessor(:relationship_code_id, :relationship_code_value, :reciprocal_code_id, :reciprocal_code_value, :person, :emergency_contact)
 
-    def initialize(values)
-      values["person"] = Blackbaud::Person.new(values["person"], Blackbaud::Person::USER_TYPE[:undefined]) if values["person"]
-      super(values)
+    def initialize(options)
+      options.fetch(:values)["person"] = Blackbaud::Person.new(values: options.fetch(:values)["person"]) if options.fetch(:values)["person"]
+      super
     end
 
   end

data/lib/blackbaud-client/api/session.rb

@@ -1,11 +1,13 @@
 module Blackbaud
   class Session < BlackbaudObject
-    attr_accessor(:name, :ea7_session_id, :terms, :links)
+    attr_accessor(:name, :ea7_session_id, :marking_columns, :terms, :track_schedule_changes, :beginning_track_date, :message, :links)
 
-    def initialize(values)
-      values["terms"].map! {|t| Blackbaud::Term.new(t)} if values["terms"]
-      super(values)
+
+    def initialize(options)
+      options.fetch(:values)["terms"].map! {|t| Blackbaud::Term.new({values: t})} if options.fetch(:values)["terms"]
+      options.fetch(:values)["marking_columns"].map! {|t| Blackbaud::MarkingColumn.new({values: t})} if options.fetch(:values)["marking_columns"]
+      super
     end
 
   end
-end
+end

data/lib/blackbaud-client/api/translation_table.rb

@@ -0,0 +1,12 @@
+module Blackbaud
+  class TranslationTable < BlackbaudObject
+    attr_accessor(:ea7_translation_table_id, :highest_numeric_grade_allowed, :lowest_numeric_grade_allowed, :name, :translation_table_entries)
+    alias_method :entries, :translation_table_entries
+
+    def initialize(options)
+      options.fetch(:values)["translation_table_entries"].map! {|e| Blackbaud::TranslationTableEntry.new({values: e})} if options.fetch(:values)["translation_table_entries"]
+      super
+    end
+
+  end
+end

data/lib/blackbaud-client/api/translation_table_entry.rb

@@ -0,0 +1,5 @@
+module Blackbaud
+  class TranslationTableEntry < BlackbaudObject
+    attr_accessor(:ea7_translation_table_entry_id, :grade)
+  end
+end

data/lib/blackbaud-client/connector.rb

@@ -0,0 +1,42 @@
+module Blackbaud
+  class Connector
+    attr_accessor(:token, :web_services_url, :save_request_data_to)
+    def initialize(url, save_request_data_to)
+      @web_services_url = url
+      @save_request_data_to = save_request_data_to
+    end
+
+    def get(endpoint, filters=nil)
+      url = construct_url(@web_services_url, endpoint, filters)
+      response = RestClient.get(url)
+      write_json_to_file(url, response) if @save_request_data_to
+      JSON.parse(response)
+    end
+
+    def post(endpoint, body)
+      url = construct_url(@web_services_url, endpoint)
+      response = RestClient.post(url, body, {:content_type=>'application/json'})
+      JSON.parse(response)
+    end
+
+    def construct_url(web_services_url, endpoint, filters=nil)
+      params = "?token=#{@token}" if @token
+      if filters
+        filters = Array(filters).map do |k,v|
+          v = Array(v)
+          "(#{k}%20eq%20#{v.join(',')})" if v && !v.join.empty?
+        end
+        params << "&filter=#{filters.join}"
+      end
+      url = "#{web_services_url}/#{endpoint}#{params}"
+    end
+
+    def write_json_to_file(url, data)
+      return unless data
+      file = url.gsub( /\/|\\/, ':' ).match(/.{,250}$/).to_s + '.json'
+      file = File.expand_path(File.join(@save_request_data_to, file))
+      FileUtils.mkdir_p @save_request_data_to
+      File.open(file, 'w') { |f| f.write(JSON.pretty_unparse(JSON.parse(data)))}
+    end
+  end
+end

data/lib/blackbaud-client/version.rb

@@ -2,8 +2,8 @@ module Blackbaud
   class Client
     class Version
       MAJOR = 0
-      MINOR = 1
-      PATCH = 4
+      MINOR = 2
+      PATCH = 0
       STRING = "#{MAJOR}.#{MINOR}.#{PATCH}"
 
       class << self

data/lib/blackbaud-client.rb

@@ -1,16 +1,24 @@
+require 'blackbaud-client/connector.rb'
 require 'blackbaud-client/version.rb'
 require 'blackbaud-client/api/blackbaud_object.rb'
 require 'blackbaud-client/api/academic_year.rb'
-require 'blackbaud-client/api/class.rb'
+require 'blackbaud-client/api/blackbaud_class.rb'
 require 'blackbaud-client/api/code_table.rb'
 require 'blackbaud-client/api/person.rb'
 require 'blackbaud-client/api/contact.rb'
 require 'blackbaud-client/api/relation.rb'
 require 'blackbaud-client/api/session.rb'
 require 'blackbaud-client/api/static_code_table.rb'
-require 'blackbaud-client/api/table_entry.rb'
 require 'blackbaud-client/api/term.rb'
 require 'blackbaud-client/api/code_table_entry.rb'
+require 'blackbaud-client/api/attendance_code.rb'
+require 'blackbaud-client/api/attendance_record.rb'
+require 'blackbaud-client/api/attendance_by_day_record.rb'
+require 'blackbaud-client/api/attendance_by_class_record.rb'
+require 'blackbaud-client/api/grade.rb'
+require 'blackbaud-client/api/marking_column.rb'
+require 'blackbaud-client/api/translation_table.rb'
+require 'blackbaud-client/api/translation_table_entry.rb'
 require 'hmac-sha1'
 require 'cgi'
 require 'base64'
@@ -20,39 +28,44 @@ require 'date'
 
 module Blackbaud
   class Client
-
+    attr_accessor(:connector)
     def initialize(options)
+      @connector = Blackbaud::Connector.new(options[:url], options[:save_request_data_to])
       auth_params = {
         :database_key => options[:database_key],
         :database_number => options[:database_number],
         :vendor_id => options[:vendor_id],
         :vendor_key => options[:vendor_key]
       }.to_json
-      @web_services_url = options[:url]
-      @token = JSON.parse(RestClient.post (@web_services_url+'/security/access_token'), auth_params, {:content_type=>'application/json'})["token"]
-      @save_request_data_to = options[:save_request_data_to]
+      @connector.token = get_token(auth_params)
     end
 
-    def connect(endpoint, filters=nil)
-      url = construct_url(@web_services_url, endpoint, filters)
-      json = RestClient::Request.execute(:method=>'get', :url=>url)
-      write_json_to_file(url, json) if @save_request_data_to
-      JSON.parse(json)
+    def get_token(auth_params)
+      results = @connector.post('/security/access_token', auth_params)
+      results["token"]
     end
 
-    def academic_years(id)
-      results = connect("schedule/#{id}/academic_years")
-      results["academic_years"].collect {|year| Blackbaud::AcademicYear.new(year)}
+    def get_academic_years(id)
+      results = @connector.get("schedule/#{id}/academic_years")
+      create_blackbaud_objects(Blackbaud::AcademicYear, results["academic_years"])
     end
 
-    def contact_types
-      results = connect("global/code_tables/phone%20type")
-      results["table_entries"].collect {|entry| Blackbaud::CodeTableEntry.new(entry)}
+    def get_contact_types
+      results = @connector.get("global/code_tables/phone%20type")
+      create_blackbaud_objects(Blackbaud::CodeTableEntry, results["table_entries"])
     end
 
-    def relationships
-      results = connect("global/code_tables/relationship")
-      results["table_entries"].collect {|entry| Blackbaud::CodeTableEntry.new(entry)}
+    def get_relationships
+      results = @connector.get("global/code_tables/relationship")
+      create_blackbaud_objects(Blackbaud::CodeTableEntry, results["table_entries"])
+    end
+
+    def get_person(id, filter_opts={})
+      filters = {}
+      filters["contact.type_id"] = filter_opts[:contact_types]
+      filters["relation.relationship_code_id"] = filter_opts[:relationships]
+      results = @connector.get("person/people/#{id}", filters)
+      create_blackbaud_object(Blackbaud::Person, results["people"].first)
     end
 
     # Return an Array of Person records
@@ -60,71 +73,145 @@ module Blackbaud
     # Available filter_opts:
     # * :contact_types: An Array of id values that correspond to code_table table_entry records from the "phone type" code_table
     # * :relationships: An Array of id values that correspond to code_table table_entry records from the "relationship" code_table
-    def people(scope, filter_opts={})
+    def get_people(scope, filter_opts={})
       filters = {}
-
       filters["contact.type_id"] = filter_opts[:contact_types]
       filters["relation.relationship_code_id"] = filter_opts[:relationships]
 
-      results = connect("person/#{scope.connection_string}/people", filters )
-      r = []
+      results = @connector.get("person/#{scope.connection_string}/people", filters)["people"].first
 
       {
         'faculty'   => Blackbaud::Person::USER_TYPE[:faculty],
         'students'  => Blackbaud::Person::USER_TYPE[:student],
       }.each do |response_key, type_id|
-        ppl = results["people"].first[response_key]
-        ppl = [] unless ppl.is_a?(Enumerable)
-        ppl.each do |person|
-          r << Blackbaud::Person.new(person, type_id)
+        if results[response_key].is_a?(Enumerable)
+          results[response_key].each{|person| person['type'] = type_id}
         end
       end
+      create_blackbaud_objects(Blackbaud::Person, results['faculty'] + results['students'])
+    end
 
-      r
+    def get_classes(scope)
+      results = @connector.get("schedule/#{scope.connection_string}/classes")
+      create_blackbaud_objects(Blackbaud::BlackbaudClass, results["classes"])
     end
 
-    def classes(scope)
-      results = connect("schedule/#{scope.connection_string}/classes")
-      results["classes"].collect {|c| Blackbaud::Class.new(c)}
+    def get_class(id)
+      results = @connector.get("schedule/classes/#{id}")
+      create_blackbaud_object(Blackbaud::BlackbaudClass, results["classes"].first)
     end
 
-    def code_tables
-      results = connect("global/code_tables")
-      results["code_tables"].collect {|table| Blackbaud::CodeTable.new(table)}
+    def get_code_tables
+      results = @connector.get("global/code_tables")
+      create_blackbaud_objects(Blackbaud::CodeTable, results["code_tables"])
     end
 
-    def code_table_entries(code_table)
-      results = connect("global/code_tables/#{code_table.id}")
-      results["table_entries"].collect {|entry| Blackbaud::TableEntry.new(entry)}
+    def get_code_table_entries(code_table)
+      results = @connector.get("global/code_tables/#{code_table.id}")
+      create_blackbaud_objects(Blackbaud::CodeTableEntry, results["table_entries"])
     end
 
-    def static_code_tables(id)
-      results = connect("global/static_code_tables/#{id}")
-      results["table_entries"].collect {|c| Blackbaud::TableEntry.new(c)}
+    def get_static_code_tables(id)
+      results = @connector.get("global/static_code_tables/#{id}")
+      create_blackbaud_objects(Blackbaud::CodeTableEntry, results["table_entries"])
     end
 
-    private
+    def get_attendance_codes
+      results = @connector.get("attendance/codes")
+      create_blackbaud_objects(Blackbaud::AttendanceCode, results["attendance_codes"])
+    end
+
+    def get_attendance_by_class(ea7_class_id, start_date, end_date = nil)
+      results = @connector.get("attendance/class/#{ea7_class_id}/#{format_date(start_date)}/#{format_date(end_date)}")
+      create_blackbaud_objects(Blackbaud::AttendanceByClassRecord, results["attendance_by_class_records"])
+    end
+
+    def get_attendance_by_day(ea7_class_id, start_date, end_date = nil)
+      results = @connector.get("attendance/day/#{ea7_class_id}/#{start_date}/#{end_date}")
+      create_blackbaud_objects(Blackbaud::AttendanceByDayRecord, results["attendance_by_day_records"])
+    end
+
+    def get_academic_year_marking_columns(year_id)
+      results = @connector.get("configuration/academic_years/#{year_id}/marking_columns")
+      create_blackbaud_objects(Blackbaud::Session, results["sessions"])
+    end
 
-    def write_json_to_file(url, data)
-      return unless data
-      file = url.gsub( /\/|\\/, ':' ).match(/.{,250}$/).to_s + '.json'
-      # file = /[^\/]*$/.match(url).to_s + '.json'
-      file = File.expand_path(File.join(@save_request_data_to, file))
-      FileUtils.mkdir_p @save_request_data_to
-      File.open(file, 'w') { |f| f.write(JSON.pretty_unparse(JSON.parse(data)))}
+    def get_session_marking_columns(session_id)
+      results = @connector.get("configuration/sessions/#{session_id}/marking_columns")
+      create_blackbaud_objects(Blackbaud::MarkingColumn, results["marking_columns"])
     end
 
-    def construct_url(web_services_url, endpoint, filters=nil)
-      url = "#{web_services_url}/#{endpoint}?token=#{@token}"
-      filters = Array(filters).map do |k,v|
-        v = Array(v)
-        "(#{k}%20eq%20#{v.join(',')})" if v && !v.join.empty?
+    def get_class_marking_columns(class_id)
+      results = @connector.get("grade/classes/#{class_id}/marking_columns")
+      results["class_marking_columns"].each{|column| column["ea7_class_id"] = class_id}
+      create_blackbaud_objects(Blackbaud::MarkingColumn, results["class_marking_columns"])
+    end
+
+    def get_grades(class_id, marking_column_id)
+      results = @connector.get("grade/classes/#{class_id}/marking_columns/#{marking_column_id}/grades")
+      create_blackbaud_objects(Blackbaud::Grade, results["grades"])
+    end
+
+    def get_faweb_grades(class_id, marking_column_id)
+      results = @connector.get("faweb_grade/classes/#{class_id}/marking_columns/#{marking_column_id}/grades")
+      create_blackbaud_objects(Blackbaud::Grade, results["faweb_grades"])
+    end
+
+    def get_translation_tables(id=nil)
+      results = @connector.get("grade/translation_tables/#{id}")
+      create_blackbaud_objects(Blackbaud::TranslationTable, results["translation_tables"])
+    end
+
+    def post_grades(grades)
+      results = @connector.post('/grade/class', format_grades(grades))
+      create_blackbaud_objects(Blackbaud::Grade, results["grades"])
+    end
+
+    # These are for backwards compatibilty with version <=0.1.4.  Remove them before v 1.0.
+    alias_method :academic_years, :get_academic_years
+    alias_method :contact_types, :get_contact_types
+    alias_method :relationships, :get_relationships
+    alias_method :person, :get_person
+    alias_method :people, :get_people
+    alias_method :classes, :get_classes
+    alias_method :class, :get_class
+    alias_method :code_tables, :get_code_tables
+    alias_method :code_table_entries, :get_code_table_entries
+    alias_method :static_code_tables, :get_static_code_tables
+    alias_method :attendance_codes, :get_attendance_codes
+    alias_method :attendance_by_class, :get_attendance_by_class
+    alias_method :attendance_by_day, :get_attendance_by_day
+    alias_method :class_marking_columns, :get_class_marking_columns
+    alias_method :grades, :get_grades
+    alias_method :faweb_grades, :get_faweb_grades
+    alias_method :translation_tables, :get_translation_tables
+
+    private
+
+    def create_blackbaud_objects(klass, results)
+      results = [results] if results.class == Hash
+      ret = results.collect do |result|
+        klass.new({values: result, client: self})
       end
+      ret || []
+    end
+
+    def create_blackbaud_object(klass, result)
+      klass.new({values: result, client: self})
+    end
 
-      url << "&filter=#{filters.join}"
+    def format_grades(grades)
+      grades = [grades] unless grades.is_a?(Array)
+      JSON.generate({
+        grades: grades
+      })
+    end
 
-      url
+    def format_date(date)
+      return unless date
+      date = DateTime.parse(date) if date.is_a?(String)
+      date.strftime("%F")
     end
 
   end
-end
+end

data/spec/client_spec.rb

@@ -0,0 +1,84 @@
+require 'spec_helper'
+
+def stub_requests
+  stub_request(:any, /www.example.com/).
+    to_return(lambda do |request|  
+        response_path = request.uri.path.split('/').select{|p| p[/[a-zA-Z_]+/]}.join("/") 
+        body = File.read("spec/response_data/#{request.method}/#{response_path}.json")
+        response = {
+          :status => 200, 
+          :body => body,
+          :headers => {
+            "Content-Length" => body.size,
+            "Content-Type" => "application/json; charset=utf-8",
+            "Date" => DateTime.now.rfc2822,
+            "Server" => "Microsoft-HTTPAPI/2.0"
+          }
+        }
+      end
+    )
+  end
+
+describe Blackbaud::Client do
+
+  before :all do
+    stub_requests
+
+    options = {
+        :database_key => "database_key",
+        :database_number => 1,
+        :vendor_id => 'vendor_id',
+        :vendor_key => 'vendor_key',
+        :url => "https://www.example.com"
+    }
+    @client = Blackbaud::Client.new(options)
+  end
+
+  before :each do
+    stub_requests
+  end
+
+  describe "#initalize" do
+    context "given auth params" do
+      it "gets an auth token" do
+        expect(@client.connector.token).to eq 'abcdefgh-1234-zyxw-9876-ijklmnopqrst_1'
+      end
+    end
+  end
+
+  describe "#get_class_marking_columns" do
+    context "initialized and given an ea7_class_id" do
+      it "gets marking_column data" do
+        r = @client.get_class_marking_columns(7)
+        expect(r.size).to eq 6
+      end
+    end
+  end
+
+  describe "#post_grades" do
+    context "given an ea7_class_id" do
+      it "posts an updated grade" do
+        marking_column = @client.get_class_marking_columns(7).first
+        grade = marking_column.grades.first
+        grade.grade = '100'
+        grade.ea7_translation_table_entry_id = nil
+        r = grade.post
+        expect(r.size).to eq 1
+      end
+    end
+  end
+  
+  describe "#format_grades" do
+    context "given a set of grades" do
+      it "formats a json object to match the blackbaud spec" do
+        marking_column = @client.get_class_marking_columns(7).first
+        grades = marking_column.grades
+        result = @client.send(:format_grades, grades)
+        expect(JSON.parse(result)['grades'].size).to eq 3
+        expect(JSON.parse(result)['grades'].first.keys.size).to eq 5
+      end
+    end
+  end
+  
+
+end

data/spec/response_data/get/grade/classes/marking_columns/grades.json

@@ -0,0 +1,29 @@
+{
+  "grades": [
+    {
+      "ea7_student_grade_id": 1654,
+      "ea7_marking_column_id": 55,
+      "ea7_student_course_id": 143325,
+      "ea7_translation_table_entry_id": 22,
+      "grade": "A",
+      "grade_type": 1,
+      "ea7_record_id": 75,
+      "name_for_display": "Samantha Rae Andrews",
+      "message": "(explanation of fields: a grade exists so all fields filled in)"
+    },
+    {
+      "ea7_student_course_id": 143329,
+      "ea7_record_id": 403,
+      "name_for_display": "Lisa Green",
+      "message": "(explanation of fields: no grade exists so minimum fields filled in)"
+    },
+    {
+      "ea7_student_grade_id": 1659,
+      "ea7_marking_column_id": 55,
+      "ea7_student_course_id": 143330,
+      "ea7_record_id": 204,
+      "name_for_display": "Colvin Bryant",
+      "message": "(explanation of fields: no grade exists but a comment does (not available thru api) so some fields filled in)"
+    }
+  ]
+}

data/spec/response_data/get/grade/classes/marking_columns.json

@@ -0,0 +1,52 @@
+{
+  "class_marking_columns": [
+    {
+      "ea7_course_grading_info_grade_id": 43,
+      "description": "Quarter 1",
+      "ea7_marking_column_id": 51,
+      "ea7_translation_table_id": 2,
+      "short_description": "QT1",
+      "values_allowed": 2
+    },
+    {
+      "ea7_course_grading_info_grade_id": 44,
+      "description": "Quarter 2",
+      "ea7_marking_column_id": 52,
+      "ea7_translation_table_id": 2,
+      "short_description": "QT2",
+      "values_allowed": 2
+    },
+    {
+      "ea7_course_grading_info_grade_id": 45,
+      "description": "Quarter 3",
+      "ea7_marking_column_id": 53,
+      "ea7_translation_table_id": 2,
+      "short_description": "QT3",
+      "values_allowed": 2
+    },
+    {
+      "ea7_course_grading_info_grade_id": 46,
+      "description": "Quarter 4",
+      "ea7_marking_column_id": 54,
+      "ea7_translation_table_id": 2,
+      "short_description": "QT4",
+      "values_allowed": 2
+    },
+    {
+      "ea7_course_grading_info_grade_id": 47,
+      "description": "Semester 1",
+      "ea7_marking_column_id": 55,
+      "ea7_translation_table_id": 1,
+      "short_description": "Sem1",
+      "values_allowed": 1
+    },
+    {
+      "ea7_course_grading_info_grade_id": 48,
+      "description": "Semester 2",
+      "ea7_marking_column_id": 56,
+      "ea7_translation_table_id": 1,
+      "short_description": "Sem2",
+      "values_allowed": 1
+    }
+  ]
+}

data/spec/response_data/post/grade/class.json

@@ -0,0 +1,15 @@
+{
+  "grades": [
+    {
+      "ea7_student_grade_id": 1654,
+      "ea7_marking_column_id": 55,
+      "ea7_student_course_id": 143325,
+      "ea7_translation_table_entry_id": 22,
+      "grade": "A",
+      "grade_type": 1,
+      "ea7_record_id": 75,
+      "name_for_display": "Samantha Rae Andrews",
+      "message": "(explanation of fields: a grade exists so all fields filled in)"
+    }
+  ]
+}

data/spec/response_data/post/security/access_token.json

@@ -0,0 +1,7 @@
+{
+  "database_key": "34E0B2B6FB91",
+  "database_number": 1572,
+  "token": "abcdefgh-1234-zyxw-9876-ijklmnopqrst_1",
+  "user_id": 46,
+  "vendor_id": "uFO69lS9TkyIOPqGyFVEVg"
+}

data/spec/spec_helper.rb

@@ -0,0 +1,11 @@
+require 'bundler/setup'
+Bundler.setup
+
+require 'blackbaud-client'
+require 'webmock/rspec'
+require 'pry'
+
+WebMock.disable_net_connect!(allow_localhost: true)
+
+RSpec.configure do |config|
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: blackbaud-client
 version: !ruby/object:Gem::Version
-  version: 0.1.4
+  version: 0.2.0
 platform: ruby
 authors:
 - Alex Dugger
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-07-15 00:00:00.000000000 Z
+date: 2015-10-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: ruby-hmac
@@ -38,20 +38,62 @@ dependencies:
     - - ~>
       - !ruby/object:Gem::Version
         version: '1.6'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.3'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.21'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.21'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '0.9'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.9'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '0.10'
 description: A client for the Blackbaud API.
 email: alexd@haikulearning.com
 executables: []
@@ -59,6 +101,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - .gitignore
+- .travis.yml
 - CHANGELOG.md
 - Gemfile
 - LICENSE.txt
@@ -67,18 +110,32 @@ files:
 - blackbaud-client.gemspec
 - lib/blackbaud-client.rb
 - lib/blackbaud-client/api/academic_year.rb
+- lib/blackbaud-client/api/attendance_by_class_record.rb
+- lib/blackbaud-client/api/attendance_by_day_record.rb
+- lib/blackbaud-client/api/attendance_code.rb
+- lib/blackbaud-client/api/attendance_record.rb
+- lib/blackbaud-client/api/blackbaud_class.rb
 - lib/blackbaud-client/api/blackbaud_object.rb
-- lib/blackbaud-client/api/class.rb
 - lib/blackbaud-client/api/code_table.rb
 - lib/blackbaud-client/api/code_table_entry.rb
 - lib/blackbaud-client/api/contact.rb
+- lib/blackbaud-client/api/grade.rb
+- lib/blackbaud-client/api/marking_column.rb
 - lib/blackbaud-client/api/person.rb
 - lib/blackbaud-client/api/relation.rb
 - lib/blackbaud-client/api/session.rb
 - lib/blackbaud-client/api/static_code_table.rb
-- lib/blackbaud-client/api/table_entry.rb
 - lib/blackbaud-client/api/term.rb
+- lib/blackbaud-client/api/translation_table.rb
+- lib/blackbaud-client/api/translation_table_entry.rb
+- lib/blackbaud-client/connector.rb
 - lib/blackbaud-client/version.rb
+- spec/client_spec.rb
+- spec/response_data/get/grade/classes/marking_columns.json
+- spec/response_data/get/grade/classes/marking_columns/grades.json
+- spec/response_data/post/grade/class.json
+- spec/response_data/post/security/access_token.json
+- spec/spec_helper.rb
 homepage: https://github.com/haikulearning/blackbaud-api-client
 licenses: []
 metadata: {}
@@ -88,17 +145,17 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.0.14
+rubygems_version: 2.4.3
 signing_key: 
 specification_version: 4
 summary: A client for the Blackbaud API.

data/lib/blackbaud-client/api/class.rb

@@ -1,12 +0,0 @@
-module Blackbaud
-  class Class < BlackbaudObject
-    attr_accessor(:ea7_class_id, :course_id, :course_name, :section, :ea7_term_id, :ea7_term_name, :faculty, :students)
-
-    def initialize(values)
-      values["faculty"].map! {|s| Blackbaud::Person.new(s, 1)} if values["faculty"]
-      values["students"].map! {|s| Blackbaud::Person.new(s, 2)} if values["students"]
-      super(values)
-    end
-
-  end
-end

data/lib/blackbaud-client/api/table_entry.rb

@@ -1,5 +0,0 @@
-module Blackbaud
-  class TableEntry < BlackbaudObject
-    attr_accessor(:id, :name)
-  end
-end