ties 0.2.1

data/Gemfile

@@ -0,0 +1,8 @@
+source :rubygems
+
+gem "json"
+group :test do
+  gem 'rspec'
+  gem "rspec-core"
+  gem "autotest"
+end

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (C) 2011 Naiku Inc.
+
+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

@@ -0,0 +1,3 @@
+This ruby gem is for accessing the TIEScloud API.
+
+

data/lib/ties/base.rb

@@ -0,0 +1,86 @@
+
+class TIES::Base
+  attr_accessor :api_key, :secret_key, :endpoint, :district_number
+  attr_accessor :total_pages, :total_count
+
+  # options should contain
+  #   :api_key
+  #   :secret_key
+  #   :district_number
+  def initialize(options)
+    self.api_key, self.secret_key = options["api_key"], options["secret_key"]
+    self.district_number = options["district_number"]
+    self.endpoint = options["endpoint"] || TIES::ENDPOINT
+  end
+
+  def each(options = {})
+    page = 1
+    begin
+      self.get(page, options).each do |element|
+        yield(element)
+      end
+      page += 1
+    end until self.total_pages.nil? || self.total_pages <= page
+  end
+
+  def all(options = {})
+    @results = []
+    page = 1
+    begin
+      @results.concat self.get(page, options)
+      page += 1
+    end until self.total_pages.nil? || self.total_pages <= page
+    @results
+  end
+
+  def send_request(uri, options = {})
+    if self.api_key.nil? || self.secret_key.nil? || self.district_number.nil?
+      raise 'not enough data to send request'
+    end
+    result = request_over_http(options, endpoint, uri)
+    if !result
+      raise 'Request to TIES api "%s" failed' % uri
+    end
+    case result.code.to_i
+    when 400
+      return false
+    when 200
+      return JSON.parse(result.body)
+    else
+      raise 'unknown error status code %s for uri "%s"' % [result.code, uri]
+    end
+  end
+
+  def authentication(http_method, time, request_uri)
+    data = [http_method, time, request_uri].join('\n')
+    'TIES ' + [api_key, Base64.encode64(OpenSSL::HMAC.digest('sha1', self.secret_key, data))].join(':')
+  end
+
+  def schools(); @schools ||= TIES::Schools.new(self); end
+  def students(); @students ||= TIES::Students.new(self); end
+  def teachers(); @teachers ||= TIES::Teachers.new(self); end
+  def classes(); @classes ||= TIES::Schedule::Classes.new(self); end
+  def requested_classes(); @requested_classes ||= TIES::Schedule::RequestedClasses.new(self); end
+  def reimbursements(); @reimbursements ||= TIES::MyView::Reimbursements.new(self); end
+
+  protected
+
+  # For easier testing. You can mock this method with a XML file you're expecting to receive
+  def request_over_http(options, endpoint, uri)
+    uri = URI.parse([endpoint, uri].join('/') + '?' + options.collect{|k,v| "%s=%s" % [k,v]}.join('&'))
+
+    http = Net::HTTP.new(uri.host, 443)
+    http.use_ssl = true
+#    http.set_debug_output $stderr
+    request = Net::HTTP::Get.new(uri.request_uri)
+    request.initialize_http_header({
+      'Accept' => 'application/json',
+      'Content-Type' => 'application/json',
+      'User-Agent' => 'TIEScloud ruby %s' % TIES::VERSION,
+      'ties-date' => (time = Time.now).utc.to_s,
+      'Authorization' => authentication('GET', time, uri.request_uri),
+      'DistrictNumber' => self.district_number.to_s
+    })
+    http.request(request)
+  end
+end

data/lib/ties/my_view.rb

@@ -0,0 +1,10 @@
+class TIES::MyView
+  class Reimbursements < TIES::Base
+    def initialize(ties)
+      @ties = ties
+    end
+    def get(page = 1, options = {})
+      @ties.send_request('MyView/Reimbursements/Page=%i' % page, options)
+    end
+  end
+end

data/lib/ties/schedule.rb

@@ -0,0 +1,28 @@
+class TIES::Schedule 
+  class Classes < TIES::Base
+    def initialize(ties)
+      @ties = ties
+    end
+    def get(page = 1, options = {})
+      result = @ties.send_request('Schedule/Classes/%i' % page, options)
+      return [] unless result
+      self.total_pages = result['TotalPages']
+      self.total_count = result['TotalCount']
+      return result['Return']
+    end
+  end
+  class RequestedClasses < TIES::Base
+    def initialize(ties)
+      @ties = ties
+    end
+    def get(page = 1, options = {})
+      raise 'Missing student id' if options["StudentId"].nil?
+      options.merge!({'IsScheduled' => 'true'})
+      result = @ties.send_request('Schedule/RequestedClasses/%i' % page, options)
+      return [] unless result
+      self.total_pages = result['TotalPages']
+      self.total_count = result['TotalCount']
+      return result['Return']
+    end
+  end
+end

