Module: Assembly

Defined in:
lib/assembly/util.rb,
lib/assembly/model.rb,
lib/assembly/client.rb,
lib/assembly/config.rb,
lib/assembly_client.rb,
lib/assembly/version.rb,
lib/assembly/resource.rb,
lib/assembly/api_model.rb,
lib/assembly/models/list.rb,
lib/assembly/actions/list.rb,
lib/assembly/actions/read.rb,
lib/assembly/models/facet.rb,
lib/assembly/models/grade.rb,
lib/assembly/models/aspect.rb,
lib/assembly/models/result.rb,
lib/assembly/actions/create.rb,
lib/assembly/actions/delete.rb,
lib/assembly/actions/update.rb,
lib/assembly/models/contact.rb,
lib/assembly/models/student.rb,
lib/assembly/models/subject.rb,
lib/assembly/models/exclusion.rb,
lib/assembly/models/grade_set.rb,
lib/assembly/models/assessment.rb,
lib/assembly/models/attendance.rb,
lib/assembly/models/year_group.rb,
lib/assembly/models/staff_member.rb,
lib/assembly/models/academic_year.rb,
lib/assembly/models/school_detail.rb,
lib/assembly/models/calendar_event.rb,
lib/assembly/models/teaching_group.rb,
lib/assembly/models/assessment_point.rb,
lib/assembly/models/registration_group.rb

Defined Under Namespace

Modules: Actions, Util Classes: AcademicYear, ApiModel, Aspect, Assessment, AssessmentPoint, Attendance, CalendarEvent, Client, Config, Contact, Exclusion, Facet, Grade, GradeSet, List, Model, NotFoundError, RegistrationGroup, Resource, Result, SchoolDetail, ServerError, StaffMember, Student, Subject, TeachingGroup, TooManyRequestsError, UnauthorizedError, ValidationError, YearGroup

Constant Summary collapse

VERSION = 
"0.9.0"

Class Attribute Summary collapse

Class Method Summary collapse

Class Attribute Details

.config ⇒ Object

Returns the value of attribute config.



46
47
48
 
# File 'lib/assembly_client.rb', line 46

def config
  @config
end

Class Method Details

.client(options = nil) ⇒ Object

nil - standard client Config object - new client with config Hash - new client with config extended by hash



56
57
58
59
60
61
62
 
# File 'lib/assembly_client.rb', line 56

def client(options=nil)
  @client ||= Client.new
  return @client if options.nil?
  return options if options.is_a?(Client)
  client_config = options.is_a?(Config) ? options : @config.copy_with_overrides(options)
  Client.new(client_config)
end

.configure(options = nil) {|config| ... } ⇒ Object

Yields:



48
49
50
51
 
# File 'lib/assembly_client.rb', line 48

def configure(options=nil)
  @config.merge(options) if options.is_a?(Hash)
  yield(config) if block_given?
end