blackbaud-client 0.0.5 → 0.1.0

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    OWI4MTAwMjg4NGU0Yjk2NjZlNGYzNDJjYWJiNjFjYTc1NDg3ZjVjZg==
+    ZDYxY2VhMGY4M2MzNWI4NGQ1NGYxYTg2YzVlNDg2ZjhiNzUwZWVhMQ==
   data.tar.gz: !binary |-
-    OTI2ZTQwNzg4MTY0YTIzYjk5ODA2MjMwYjFlOWI4NGU2MzNhNzU4MA==
+    MThhYWYxNTJjNmMzZmZjYjNlOTk4ZGM3YThlNjI1MjI5ZTM3MTFmNQ==
 SHA512:
   metadata.gz: !binary |-
-    MzU2YWIzZGE1YTA3NjhjMTAwNjM2YWNlZDA3MzY5M2QzOTRiMjQxN2EyMjE0
-    NjY3NTZiYTEyZjZjNzNmZGQyNmU3MmU4MzJlZTY3MTk5NjYyYjI4ZjU4ZjNl
-    ZWEwMTRjYjg5Njg2N2JkNDlkYzQ3NzkwMzgxZThlOTBlNzExNWM=
+    NjdmZGIwNTM1MTA1MzY0NjBhNTVkZDRiYWVhODNhMjM3ZWE1NzdjM2Y4OTlh
+    Y2Q5ZGYyMjA4NzNiZjI4YmQ0YWUyZjJmNmRlM2VkM2Y3YTgzYWNhNTVlNDBm
+    MTlkYzUyMjUxY2NmOWQ5ZDM2MTY4Y2I2YjQxZTdmYjFjN2QyNjM=
   data.tar.gz: !binary |-
-    NTdjNGMxZWVlYzAwZDg0NTNkZmZjYWQ1ZTcyODcxN2E0NGU2ZmU1YzIzNDQw
-    OTNjOWEwYTdiZWM0MmQ0NWQ2ZTYyMGRiOGUzODIzMGZkNmU3MzIzYjM4NWJl
-    ZDVjYTBkZmYwNTZmNTg5ZmQ0Y2MyYjRjNWU4YzY0YzRhMDIwNGQ=
+    NWZlMWZjNWFjZWYxNjVkZjRhY2JlYTBkOGZmY2M4ZTBjMTM1NTJmNDA5ZGUz
+    MjhiMjQ0OWRmYTI2NDVlMmQ2NmFlNGU0YTQ4NGYzZmUzOGIwNmFhODRhNTY5
+    Njc4ZjdiM2I3NzY4MzVlYTBjYzUyMGQxN2M3YWM2NGNlNWIzYjA=

data/.gitignore

@@ -3,4 +3,5 @@
 example.rb
 test/
 .ruby-version
-.ruby-gemset
+.ruby-gemset
+Gemfile.lock

data/Gemfile

@@ -0,0 +1,5 @@
+source "https://rubygems.org"
+
+gemspec
+
+

data/blackbaud-client.gemspec

@@ -2,9 +2,11 @@
 lib = File.expand_path('../lib/', __FILE__)
 $:.unshift lib unless $:.include?(lib)
 
+require 'blackbaud-client/version'
+
 Gem::Specification.new do |gem|
   gem.name          = "blackbaud-client"
-  gem.version       = "0.0.5"
+  gem.version       = Blackbaud::Client::Version.to_s
   gem.authors       = "Alex Dugger"
   gem.email         = "alexd@haikulearning.com"
   gem.description   = "A client for the Blackbaud API."
@@ -12,7 +14,7 @@ Gem::Specification.new do |gem|
   gem.summary       = "A client for the Blackbaud API."
   gem.files         = `git ls-files`.split($/)
   gem.require_path  = 'lib'
-  gem.add_runtime_dependency     'ruby-hmac'
-  gem.add_runtime_dependency     'rest-client'
 
+  gem.add_runtime_dependency  'ruby-hmac',    '~>0.4'
+  gem.add_runtime_dependency  'rest-client',  '~>1.6'
 end

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

@@ -3,7 +3,6 @@ module Blackbaud
     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"]
 
       ["start_date", "end_date"].each do |date|
@@ -11,9 +10,7 @@ module Blackbaud
         values.delete("#{date}")
       end
 
-      values.each do |k,v|
-        send("#{k}=".intern, v)
-      end
+      super(values)
 
       def connection_string
         "academic_years/#{self.ea7_academic_year_id}"
@@ -22,7 +19,6 @@ module Blackbaud
       def terms
         self.sessions.inject([]) {|r, s| r + s.terms}
       end
-
     end
 
   end

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