data/lib/ties/schools.rb

@@ -0,0 +1,13 @@
+class TIES::Schools < TIES::Base
+  def initialize(ties)
+    @ties = ties
+  end
+  def get(page = 1, options = {})
+    options.merge!({"DistrictNumber" => @ties.district_number})
+    result = @ties.send_request('Schools/%i' % page, options)
+    return [] unless result
+    self.total_pages = result['TotalPages']
+    self.total_count = result['TotalCount']
+    return result['Return']
+  end
+end

data/lib/ties/students.rb

@@ -0,0 +1,13 @@
+class TIES::Students < TIES::Base
+  attr_accessor :total_pages, :total_count
+  def initialize(ties)
+    @ties = ties
+  end
+  def get(page = 1, options = {})
+    result = @ties.send_request('Students/%i' % page, options)
+    return [] unless result
+    self.total_pages = result['TotalPages']
+    self.total_count = result['TotalCount']
+    return result['Return']
+  end
+end

data/lib/ties/teachers.rb

@@ -0,0 +1,13 @@
+class TIES::Teachers < TIES::Base
+  attr_accessor :total_pages, :total_count
+  def initialize(ties)
+    @ties = ties
+  end
+  def get(page = 1, options = {})
+    result = @ties.send_request('Staff/Teachers/%i' % page, options)
+    return [] unless result
+    self.total_pages = result['TotalPages']
+    self.total_count = result['TotalCount']
+    return result['Return']
+  end
+end

data/lib/ties.rb

@@ -0,0 +1,21 @@
+require 'net/https'
+require 'openssl'
+require 'base64'
+require 'cgi'
+require 'uri'
+require 'json'
+
+module TIES
+  ENDPOINT = 'https://api.tiescloud.net/v1.0'
+  VERSION = '0.2'
+  def self.new(*options)
+    TIES::Base.new(*options)
+  end
+end
+
+require 'ties/base'
+require 'ties/schools'
+require 'ties/students'
+require 'ties/teachers'
+require 'ties/schedule'
+require 'ties/my_view'

data/spec/spec_helper.rb

@@ -0,0 +1,15 @@
+require 'rubygems'
+gem 'rspec'
+ 
+$:.unshift(File.dirname(__FILE__) + '/../lib')
+require 'ties'
+
+module TiesHelper
+  def ties
+    TIES.new("api_key" => "4a29d0e61cd0", "secret_key" => "4a29d0e61cd047d78f233ea99f62a3b3", "endpoint" => 'https://apitest.tiescloud.net/v1.0', "district_number" => '8999')
+  end
+end
+
+RSpec.configure do |c|
+  c.include TiesHelper
+end

data/spec/ties/base_spec.rb

@@ -0,0 +1,12 @@
+require File.dirname(__FILE__) + '/../spec_helper'
+
+describe TIES::Base do
+  describe ".new" do
+    it "should initialize" do
+      ties.should be_a(TIES::Base)
+    end
+    it "should have default endpoint" do
+      TIES.new({}).endpoint.should == TIES::ENDPOINT
+    end
+  end
+end

data/spec/ties/my_view_spec.rb

@@ -0,0 +1,10 @@
+require File.dirname(__FILE__) + '/../spec_helper'
+
+describe TIES::MyView::Reimbursements do
+  it "should be reimbursements object" do
+    ties.reimbursements.should be_a(TIES::MyView::Reimbursements)
+  end
+  it "retrieve reimbursements" do
+    ties.reimbursements.get
+  end
+end

data/spec/ties/schedule_spec.rb

