blackbaud-client 0.0.2

checksums.yaml

@@ -0,0 +1,15 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    OTZjZmQyMzcyNTcxMWIwNTNhMjY2YzhlYzhmYTE3ZmVlZGZhZjZmYw==
+  data.tar.gz: !binary |-
+    YzliMDlhM2Q1ZGIyOWUxNmU2NDk4NTE1MGZmZWViZTJhZGY0NjdkYg==
+SHA512:
+  metadata.gz: !binary |-
+    NDAwMDk2MTkzZWI2YzE1YjVmMzQ1NDAwZGEyMjdlMmYyODgxMzdkMDBjMDc0
+    MDBkZGIzYzM2MzNkOGM2YzU4ZDZjZDAzNzhlMDI2NTkwNDEwYjhmNmJjYmE2
+    Mzc4ODBjMDI4M2YxNDk1ZDM1YjJhZWE5YjNhMWE0ZTJkYmVhYjQ=
+  data.tar.gz: !binary |-
+    NzY4NDI1NTAwNzFiNGYxMzQ2MmEyYmM5YmE1YjRiMGRkNGU3ZWNhMjE4YTAz
+    NWQwYmY5YmExY2Y3NDU2MTZkNjEyNzRhMWVjZDc2ZjNiOWUyZWZjNWNjOWM1
+    NDI2MzE1MDg0NDU5MDg5YjZkODE5NWZkMWNmZGQ4ODBjMWU0ZmQ=

data/.gitignore

@@ -0,0 +1,6 @@
+.idea
+.DS_Store
+example.rb
+test/
+.ruby-version
+.ruby-gemset

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2013 Alex Dugger, Haiku Learning Systems
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,17 @@
+# Clever::Ruby
+
+Ruby bindings to the Blackbaud API.
+
+## Usage
+
+Create a Blackbaud API Client
+
+    options = {
+      :password => "pass",
+      :key => "abcde",
+      :username => "user",
+      :database => "1"
+      :url => "https://blackbaud.api.url.example/key/"
+    }
+
+    @client = Blackbaud::Client.new(options)

data/blackbaud-client.gemspec

@@ -0,0 +1,15 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib/', __FILE__)
+$:.unshift lib unless $:.include?(lib)
+
+Gem::Specification.new do |gem|
+  gem.name          = "blackbaud-client"
+  gem.version       = "0.0.2"
+  gem.authors       = "Alex Dugger"
+  gem.email         = "alexd@haikulearning.com"
+  gem.description   = "A client for the Blackbaud API."
+  gem.homepage      = "https://github.com/haikulearning/blackbaud-api-client"
+  gem.summary       = "A client for the Blackbaud API."
+  gem.files         = `git ls-files`.split($/)
+  gem.require_path  = 'lib'
+end

data/lib/blackbaud-client.rb

@@ -0,0 +1,71 @@
+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/session.rb'
+require 'blackbaud-client/api/static_code_table.rb'
+require 'blackbaud-client/api/table_entry.rb'
+require 'blackbaud-client/api/term.rb'
+require 'hmac-sha1'
+require 'cgi'
+require 'base64'
+require 'json'
+require 'rest-client'
+require 'date'
+
+module Blackbaud
+  class Client
+
+    def initialize(options)
+      auth_params = {
+        :password => options[:password],
+        :key => options[:key],
+        :user_name => options[:username],
+        :database_number => options[:database]
+      }.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"]
+
+    end
+
+    def construct_url(web_services_url, endpoint)
+      @url = "#{web_services_url}#{endpoint}?token=#{@token}"
+    end
+
+    def connect(endpoint)
+      construct_url(@web_services_url, endpoint)
+      JSON.parse(RestClient::Request.execute(:method=>'get', :url=>@url))
+    end
+
+    def academic_years(id)
+      results = connect("schedule/#{id}/academic_years")
+      results["academic_years"].collect {|year| Blackbaud::AcademicYear.new(year)}
+    end
+
+    def people(year)
+      results = connect("person/academic_years/#{year.ea7_academic_year_id}/people")
+      results["people"].first["faculty"].collect {|person| Blackbaud::Person.new(person, 1)} + results["people"].first["students"].collect {|person| Blackbaud::Person.new(person, 2)}
+    end
+
+    def classes(year)
+      results = connect("schedule/academic_years/#{year.ea7_academic_year_id}/classes")
+      results["classes"].collect {|c| Blackbaud::Class.new(c)}
+    end
+
+    def code_tables
+      results = connect("global/code_tables")
+      results["code_tables"].collect {|table| Blackbaud::CodeTable.new(table)}
+    end
+
+    def code_table_entries(code_table)
+      results = connect("global/code_tables/#{code_table.id}")
+      results["table_entries"].collect {|entry| Blackbaud::TableEntry.new(entry)}
+    end
+
+    def static_code_tables(id)
+      results = connect("global/static_code_tables/#{id}")
+      results["table_entries"].collect {|c| Blackbaud::TableEntry.new(c)}
+    end
+  end
+end

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

@@ -0,0 +1,21 @@
+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"]
+
+      ["start_date", "end_date"].each do |date|
+        send("#{date}=".intern, format_date(values["#{date}"]))
+        values.delete("#{date}")
+      end
+
+      values.each do |k,v|
+        send("#{k}=".intern, v)
+      end
+
+    end
+
+  end
+end

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

@@ -0,0 +1,9 @@
+module Blackbaud
+  class BlackbaudObject
+
+    def format_date(d)
+      DateTime.parse(d)
+    end
+
+  end
+end

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

@@ -0,0 +1,16 @@
+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"]
+
+      values.each do |k,v|
+        send("#{k}=".intern, v)
+      end
+    end
+
+  end
+end

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

@@ -0,0 +1,13 @@
+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/person.rb

@@ -0,0 +1,22 @@
+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)
+
+    def initialize(values, type_id)
+
+      values["type"] = type_id
+
+      if values["bio"]
+        values["bio"].each {|k, v| values[k] = v}
+        values.delete("bio")
+      end
+
+      values["birth_date"] = format_date(values["birth_date"]) if values["birth_date"]
+
+      values.each do |k,v|
+        send("#{k}=".intern, v)
+      end
+    end
+
+  end
+end

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

@@ -0,0 +1,16 @@
+module Blackbaud
+  class Session < BlackbaudObject
+    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
+
+    end
+
+  end
+end

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

@@ -0,0 +1,13 @@
+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

@@ -0,0 +1,13 @@
+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

@@ -0,0 +1,14 @@
+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
+
+  end
+end

metadata

@@ -0,0 +1,56 @@
+--- !ruby/object:Gem::Specification
+name: blackbaud-client
+version: !ruby/object:Gem::Version
+  version: 0.0.2
+platform: ruby
+authors:
+- Alex Dugger
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-01-16 00:00:00.000000000 Z
+dependencies: []
+description: A client for the Blackbaud API.
+email: alexd@haikulearning.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- LICENSE.txt
+- README.md
+- blackbaud-client.gemspec
+- lib/blackbaud-client.rb
+- lib/blackbaud-client/api/academic_year.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/person.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
+homepage: https://github.com/haikulearning/blackbaud-api-client
+licenses: []
+metadata: {}
+post_install_message: 
+rdoc_options: []
+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.2.1
+signing_key: 
+specification_version: 4
+summary: A client for the Blackbaud API.
+test_files: []