@@ -1,6 +1,14 @@
 module Blackbaud
   class BlackbaudObject
 
+    def initialize(values)
+      values.each do |k,v|
+        if respond_to?("#{k}=".intern)
+          send("#{k}=".intern, v)
+        end
+      end
+    end
+
     def format_date(d)
       DateTime.parse(d)
     end

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

@@ -3,13 +3,9 @@ module Blackbaud
     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"]
-
-      values.each do |k,v|
-        send("#{k}=".intern, v)
-      end
+      super(values)
     end
 
   end

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

@@ -1,13 +1,5 @@
 module Blackbaud
   class CodeTable < BlackbaudObject
     attr_accessor(:_links, :id, :name, :links)
-
-    def initialize(values)
-
-      values.each do |k,v|
-        send("#{k}=".intern, v)
-      end
-    end
-
   end
 end

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

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

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

@@ -1,12 +1,5 @@
 module Blackbaud
   class Contact < BlackbaudObject
     attr_accessor(:type_id, :type_value, :value)
-
-    def initialize(values)
-      values.each do |k,v|
-        send("#{k}=".intern, v)
-      end
-    end
-
   end
 end

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

@@ -1,9 +1,14 @@
 module Blackbaud
   class Person < BlackbaudObject
-    attr_accessor(:ea7_record_id, :name_for_display, :type, :birth_date, :first_name, :import_id, :last_name, :record_type, :title, :suffix, :middle_name, :user_defined_id, :nickname, :contacts)
+    attr_accessor(:ea7_record_id, :name_for_display, :type, :birth_date, :first_name, :import_id, :last_name, :record_type, :title, :suffix, :middle_name, :user_defined_id, :nickname, :contacts, :relations, :online_user_id)
 
-    def initialize(values, type_id)
+    USER_TYPE = {
+     :faculty => 1,
+     :student => 2,
+     :undefined => nil,
+    }
 
+    def initialize(values, type_id)
       values["type"] = type_id
 
       if values["bio"]
@@ -12,15 +17,33 @@ module Blackbaud
       end
 
       if values["contact_info"]
-        values["contacts"] = values["contact_info"].map! {|c| Blackbaud::Contact.new(c)}
+        values["contacts"] = values["contact_info"].map {|c| Blackbaud::Contact.new(c)}
         values.delete("contact_info")
+      else
+        values["contacts"] = []
+      end
+
+      if values["relations"]
+        values["relations"].map! {|r| Blackbaud::Relation.new(r)}
+      else
+        values["relations"] = []
       end
 
       values["birth_date"] = format_date(values["birth_date"]) if values["birth_date"]
 
-      values.each do |k,v|
-        send("#{k}=".intern, v)
-      end
+      super(values)
+    end
+
+    def faculty?
+      type == USER_TYPE[:faculty]
+    end
+
+    def student?
+      type == USER_TYPE[:student]
+    end
+
+    def undefined_type?
+      type == USER_TYPE[:undefined]
     end
 
   end

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

@@ -0,0 +1,16 @@
+module Blackbaud
+  class Relation < BlackbaudObject
+    attr_accessor(:relationship_code_id, :relationship_code_value, :reciprocal_code_id, :reciprocal_code_value, :person)
+
+    def initialize(values)
+      if values["person"]
+        values["person"] = Blackbaud::Person.new(values["person"], Blackbaud::Person::USER_TYPE[:undefined])
+      end
+
+      values.each do |k,v|
+        send("#{k}=".intern, v)
+      end
+    end
+
+  end
+end

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

@@ -3,13 +3,8 @@ module Blackbaud
     attr_accessor(:name, :ea7_session_id, :terms, :links)
 
     def initialize(values)
-
       values["terms"].map! {|t| Blackbaud::Term.new(t)} if values["terms"]
-
-      values.each do |k,v|
-        send("#{k}=".intern, v)
-      end
-
+      super(values)
     end
 
   end

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

@@ -1,13 +1,5 @@
 module Blackbaud
   class StaticCodeTable < BlackbaudObject
     attr_accessor(:id, :name, :links)
-
-    def initialize(values)
-
-      values.each do |k,v|
-        send("#{k}=".intern, v)
-      end
-    end
-
   end
 end

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

@@ -1,13 +1,5 @@
 module Blackbaud
   class TableEntry < BlackbaudObject
     attr_accessor(:id, :name)
-
-    def initialize(values)
-
-      values.each do |k,v|
-        send("#{k}=".intern, v)
-      end
-    end
-
   end
 end

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

@@ -2,14 +2,6 @@ module Blackbaud
   class Term < BlackbaudObject
     attr_accessor(:ea7_term_id, :name, :links)
 