@@ -0,0 +1,28 @@
+require File.dirname(__FILE__) + '/../spec_helper'
+
+describe TIES::Schedule::Classes do
+  it "should be classes object" do
+    ties.classes.should be_a(TIES::Schedule::Classes)
+  end
+  it "should retrieve classes" do
+    classes = ties.classes
+    result = classes.get(1, {SchoolYear: "2010", StudentId: "2010"})
+    result.should_not be_empty
+    result.should be_a(Array)
+    classes.total_pages.should_not be_nil
+    classes.total_count.should_not be_nil
+  end
+end
+describe TIES::Schedule::RequestedClasses do
+  it "should be a RequestedClasses object" do
+    ties.requested_classes.should be_a(TIES::Schedule::RequestedClasses)
+  end
+  it "should require StudentId" do
+    ties.requested_classes.get(1, 'SchoolYear' => '2010')
+  end
+  it "retrieve requested classes" do
+    classes = ties.requested_classes.get(1, 'StudentId' => '698090', 'SchoolYear' => '2010')
+    classes.should be_a(Array)
+    classes.should_not be_empty
+  end
+end

data/spec/ties/schools_spec.rb

@@ -0,0 +1,16 @@
+require File.dirname(__FILE__) + '/../spec_helper'
+
+describe TIES::Schools do
+
+  it "should be schools object" do
+    ties.schools.should be_a(TIES::Schools)
+  end
+  it "should retrieve schools" do
+    schools = ties.schools
+    result = schools.get()
+    result.should_not be_empty
+    result.should be_a(Array)
+    schools.total_pages.should_not be_nil
+    schools.total_count.should_not be_nil
+  end
+end

data/spec/ties/students_spec.rb

@@ -0,0 +1,15 @@
+require File.dirname(__FILE__) + '/../spec_helper'
+
+describe TIES::Students do
+  it "should be students object" do
+    ties.students.should be_a(TIES::Students)
+  end
+  it "should retrieve students" do
+    students = ties.students
+    result = students.get(1, "SchoolId" => "0121", "SchoolYear" => "2010")
+    result.should_not be_empty
+    result.should be_a(Array)
+    students.total_pages.should_not be_nil
+    students.total_count.should_not be_nil
+  end
+end

data/spec/ties/ties_spec.rb

@@ -0,0 +1,7 @@
+require File.dirname(__FILE__) + '/../spec_helper'
+
+describe TIES do
+  it "should have default endpoint" do
+    TIES::ENDPOINT.should == 'https://api.tiescloud.net/v1.0'
+  end
+end

data/ties.gemspec

@@ -0,0 +1,34 @@
+Gem::Specification.new do |s|
+  s.name = "ties"
+  s.version = "0.2.1"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Thomas R. Koll"]
+  s.date = "2011-09-26"
+  s.description = "Provides a ruby interface to the TIEScloud API"
+  s.summary = "Provides a ruby interface to the TIEScloud API"
+  s.email = "info@ananasblau.com"
+  s.extra_rdoc_files = [
+    "README"
+  ]
+  s.files = [
+    "Gemfile",
+    "LICENSE",
+    "README",
+    "lib/ties.rb",
+    "lib/ties/base.rb",
+    "lib/ties/schedule.rb",
+    "lib/ties/my_view.rb",
+    "lib/ties/schools.rb",
+    "lib/ties/students.rb",
+    "lib/ties/teachers.rb",
+    "spec/spec_helper.rb",
+    "spec/ties/base_spec.rb",
+    "spec/ties/schedule_spec.rb",
+    "spec/ties/my_view_spec.rb",
+    "spec/ties/schools_spec.rb",
+    "spec/ties/students_spec.rb",
+    "spec/ties/ties_spec.rb",
+    "ties.gemspec"
+    ]
+end

metadata

@@ -0,0 +1,73 @@
+--- !ruby/object:Gem::Specification 
+name: ties
+version: !ruby/object:Gem::Version 
+  prerelease: 
+  version: 0.2.1
+platform: ruby
+authors: 
+- Thomas R. Koll
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-09-26 00:00:00 +02:00
+default_executable: 
+dependencies: []
+
+description: Provides a ruby interface to the TIEScloud API
+email: info@ananasblau.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README
+files: 
+- Gemfile
+- LICENSE
+- README
+- lib/ties.rb
+- lib/ties/base.rb
+- lib/ties/schedule.rb
+- lib/ties/my_view.rb
+- lib/ties/schools.rb
+- lib/ties/students.rb
+- lib/ties/teachers.rb
+- spec/spec_helper.rb
+- spec/ties/base_spec.rb
+- spec/ties/schedule_spec.rb
+- spec/ties/my_view_spec.rb
+- spec/ties/schools_spec.rb
+- spec/ties/students_spec.rb
+- spec/ties/ties_spec.rb
+- ties.gemspec
+has_rdoc: true
+homepage: 
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.6.1
+signing_key: 
+specification_version: 3
+summary: Provides a ruby interface to the TIEScloud API
+test_files: []
+