-    def initialize(values)
-
-      values.each do |k,v|
-        send("#{k}=".intern, v)
-      end
-
-    end
-
     def connection_string
       "terms/#{self.ea7_term_id}"
     end

data/lib/blackbaud-client/version.rb

@@ -0,0 +1,20 @@
+module Blackbaud
+  class Client
+    class Version
+      MAJOR = 0
+      MINOR = 1
+      PATCH = 0
+      STRING = "#{MAJOR}.#{MINOR}.#{PATCH}"
+
+      class << self
+        # A String representing the current version of the OEmbed gem.
+        def inspect
+          STRING
+        end
+        alias_method :to_s, :inspect
+      end
+    end
+
+    VERSION = Version::STRING
+  end
+end

data/lib/blackbaud-client.rb

@@ -1,14 +1,16 @@
+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/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/contact_type.rb'
-require 'blackbaud-client/api/contact.rb'
+require 'blackbaud-client/api/code_table_entry.rb'
 require 'hmac-sha1'
 require 'cgi'
 require 'base64'
@@ -19,11 +21,6 @@ require 'date'
 module Blackbaud
   class Client
 
-    USER_TYPE = {
-     :faculty => 1,
-     :student => 2
-    }
-
     def initialize(options)
       auth_params = {
         :database_key => options[:database_key],
@@ -36,14 +33,10 @@ module Blackbaud
 
     end
 
-    def construct_url(web_services_url, endpoint, filters=nil)
-      @url = "#{web_services_url}/#{endpoint}?token=#{@token}"
-      @url << "&filter=(#{filters})" if filters
-    end
-
     def connect(endpoint, filters=nil)
-      construct_url(@web_services_url, endpoint, filters)
-      JSON.parse(RestClient::Request.execute(:method=>'get', :url=>@url))
+      url = construct_url(@web_services_url, endpoint, filters)
+      #puts url.inspect
+      JSON.parse(RestClient::Request.execute(:method=>'get', :url=>url))
     end
 
     def academic_years(id)
@@ -53,17 +46,40 @@ module Blackbaud
 
     def contact_types
       results = connect("global/code_tables/phone%20type")
-      results["table_entries"].collect {|ct| Blackbaud::ContactType.new(ct)}
+      results["table_entries"].collect {|entry| Blackbaud::CodeTableEntry.new(entry)}
+    end
+
+    def relationships
+      results = connect("global/code_tables/relationship")
+      results["table_entries"].collect {|entry| Blackbaud::CodeTableEntry.new(entry)}
     end
 
-    def people(scope, contact_types=nil)
-      filter = contact_types.is_a?(Array) ? "contact.type_id%20eq%20#{contact_types.join(',')}" : nil
-      results = connect("person/#{scope.connection_string}/people", filter )
-      r = [:faculty, :students].collect do |t|
-        p = results["people"].first[t.to_s]
-        (p.nil? ? [] : p.collect {|person| Blackbaud::Person.new(person, (USER_TYPE[t]))})
+    # Return an Array of Person records
+    #
+    # 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={})
+      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 = []
+
+      {
+        '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)
+        end
       end
-      r.flatten(1)
+
+      r
     end
 
     def classes(scope)
@@ -85,5 +101,20 @@ module Blackbaud
       results = connect("global/static_code_tables/#{id}")
       results["table_entries"].collect {|c| Blackbaud::TableEntry.new(c)}
     end
+
+    private
+
+    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?
+      end
+
+      url << "&filter=#{filters.join}"
+
+      url
+    end
+
   end
 end

metadata

@@ -1,43 +1,43 @@
 --- !ruby/object:Gem::Specification
 name: blackbaud-client
 version: !ruby/object:Gem::Version
-  version: 0.0.5
+  version: 0.1.0
 platform: ruby
 authors:
 - Alex Dugger
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-04-15 00:00:00.000000000 Z
+date: 2014-06-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: ruby-hmac
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '0.4'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '0.4'
 - !ruby/object:Gem::Dependency
   name: rest-client
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.6'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.6'
 description: A client for the Blackbaud API.
 email: alexd@haikulearning.com
 executables: []
@@ -45,6 +45,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - .gitignore
+- Gemfile
 - LICENSE.txt
 - README.md
 - blackbaud-client.gemspec
@@ -53,13 +54,15 @@ files:
 - 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/contact_type.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/version.rb
 homepage: https://github.com/haikulearning/blackbaud-api-client
 licenses: []
 metadata: {}

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

@@ -1,12 +0,0 @@
-module Blackbaud
-  class ContactType < BlackbaudObject
-    attr_accessor(:id, :name)
-
-    def initialize(values)
-      values.each do |k,v|
-        send("#{k}=".intern, v)
-      end
-    end
-
-  end
-end